blob: 90714727cde2d714643b2ac11d246bf41ec74627 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk218ca722008-03-26 10:40:12 +01002# (C) Copyright 2000 - 2008
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
wdenk7152b1d2003-09-05 23:19:14 +0000141- board Board dependent files
142- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000143- cpu CPU specific files
wdenk983fda82004-10-28 00:09:35 +0000144 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000145 - arm720t Files specific to ARM 720 CPUs
146 - arm920t Files specific to ARM 920 CPUs
wdenka85f9f22005-04-06 13:52:31 +0000147 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk983fda82004-10-28 00:09:35 +0000148 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenk1d9f4102004-10-09 22:21:29 +0000149 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000150 - arm925t Files specific to ARM 925 CPUs
151 - arm926ejs Files specific to ARM 926 CPUs
wdenk8ed96042005-01-09 23:16:25 +0000152 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk72a087e2006-10-24 14:27:35 +0200153 - at32ap Files specific to Atmel AVR32 AP CPUs
Mike Frysingeradbfeeb2008-08-07 17:50:26 -0400154 - blackfin Files specific to Analog Devices Blackfin CPUs
wdenk11dadd52004-02-27 00:07:27 +0000155 - i386 Files specific to i386 CPUs
156 - ixp Files specific to Intel XScale IXP CPUs
Daniel Hellstromb3309902008-03-28 10:00:33 +0100157 - leon2 Files specific to Gaisler LEON2 SPARC CPU
Daniel Hellstrom1e9a1642008-03-26 22:51:29 +0100158 - leon3 Files specific to Gaisler LEON3 SPARC CPU
wdenk983fda82004-10-28 00:09:35 +0000159 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
TsiChungLiew1552af72008-01-14 17:43:33 -0600160 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
TsiChung Liew8e585f02007-06-18 13:50:13 -0500161 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
TsiChungLiew8ae158c2007-08-16 15:05:11 -0500162 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
TsiChungLiew57a12722008-01-15 14:15:46 -0600163 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
wdenk11dadd52004-02-27 00:07:27 +0000164 - mips Files specific to MIPS CPUs
wdenk983fda82004-10-28 00:09:35 +0000165 - mpc5xx Files specific to Freescale MPC5xx CPUs
166 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
167 - mpc8xx Files specific to Freescale MPC8xx CPUs
168 - mpc8220 Files specific to Freescale MPC8220 CPUs
169 - mpc824x Files specific to Freescale MPC824x CPUs
170 - mpc8260 Files specific to Freescale MPC8260 CPUs
171 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000172 - nios Files specific to Altera NIOS CPUs
wdenk5c952cf2004-10-10 21:27:30 +0000173 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200174 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000175 - pxa Files specific to Intel XScale PXA CPUs
176 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
177 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000178- disk Code for disk drive partition handling
179- doc Documentation (don't expect too much)
wdenk7152b1d2003-09-05 23:19:14 +0000180- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000181- dtt Digital Thermometer and Thermostat drivers
182- examples Example code for standalone applications, etc.
183- include Header Files
wdenk11dadd52004-02-27 00:07:27 +0000184- lib_arm Files generic to ARM architecture
Wolfgang Denk7b64fef2006-10-24 14:21:16 +0200185- lib_avr32 Files generic to AVR32 architecture
Mike Frysingeradbfeeb2008-08-07 17:50:26 -0400186- lib_blackfin Files generic to Blackfin architecture
wdenk11dadd52004-02-27 00:07:27 +0000187- lib_generic Files generic to all architectures
188- lib_i386 Files generic to i386 architecture
189- lib_m68k Files generic to m68k architecture
190- lib_mips Files generic to MIPS architecture
191- lib_nios Files generic to NIOS architecture
192- lib_ppc Files generic to PowerPC architecture
Daniel Hellstromc2f02da2008-03-28 09:47:00 +0100193- lib_sparc Files generic to SPARC architecture
Wolfgang Denk218ca722008-03-26 10:40:12 +0100194- libfdt Library files to support flattened device trees
wdenkc6097192002-11-03 00:24:07 +0000195- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000196- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000197- rtc Real Time Clock drivers
198- tools Tools to build S-Record or U-Boot images, etc.
199
wdenkc6097192002-11-03 00:24:07 +0000200Software Configuration:
201=======================
202
203Configuration is usually done using C preprocessor defines; the
204rationale behind that is to avoid dead code whenever possible.
205
206There are two classes of configuration variables:
207
208* Configuration _OPTIONS_:
209 These are selectable by the user and have names beginning with
210 "CONFIG_".
211
212* Configuration _SETTINGS_:
213 These depend on the hardware etc. and should not be meddled with if
214 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200215 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000216
217Later we will add a configuration tool - probably similar to or even
218identical to what's used for the Linux kernel. Right now, we have to
219do the configuration by hand, which means creating some symbolic
220links and editing some configuration files. We use the TQM8xxL boards
221as an example here.
222
223
224Selection of Processor Architecture and Board Type:
225---------------------------------------------------
226
227For all supported boards there are ready-to-use default
228configurations available; just type "make <board_name>_config".
229
230Example: For a TQM823L module type:
231
232 cd u-boot
233 make TQM823L_config
234
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200235For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000236e.g. "make cogent_mpc8xx_config". And also configure the cogent
237directory according to the instructions in cogent/README.
238
239
240Configuration Options:
241----------------------
242
243Configuration depends on the combination of board and CPU type; all
244such information is kept in a configuration file
245"include/configs/<board_name>.h".
246
247Example: For a TQM823L module, all configuration settings are in
248"include/configs/TQM823L.h".
249
250
wdenk7f6c2cb2002-11-10 22:06:23 +0000251Many of the options are named exactly as the corresponding Linux
252kernel configuration options. The intention is to make it easier to
253build a config tool - later.
254
255
wdenkc6097192002-11-03 00:24:07 +0000256The following options need to be configured:
257
Kim Phillips26281142007-08-10 13:28:25 -0500258- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000259
Kim Phillips26281142007-08-10 13:28:25 -0500260- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200261
262- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100263 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000264
265- CPU Module Type: (if CONFIG_COGENT is defined)
266 Define exactly one of
267 CONFIG_CMA286_60_OLD
268--- FIXME --- not tested yet:
269 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
270 CONFIG_CMA287_23, CONFIG_CMA287_50
271
272- Motherboard Type: (if CONFIG_COGENT is defined)
273 Define exactly one of
274 CONFIG_CMA101, CONFIG_CMA102
275
276- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
277 Define one or more of
278 CONFIG_CMA302
279
280- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
281 Define one or more of
282 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200283 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000284 a "rotator" |\-/|\-/
285
wdenk2535d602003-07-17 23:16:40 +0000286- Board flavour: (if CONFIG_MPC8260ADS is defined)
287 CONFIG_ADSTYPE
288 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200289 CONFIG_SYS_8260ADS - original MPC8260ADS
290 CONFIG_SYS_8266ADS - MPC8266ADS
291 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
292 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000293
wdenkc6097192002-11-03 00:24:07 +0000294- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000295 Define exactly one of
296 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000297
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200298- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000299 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
300 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000301 e.g. if there is no 32KHz
302 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000303 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
304 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000305
wdenk66ca92a2004-09-28 17:59:53 +0000306- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200307 CONFIG_SYS_8xx_CPUCLK_MIN
308 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000309 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000310 See doc/README.MPC866
311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200312 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000313
wdenkba56f622004-02-06 23:19:44 +0000314 Define this to measure the actual CPU clock instead
315 of relying on the correctness of the configured
316 values. Mostly useful for board bringup to make sure
317 the PLL is locked at the intended frequency. Note
318 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200319 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000320
Heiko Schocher506f3912009-03-12 07:37:15 +0100321 CONFIG_SYS_DELAYED_ICACHE
322
323 Define this option if you want to enable the
324 ICache only when Code runs from RAM.
325
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100326- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200327 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100328
329 Defines the Monahans run mode to oscillator
330 ratio. Valid values are 8, 16, 24, 31. The core
331 frequency is this value multiplied by 13 MHz.
332
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200333 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200334
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100335 Defines the Monahans turbo mode to oscillator
336 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200337 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100338 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200339
wdenk5da627a2003-10-09 20:09:04 +0000340- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000341 CONFIG_CLOCKS_IN_MHZ
342
343 U-Boot stores all clock information in Hz
344 internally. For binary compatibility with older Linux
345 kernels (which expect the clocks passed in the
346 bd_info data to be in MHz) the environment variable
347 "clocks_in_mhz" can be defined so that U-Boot
348 converts clock data to MHZ before passing it to the
349 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000350 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100351 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000352 default environment.
353
wdenk5da627a2003-10-09 20:09:04 +0000354 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
355
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200356 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000357 expect it to be in bytes, others in MB.
358 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
359
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400360 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200361
362 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400363 passed using flattened device trees (based on open firmware
364 concepts).
365
366 CONFIG_OF_LIBFDT
367 * New libfdt-based support
368 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500369 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400370
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200371 OF_CPU - The proper name of the cpus node.
Kumar Galac2871f02006-01-11 13:59:02 -0600372 OF_SOC - The proper name of the soc node.
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200373 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600374 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200375
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200376 boards with QUICC Engines require OF_QE to set UCC MAC
377 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500378
Kumar Gala4e253132006-01-11 13:54:17 -0600379 CONFIG_OF_BOARD_SETUP
380
381 Board code has addition modification that it wants to make
382 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000383
Matthew McClintock02677682006-06-28 10:41:37 -0500384 CONFIG_OF_BOOT_CPU
385
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200386 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500387 param header, the default value is zero if undefined.
388
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100389- vxWorks boot parameters:
390
391 bootvx constructs a valid bootline using the following
392 environments variables: bootfile, ipaddr, serverip, hostname.
393 It loads the vxWorks image pointed bootfile.
394
395 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
396 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
397 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
398 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
399
400 CONFIG_SYS_VXWORKS_ADD_PARAMS
401
402 Add it at the end of the bootline. E.g "u=username pw=secret"
403
404 Note: If a "bootargs" environment is defined, it will overwride
405 the defaults discussed just above.
406
wdenk6705d812004-08-02 23:22:59 +0000407- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200408 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000409
410 Define this if you want support for Amba PrimeCell PL010 UARTs.
411
Andreas Engel48d01922008-09-08 14:30:53 +0200412 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000413
414 Define this if you want support for Amba PrimeCell PL011 UARTs.
415
416 CONFIG_PL011_CLOCK
417
418 If you have Amba PrimeCell PL011 UARTs, set this variable to
419 the clock speed of the UARTs.
420
421 CONFIG_PL01x_PORTS
422
423 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
424 define this to a list of base addresses for each (supported)
425 port. See e.g. include/configs/versatile.h
426
427
wdenkc6097192002-11-03 00:24:07 +0000428- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000429 Depending on board, define exactly one serial port
430 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
431 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
432 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000433
434 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
435 port routines must be defined elsewhere
436 (i.e. serial_init(), serial_getc(), ...)
437
438 CONFIG_CFB_CONSOLE
439 Enables console device for a color framebuffer. Needs following
440 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
441 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
442 (default big endian)
443 VIDEO_HW_RECTFILL graphic chip supports
444 rectangle fill
445 (cf. smiLynxEM)
446 VIDEO_HW_BITBLT graphic chip supports
447 bit-blit (cf. smiLynxEM)
448 VIDEO_VISIBLE_COLS visible pixel columns
449 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000450 VIDEO_VISIBLE_ROWS visible pixel rows
451 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000452 VIDEO_DATA_FORMAT graphic data format
453 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000454 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000455 VIDEO_KBD_INIT_FCT keyboard int fct
456 (i.e. i8042_kbd_init())
457 VIDEO_TSTC_FCT test char fct
458 (i.e. i8042_tstc)
459 VIDEO_GETC_FCT get char fct
460 (i.e. i8042_getc)
461 CONFIG_CONSOLE_CURSOR cursor drawing on/off
462 (requires blink timer
463 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200464 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000465 CONFIG_CONSOLE_TIME display time/date info in
466 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500467 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000468 CONFIG_VIDEO_LOGO display Linux logo in
469 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000470 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
471 linux_logo.h for logo.
472 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000473 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200474 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000475 the logo
476
wdenk43d96162003-03-06 00:02:04 +0000477 When CONFIG_CFB_CONSOLE is defined, video console is
478 default i/o. Serial console can be forced with
479 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000480
wdenkd4ca31c2004-01-02 14:00:00 +0000481 When CONFIG_SILENT_CONSOLE is defined, all console
482 messages (by U-Boot and Linux!) can be silenced with
483 the "silent" environment variable. See
484 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000485
wdenkc6097192002-11-03 00:24:07 +0000486- Console Baudrate:
487 CONFIG_BAUDRATE - in bps
488 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200489 CONFIG_SYS_BAUDRATE_TABLE, see below.
490 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000491
Heiko Schocherc92fac92009-01-30 12:55:38 +0100492- Console Rx buffer length
493 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
494 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100495 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100496 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
497 must be defined, to setup the maximum idle timeout for
498 the SMC.
499
wdenkc6097192002-11-03 00:24:07 +0000500- Interrupt driven serial port input:
501 CONFIG_SERIAL_SOFTWARE_FIFO
502
503 PPC405GP only.
504 Use an interrupt handler for receiving data on the
505 serial port. It also enables using hardware handshake
506 (RTS/CTS) and UART's built-in FIFO. Set the number of
507 bytes the interrupt driven input buffer should have.
508
wdenk109c0e32004-03-23 21:43:07 +0000509 Leave undefined to disable this feature, including
510 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000511
stroese1d49b1f2003-05-23 11:39:05 +0000512- Console UART Number:
513 CONFIG_UART1_CONSOLE
514
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200515 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000516 If defined internal UART1 (and not UART0) is used
517 as default U-Boot console.
518
wdenkc6097192002-11-03 00:24:07 +0000519- Boot Delay: CONFIG_BOOTDELAY - in seconds
520 Delay before automatically booting the default image;
521 set to -1 to disable autoboot.
522
523 See doc/README.autoboot for these options that
524 work with CONFIG_BOOTDELAY. None are required.
525 CONFIG_BOOT_RETRY_TIME
526 CONFIG_BOOT_RETRY_MIN
527 CONFIG_AUTOBOOT_KEYED
528 CONFIG_AUTOBOOT_PROMPT
529 CONFIG_AUTOBOOT_DELAY_STR
530 CONFIG_AUTOBOOT_STOP_STR
531 CONFIG_AUTOBOOT_DELAY_STR2
532 CONFIG_AUTOBOOT_STOP_STR2
533 CONFIG_ZERO_BOOTDELAY_CHECK
534 CONFIG_RESET_TO_RETRY
535
536- Autoboot Command:
537 CONFIG_BOOTCOMMAND
538 Only needed when CONFIG_BOOTDELAY is enabled;
539 define a command string that is automatically executed
540 when no character is read on the console interface
541 within "Boot Delay" after reset.
542
543 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000544 This can be used to pass arguments to the bootm
545 command. The value of CONFIG_BOOTARGS goes into the
546 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000547
548 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000549 The value of these goes into the environment as
550 "ramboot" and "nfsboot" respectively, and can be used
551 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200552 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000553
554- Pre-Boot Commands:
555 CONFIG_PREBOOT
556
557 When this option is #defined, the existence of the
558 environment variable "preboot" will be checked
559 immediately before starting the CONFIG_BOOTDELAY
560 countdown and/or running the auto-boot command resp.
561 entering interactive mode.
562
563 This feature is especially useful when "preboot" is
564 automatically generated or modified. For an example
565 see the LWMON board specific code: here "preboot" is
566 modified when the user holds down a certain
567 combination of keys on the (special) keyboard when
568 booting the systems
569
570- Serial Download Echo Mode:
571 CONFIG_LOADS_ECHO
572 If defined to 1, all characters received during a
573 serial download (using the "loads" command) are
574 echoed back. This might be needed by some terminal
575 emulations (like "cu"), but may as well just take
576 time on others. This setting #define's the initial
577 value of the "loads_echo" environment variable.
578
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500579- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000580 CONFIG_KGDB_BAUDRATE
581 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200582 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000583
584- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500585 Monitor commands can be included or excluded
586 from the build by using the #include files
587 "config_cmd_all.h" and #undef'ing unwanted
588 commands, or using "config_cmd_default.h"
589 and augmenting with additional #define's
590 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000591
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500592 The default command configuration includes all commands
593 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000594
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500595 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500596 CONFIG_CMD_BDI bdinfo
597 CONFIG_CMD_BEDBUG * Include BedBug Debugger
598 CONFIG_CMD_BMP * BMP support
599 CONFIG_CMD_BSP * Board specific commands
600 CONFIG_CMD_BOOTD bootd
601 CONFIG_CMD_CACHE * icache, dcache
602 CONFIG_CMD_CONSOLE coninfo
603 CONFIG_CMD_DATE * support for RTC, date/time...
604 CONFIG_CMD_DHCP * DHCP support
605 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600606 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
607 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
608 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
609 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500610 CONFIG_CMD_DTT * Digital Therm and Thermostat
611 CONFIG_CMD_ECHO echo arguments
612 CONFIG_CMD_EEPROM * EEPROM read/write support
613 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500614 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500615 CONFIG_CMD_FDC * Floppy Disk Support
616 CONFIG_CMD_FAT * FAT partition support
617 CONFIG_CMD_FDOS * Dos diskette Support
618 CONFIG_CMD_FLASH flinfo, erase, protect
619 CONFIG_CMD_FPGA FPGA device initialization support
620 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
621 CONFIG_CMD_I2C * I2C serial bus support
622 CONFIG_CMD_IDE * IDE harddisk support
623 CONFIG_CMD_IMI iminfo
624 CONFIG_CMD_IMLS List all found images
625 CONFIG_CMD_IMMAP * IMMR dump support
626 CONFIG_CMD_IRQ * irqinfo
627 CONFIG_CMD_ITEST Integer/string test of 2 values
628 CONFIG_CMD_JFFS2 * JFFS2 Support
629 CONFIG_CMD_KGDB * kgdb
630 CONFIG_CMD_LOADB loadb
631 CONFIG_CMD_LOADS loads
632 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
633 loop, loopw, mtest
634 CONFIG_CMD_MISC Misc functions like sleep etc
635 CONFIG_CMD_MMC * MMC memory mapped support
636 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100637 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500638 CONFIG_CMD_NAND * NAND support
639 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600640 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
641 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500642 CONFIG_CMD_PCI * pciinfo
643 CONFIG_CMD_PCMCIA * PCMCIA support
644 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
645 host
646 CONFIG_CMD_PORTIO * Port I/O
647 CONFIG_CMD_REGINFO * Register dump
648 CONFIG_CMD_RUN run command in env variable
649 CONFIG_CMD_SAVES * save S record dump
650 CONFIG_CMD_SCSI * SCSI Support
651 CONFIG_CMD_SDRAM * print SDRAM configuration information
652 (requires CONFIG_CMD_I2C)
653 CONFIG_CMD_SETGETDCR Support for DCR Register access
654 (4xx only)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200655 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500656 CONFIG_CMD_SPI * SPI serial bus support
657 CONFIG_CMD_USB * USB support
658 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500659 CONFIG_CMD_CDP * Cisco Discover Protocol support
660 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000661
wdenkc6097192002-11-03 00:24:07 +0000662
663 EXAMPLE: If you want all functions except of network
664 support you can write:
665
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500666 #include "config_cmd_all.h"
667 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000668
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400669 Other Commands:
670 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000671
672 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500673 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000674 what you (and your U-Boot users) are doing. Data
675 cache cannot be enabled on systems like the 8xx or
676 8260 (where accesses to the IMMR region must be
677 uncached), and it cannot be disabled on all other
678 systems where we (mis-) use the data cache to hold an
679 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000680
681
682 XXX - this list needs to get updated!
683
684- Watchdog:
685 CONFIG_WATCHDOG
686 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000687 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000688 code for a watchdog. For the 8xx and 8260 CPUs, the
689 SIU Watchdog feature is enabled in the SYPCR
690 register.
691
stroesec1551ea2003-04-04 15:53:41 +0000692- U-Boot Version:
693 CONFIG_VERSION_VARIABLE
694 If this variable is defined, an environment variable
695 named "ver" is created by U-Boot showing the U-Boot
696 version as printed by the "version" command.
697 This variable is readonly.
698
wdenkc6097192002-11-03 00:24:07 +0000699- Real-Time Clock:
700
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500701 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000702 has to be selected, too. Define exactly one of the
703 following options:
704
705 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
706 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200707 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000708 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000709 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000710 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000711 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000712 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100713 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000714 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200715 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000716
wdenkb37c7e52003-06-30 16:24:52 +0000717 Note that if the RTC uses I2C, then the I2C interface
718 must also be configured. See I2C Support, below.
719
Peter Tysere92739d2008-12-17 16:36:21 -0600720- GPIO Support:
721 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
722 CONFIG_PCA953X_INFO - enable pca953x info command
723
724 Note that if the GPIO device uses I2C, then the I2C interface
725 must also be configured. See I2C Support, below.
726
wdenkc6097192002-11-03 00:24:07 +0000727- Timestamp Support:
728
wdenk43d96162003-03-06 00:02:04 +0000729 When CONFIG_TIMESTAMP is selected, the timestamp
730 (date and time) of an image is printed by image
731 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500732 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000733
734- Partition Support:
735 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400736 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000737
Wolfgang Denk218ca722008-03-26 10:40:12 +0100738 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
739 CONFIG_CMD_SCSI) you must configure support for at
740 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000741
742- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000743 CONFIG_IDE_RESET_ROUTINE - this is defined in several
744 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000745
wdenk4d13cba2004-03-14 14:09:05 +0000746 CONFIG_IDE_RESET - is this is defined, IDE Reset will
747 be performed by calling the function
748 ide_set_reset(int reset)
749 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000750
751- ATAPI Support:
752 CONFIG_ATAPI
753
754 Set this to enable ATAPI support.
755
wdenkc40b2952004-03-13 23:29:43 +0000756- LBA48 Support
757 CONFIG_LBA48
758
759 Set this to enable support for disks larger than 137GB
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200760 Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
wdenkc40b2952004-03-13 23:29:43 +0000761 Whithout these , LBA48 support uses 32bit variables and will 'only'
762 support disks up to 2.1TB.
763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200764 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000765 When enabled, makes the IDE subsystem use 64bit sector addresses.
766 Default is 32bit.
767
wdenkc6097192002-11-03 00:24:07 +0000768- SCSI Support:
769 At the moment only there is only support for the
770 SYM53C8XX SCSI controller; define
771 CONFIG_SCSI_SYM53C8XX to enable it.
772
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200773 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
774 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
775 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000776 maximum numbers of LUNs, SCSI ID's and target
777 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200778 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000779
780- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000781 CONFIG_E1000
782 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000783
Andre Schwarzac3315c2008-03-06 16:45:44 +0100784 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200785 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100786
wdenkc6097192002-11-03 00:24:07 +0000787 CONFIG_EEPRO100
788 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200789 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000790 write routine for first time initialisation.
791
792 CONFIG_TULIP
793 Support for Digital 2114x chips.
794 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
795 modem chip initialisation (KS8761/QS6611).
796
797 CONFIG_NATSEMI
798 Support for National dp83815 chips.
799
800 CONFIG_NS8382X
801 Support for National dp8382[01] gigabit chips.
802
wdenk45219c42003-05-12 21:50:16 +0000803- NETWORK Support (other):
804
805 CONFIG_DRIVER_LAN91C96
806 Support for SMSC's LAN91C96 chips.
807
808 CONFIG_LAN91C96_BASE
809 Define this to hold the physical address
810 of the LAN91C96's I/O space
811
812 CONFIG_LAN91C96_USE_32_BIT
813 Define this to enable 32 bit addressing
814
wdenkf39748a2004-06-09 13:37:52 +0000815 CONFIG_DRIVER_SMC91111
816 Support for SMSC's LAN91C111 chip
817
818 CONFIG_SMC91111_BASE
819 Define this to hold the physical address
820 of the device (I/O space)
821
822 CONFIG_SMC_USE_32_BIT
823 Define this if data bus is 32 bits
824
825 CONFIG_SMC_USE_IOFUNCS
826 Define this to use i/o functions instead of macros
827 (some hardware wont work with macros)
828
Jens Gehrlein557b3772008-05-05 14:06:11 +0200829 CONFIG_DRIVER_SMC911X
830 Support for SMSC's LAN911x and LAN921x chips
831
832 CONFIG_DRIVER_SMC911X_BASE
833 Define this to hold the physical address
834 of the device (I/O space)
835
836 CONFIG_DRIVER_SMC911X_32_BIT
837 Define this if data bus is 32 bits
838
839 CONFIG_DRIVER_SMC911X_16_BIT
840 Define this if data bus is 16 bits. If your processor
841 automatically converts one 32 bit word to two 16 bit
842 words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
843
wdenkc6097192002-11-03 00:24:07 +0000844- USB Support:
845 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000846 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000847 CONFIG_USB_UHCI to enable it.
848 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000849 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000850 storage devices.
851 Note:
852 Supported are USB Keyboards and USB Floppy drives
853 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000854 MPC5200 USB requires additional defines:
855 CONFIG_USB_CLOCK
856 for 528 MHz Clock: 0x0001bbbb
857 CONFIG_USB_CONFIG
858 for differential drivers: 0x00001000
859 for single ended drivers: 0x00005000
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200860 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200861 May be defined to allow interrupt polling
862 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000863
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200864- USB Device:
865 Define the below if you wish to use the USB console.
866 Once firmware is rebuilt from a serial console issue the
867 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200868 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200869 it has found a new device. The environment variable usbtty
870 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200871 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200872 Common Device Class Abstract Control Model serial device.
873 If you select usbtty = gserial you should be able to enumerate
874 a Linux host by
875 # modprobe usbserial vendor=0xVendorID product=0xProductID
876 else if using cdc_acm, simply setting the environment
877 variable usbtty to be cdc_acm should suffice. The following
878 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200879
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200880 CONFIG_USB_DEVICE
881 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000882
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200883 CONFIG_USB_TTY
884 Define this to have a tty type of device available to
885 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200886
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200887 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200888 Define this if you want stdin, stdout &/or stderr to
889 be set to usbtty.
890
891 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200892 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200893 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200894 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200896 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200897 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200898 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200899
Wolfgang Denk386eda02006-06-14 18:14:56 +0200900 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200901 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200902 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200903 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
904 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
905 should pretend to be a Linux device to it's target host.
906
907 CONFIG_USBD_MANUFACTURER
908 Define this string as the name of your company for
909 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200910
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200911 CONFIG_USBD_PRODUCT_NAME
912 Define this string as the name of your product
913 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
914
915 CONFIG_USBD_VENDORID
916 Define this as your assigned Vendor ID from the USB
917 Implementors Forum. This *must* be a genuine Vendor ID
918 to avoid polluting the USB namespace.
919 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200920
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200921 CONFIG_USBD_PRODUCTID
922 Define this as the unique Product ID
923 for your device
924 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000925
926
927- MMC Support:
928 The MMC controller on the Intel PXA is supported. To
929 enable this define CONFIG_MMC. The MMC can be
930 accessed from the boot prompt by mapping the device
931 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500932 enabled with CONFIG_CMD_MMC. The MMC driver also works with
933 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000934
wdenk6705d812004-08-02 23:22:59 +0000935- Journaling Flash filesystem support:
936 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
937 CONFIG_JFFS2_NAND_DEV
938 Define these for a default partition on a NAND device
939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200940 CONFIG_SYS_JFFS2_FIRST_SECTOR,
941 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +0000942 Define these for a default partition on a NOR device
943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200944 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +0000945 Define this to create an own partition. You have to provide a
946 function struct part_info* jffs2_part_info(int part_num)
947
948 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200949 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +0000950 to disable the command chpart. This is the default when you
951 have not defined a custom partition
952
wdenkc6097192002-11-03 00:24:07 +0000953- Keyboard Support:
954 CONFIG_ISA_KEYBOARD
955
956 Define this to enable standard (PC-Style) keyboard
957 support
958
959 CONFIG_I8042_KBD
960 Standard PC keyboard driver with US (is default) and
961 GERMAN key layout (switch via environment 'keymap=de') support.
962 Export function i8042_kbd_init, i8042_tstc and i8042_getc
963 for cfb_console. Supports cursor blinking.
964
965- Video support:
966 CONFIG_VIDEO
967
968 Define this to enable video support (for output to
969 video).
970
971 CONFIG_VIDEO_CT69000
972
973 Enable Chips & Technologies 69000 Video chip
974
975 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000976 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000977 video output is selected via environment 'videoout'
978 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
979 assumed.
wdenkc6097192002-11-03 00:24:07 +0000980
wdenkb79a11c2004-03-25 15:14:43 +0000981 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200982 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +0000983 are possible:
984 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000985 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000986
987 Colors 640x480 800x600 1024x768 1152x864 1280x1024
988 -------------+---------------------------------------------
989 8 bits | 0x301* 0x303 0x305 0x161 0x307
990 15 bits | 0x310 0x313 0x316 0x162 0x319
991 16 bits | 0x311 0x314 0x317 0x163 0x31A
992 24 bits | 0x312 0x315 0x318 ? 0x31B
993 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000994 (i.e. setenv videomode 317; saveenv; reset;)
995
wdenkb79a11c2004-03-25 15:14:43 +0000996 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +0100997 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +0000998
999
stroesec1551ea2003-04-04 15:53:41 +00001000 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001001 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001002 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1003 or CONFIG_VIDEO_SED13806_16BPP
1004
wdenk682011f2003-06-03 23:54:09 +00001005- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001006 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001007
wdenk8bde7f72003-06-27 21:31:46 +00001008 Define this to enable a custom keyboard support.
1009 This simply calls drv_keyboard_init() which must be
1010 defined in your board-specific files.
1011 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001012
wdenkc6097192002-11-03 00:24:07 +00001013- LCD Support: CONFIG_LCD
1014
1015 Define this to enable LCD support (for output to LCD
1016 display); also select one of the supported displays
1017 by defining one of these:
1018
Stelian Pop39cf4802008-05-09 21:57:18 +02001019 CONFIG_ATMEL_LCD:
1020
1021 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1022
wdenkfd3103b2003-11-25 16:55:19 +00001023 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001024
wdenkfd3103b2003-11-25 16:55:19 +00001025 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001026
wdenkfd3103b2003-11-25 16:55:19 +00001027 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001028
wdenkfd3103b2003-11-25 16:55:19 +00001029 NEC NL6448BC20-08. 6.5", 640x480.
1030 Active, color, single scan.
1031
1032 CONFIG_NEC_NL6448BC33_54
1033
1034 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001035 Active, color, single scan.
1036
1037 CONFIG_SHARP_16x9
1038
1039 Sharp 320x240. Active, color, single scan.
1040 It isn't 16x9, and I am not sure what it is.
1041
1042 CONFIG_SHARP_LQ64D341
1043
1044 Sharp LQ64D341 display, 640x480.
1045 Active, color, single scan.
1046
1047 CONFIG_HLD1045
1048
1049 HLD1045 display, 640x480.
1050 Active, color, single scan.
1051
1052 CONFIG_OPTREX_BW
1053
1054 Optrex CBL50840-2 NF-FW 99 22 M5
1055 or
1056 Hitachi LMG6912RPFC-00T
1057 or
1058 Hitachi SP14Q002
1059
1060 320x240. Black & white.
1061
1062 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001063 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001064
wdenk7152b1d2003-09-05 23:19:14 +00001065- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001066
wdenk8bde7f72003-06-27 21:31:46 +00001067 If this option is set, the environment is checked for
1068 a variable "splashimage". If found, the usual display
1069 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001070 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001071 specified in "splashimage" is loaded instead. The
1072 console is redirected to the "nulldev", too. This
1073 allows for a "silent" boot where a splash screen is
1074 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001075
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001076 CONFIG_SPLASH_SCREEN_ALIGN
1077
1078 If this option is set the splash image can be freely positioned
1079 on the screen. Environment variable "splashpos" specifies the
1080 position as "x,y". If a positive number is given it is used as
1081 number of pixel from left/top. If a negative number is given it
1082 is used as number of pixel from right/bottom. You can also
1083 specify 'm' for centering the image.
1084
1085 Example:
1086 setenv splashpos m,m
1087 => image at center of screen
1088
1089 setenv splashpos 30,20
1090 => image at x = 30 and y = 20
1091
1092 setenv splashpos -10,m
1093 => vertically centered image
1094 at x = dspWidth - bmpWidth - 9
1095
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001096- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1097
1098 If this option is set, additionally to standard BMP
1099 images, gzipped BMP images can be displayed via the
1100 splashscreen support or the bmp command.
1101
wdenkc29fdfc2003-08-29 20:57:53 +00001102- Compression support:
1103 CONFIG_BZIP2
1104
1105 If this option is set, support for bzip2 compressed
1106 images is included. If not, only uncompressed and gzip
1107 compressed images are supported.
1108
wdenk42d1f032003-10-15 23:53:47 +00001109 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001110 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001111 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001112
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001113 CONFIG_LZMA
1114
1115 If this option is set, support for lzma compressed
1116 images is included.
1117
1118 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1119 requires an amount of dynamic memory that is given by the
1120 formula:
1121
1122 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1123
1124 Where lc and lp stand for, respectively, Literal context bits
1125 and Literal pos bits.
1126
1127 This value is upper-bounded by 14MB in the worst case. Anyway,
1128 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1129 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1130 a very small buffer.
1131
1132 Use the lzmainfo tool to determinate the lc and lp values and
1133 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001134 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001135
wdenk17ea1172004-06-06 21:51:03 +00001136- MII/PHY support:
1137 CONFIG_PHY_ADDR
1138
1139 The address of PHY on MII bus.
1140
1141 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1142
1143 The clock frequency of the MII bus
1144
1145 CONFIG_PHY_GIGE
1146
1147 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001148 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001149
1150 CONFIG_PHY_RESET_DELAY
1151
1152 Some PHY like Intel LXT971A need extra delay after
1153 reset before any MII register access is possible.
1154 For such PHY, set this option to the usec delay
1155 required. (minimum 300usec for LXT971A)
1156
1157 CONFIG_PHY_CMD_DELAY (ppc4xx)
1158
1159 Some PHY like Intel LXT971A need extra delay after
1160 command issued before MII status register can be read
1161
wdenkc6097192002-11-03 00:24:07 +00001162- Ethernet address:
1163 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001164 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001165 CONFIG_ETH2ADDR
1166 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001167 CONFIG_ETH4ADDR
1168 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001169
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001170 Define a default value for Ethernet address to use
1171 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001172 is not determined automatically.
1173
1174- IP address:
1175 CONFIG_IPADDR
1176
1177 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001178 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001179 determined through e.g. bootp.
1180
1181- Server IP address:
1182 CONFIG_SERVERIP
1183
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001184 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001185 server to contact when using the "tftboot" command.
1186
Robin Getz97cfe862009-07-21 12:15:28 -04001187 CONFIG_KEEP_SERVERADDR
1188
1189 Keeps the server's MAC address, in the env 'serveraddr'
1190 for passing to bootargs (like Linux's netconsole option)
1191
David Updegraff53a5c422007-06-11 10:41:07 -05001192- Multicast TFTP Mode:
1193 CONFIG_MCAST_TFTP
1194
1195 Defines whether you want to support multicast TFTP as per
1196 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001197 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001198 driver in use must provide a function: mcast() to join/leave a
1199 multicast group.
1200
1201 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001202- BOOTP Recovery Mode:
1203 CONFIG_BOOTP_RANDOM_DELAY
1204
1205 If you have many targets in a network that try to
1206 boot using BOOTP, you may want to avoid that all
1207 systems send out BOOTP requests at precisely the same
1208 moment (which would happen for instance at recovery
1209 from a power failure, when all systems will try to
1210 boot, thus flooding the BOOTP server. Defining
1211 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1212 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001213 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001214
1215 1st BOOTP request: delay 0 ... 1 sec
1216 2nd BOOTP request: delay 0 ... 2 sec
1217 3rd BOOTP request: delay 0 ... 4 sec
1218 4th and following
1219 BOOTP requests: delay 0 ... 8 sec
1220
stroesefe389a82003-08-28 14:17:32 +00001221- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001222 You can fine tune the DHCP functionality by defining
1223 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001224
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001225 CONFIG_BOOTP_SUBNETMASK
1226 CONFIG_BOOTP_GATEWAY
1227 CONFIG_BOOTP_HOSTNAME
1228 CONFIG_BOOTP_NISDOMAIN
1229 CONFIG_BOOTP_BOOTPATH
1230 CONFIG_BOOTP_BOOTFILESIZE
1231 CONFIG_BOOTP_DNS
1232 CONFIG_BOOTP_DNS2
1233 CONFIG_BOOTP_SEND_HOSTNAME
1234 CONFIG_BOOTP_NTPSERVER
1235 CONFIG_BOOTP_TIMEOFFSET
1236 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001237
Wilson Callan5d110f02007-07-28 10:56:13 -04001238 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1239 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001240
1241 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1242 serverip from a DHCP server, it is possible that more
1243 than one DNS serverip is offered to the client.
1244 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1245 serverip will be stored in the additional environment
1246 variable "dnsip2". The first DNS serverip is always
1247 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001248 is defined.
stroesefe389a82003-08-28 14:17:32 +00001249
1250 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1251 to do a dynamic update of a DNS server. To do this, they
1252 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001253 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001254 of the "hostname" environment variable is passed as
1255 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001256
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001257 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1258
1259 A 32bit value in microseconds for a delay between
1260 receiving a "DHCP Offer" and sending the "DHCP Request".
1261 This fixes a problem with certain DHCP servers that don't
1262 respond 100% of the time to a "DHCP request". E.g. On an
1263 AT91RM9200 processor running at 180MHz, this delay needed
1264 to be *at least* 15,000 usec before a Windows Server 2003
1265 DHCP server would reply 100% of the time. I recommend at
1266 least 50,000 usec to be safe. The alternative is to hope
1267 that one of the retries will be successful but note that
1268 the DHCP timeout and retry process takes a longer than
1269 this delay.
1270
wdenka3d991b2004-04-15 21:48:45 +00001271 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001272 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001273
1274 The device id used in CDP trigger frames.
1275
1276 CONFIG_CDP_DEVICE_ID_PREFIX
1277
1278 A two character string which is prefixed to the MAC address
1279 of the device.
1280
1281 CONFIG_CDP_PORT_ID
1282
1283 A printf format string which contains the ascii name of
1284 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001285 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001286
1287 CONFIG_CDP_CAPABILITIES
1288
1289 A 32bit integer which indicates the device capabilities;
1290 0x00000010 for a normal host which does not forwards.
1291
1292 CONFIG_CDP_VERSION
1293
1294 An ascii string containing the version of the software.
1295
1296 CONFIG_CDP_PLATFORM
1297
1298 An ascii string containing the name of the platform.
1299
1300 CONFIG_CDP_TRIGGER
1301
1302 A 32bit integer sent on the trigger.
1303
1304 CONFIG_CDP_POWER_CONSUMPTION
1305
1306 A 16bit integer containing the power consumption of the
1307 device in .1 of milliwatts.
1308
1309 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1310
1311 A byte containing the id of the VLAN.
1312
wdenkc6097192002-11-03 00:24:07 +00001313- Status LED: CONFIG_STATUS_LED
1314
1315 Several configurations allow to display the current
1316 status using a LED. For instance, the LED will blink
1317 fast while running U-Boot code, stop blinking as
1318 soon as a reply to a BOOTP request was received, and
1319 start blinking slow once the Linux kernel is running
1320 (supported by a status LED driver in the Linux
1321 kernel). Defining CONFIG_STATUS_LED enables this
1322 feature in U-Boot.
1323
1324- CAN Support: CONFIG_CAN_DRIVER
1325
1326 Defining CONFIG_CAN_DRIVER enables CAN driver support
1327 on those systems that support this (optional)
1328 feature, like the TQM8xxL modules.
1329
1330- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1331
wdenkb37c7e52003-06-30 16:24:52 +00001332 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001333 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001334 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001335
wdenk945af8d2003-07-16 21:53:01 +00001336 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001337 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001338 CONFIG_COMMANDS) and communicate with i2c based realtime
1339 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001340 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001341
Ben Warrenbb99ad62006-09-07 16:50:54 -04001342 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001343
wdenk945af8d2003-07-16 21:53:01 +00001344 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001345 bit-banging) driver instead of CPM or similar hardware
1346 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001347
wdenk945af8d2003-07-16 21:53:01 +00001348 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001349 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001351 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001352 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001353 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001354 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001355
wdenkb37c7e52003-06-30 16:24:52 +00001356 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001357 sets the CPU up as a master node and so its address should
wdenkb37c7e52003-06-30 16:24:52 +00001358 therefore be cleared to 0 (See, eg, MPC823e User's Manual
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001359 p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001360
wdenk945af8d2003-07-16 21:53:01 +00001361 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001362
1363 If you use the software i2c interface (CONFIG_SOFT_I2C)
1364 then the following macros need to be defined (examples are
1365 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001366
1367 I2C_INIT
1368
wdenkb37c7e52003-06-30 16:24:52 +00001369 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001370 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001371
wdenkba56f622004-02-06 23:19:44 +00001372 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001373
wdenkc6097192002-11-03 00:24:07 +00001374 I2C_PORT
1375
wdenk43d96162003-03-06 00:02:04 +00001376 (Only for MPC8260 CPU). The I/O port to use (the code
1377 assumes both bits are on the same port). Valid values
1378 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001379
1380 I2C_ACTIVE
1381
1382 The code necessary to make the I2C data line active
1383 (driven). If the data line is open collector, this
1384 define can be null.
1385
wdenkb37c7e52003-06-30 16:24:52 +00001386 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1387
wdenkc6097192002-11-03 00:24:07 +00001388 I2C_TRISTATE
1389
1390 The code necessary to make the I2C data line tri-stated
1391 (inactive). If the data line is open collector, this
1392 define can be null.
1393
wdenkb37c7e52003-06-30 16:24:52 +00001394 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1395
wdenkc6097192002-11-03 00:24:07 +00001396 I2C_READ
1397
1398 Code that returns TRUE if the I2C data line is high,
1399 FALSE if it is low.
1400
wdenkb37c7e52003-06-30 16:24:52 +00001401 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1402
wdenkc6097192002-11-03 00:24:07 +00001403 I2C_SDA(bit)
1404
1405 If <bit> is TRUE, sets the I2C data line high. If it
1406 is FALSE, it clears it (low).
1407
wdenkb37c7e52003-06-30 16:24:52 +00001408 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001409 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001410 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001411
wdenkc6097192002-11-03 00:24:07 +00001412 I2C_SCL(bit)
1413
1414 If <bit> is TRUE, sets the I2C clock line high. If it
1415 is FALSE, it clears it (low).
1416
wdenkb37c7e52003-06-30 16:24:52 +00001417 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001418 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001419 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001420
wdenkc6097192002-11-03 00:24:07 +00001421 I2C_DELAY
1422
1423 This delay is invoked four times per clock cycle so this
1424 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001425 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001426 like:
1427
wdenkb37c7e52003-06-30 16:24:52 +00001428 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001429
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001430 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001431
wdenk8bde7f72003-06-27 21:31:46 +00001432 When a board is reset during an i2c bus transfer
1433 chips might think that the current transfer is still
1434 in progress. On some boards it is possible to access
1435 the i2c SCLK line directly, either by using the
1436 processor pin as a GPIO or by having a second pin
1437 connected to the bus. If this option is defined a
1438 custom i2c_init_board() routine in boards/xxx/board.c
1439 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001440
wdenk17ea1172004-06-06 21:51:03 +00001441 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1442
1443 This option enables configuration of bi_iic_fast[] flags
1444 in u-boot bd_info structure based on u-boot environment
1445 variable "i2cfast". (see also i2cfast)
1446
Ben Warrenbb99ad62006-09-07 16:50:54 -04001447 CONFIG_I2C_MULTI_BUS
1448
1449 This option allows the use of multiple I2C buses, each of which
1450 must have a controller. At any point in time, only one bus is
1451 active. To switch to a different bus, use the 'i2c dev' command.
1452 Note that bus numbering is zero-based.
1453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001454 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001455
1456 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001457 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1458 is set, specify a list of bus-device pairs. Otherwise, specify
1459 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001460
1461 e.g.
1462 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001463 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001464
1465 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1466
1467 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001468 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001469
1470 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1471
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001472 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001473
1474 If defined, then this indicates the I2C bus number for DDR SPD.
1475 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1476
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001477 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001478
1479 If defined, then this indicates the I2C bus number for the RTC.
1480 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1481
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001482 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001483
1484 If defined, then this indicates the I2C bus number for the DTT.
1485 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001487 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001488
1489 If defined, specifies the I2C address of the DTT device.
1490 If not defined, then U-Boot uses predefined value for
1491 specified DTT device.
1492
Timur Tabibe5e6182006-11-03 19:15:00 -06001493 CONFIG_FSL_I2C
1494
1495 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001496 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001497
Heiko Schocher67b23a32008-10-15 09:39:47 +02001498 CONFIG_I2C_MUX
1499
1500 Define this option if you have I2C devices reached over 1 .. n
1501 I2C Muxes like the pca9544a. This option addes a new I2C
1502 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1503 new I2C Bus to the existing I2C Busses. If you select the
1504 new Bus with "i2c dev", u-bbot sends first the commandos for
1505 the muxes to activate this new "bus".
1506
1507 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1508 feature!
1509
1510 Example:
1511 Adding a new I2C Bus reached over 2 pca9544a muxes
1512 The First mux with address 70 and channel 6
1513 The Second mux with address 71 and channel 4
1514
1515 => i2c bus pca9544a:70:6:pca9544a:71:4
1516
1517 Use the "i2c bus" command without parameter, to get a list
1518 of I2C Busses with muxes:
1519
1520 => i2c bus
1521 Busses reached over muxes:
1522 Bus ID: 2
1523 reached over Mux(es):
1524 pca9544a@70 ch: 4
1525 Bus ID: 3
1526 reached over Mux(es):
1527 pca9544a@70 ch: 6
1528 pca9544a@71 ch: 4
1529 =>
1530
1531 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1532 u-boot sends First the Commando to the mux@70 to enable
1533 channel 6, and then the Commando to the mux@71 to enable
1534 the channel 4.
1535
1536 After that, you can use the "normal" i2c commands as
1537 usual, to communicate with your I2C devices behind
1538 the 2 muxes.
1539
1540 This option is actually implemented for the bitbanging
1541 algorithm in common/soft_i2c.c and for the Hardware I2C
1542 Bus on the MPC8260. But it should be not so difficult
1543 to add this option to other architectures.
1544
Andrew Dyer2ac69852008-12-29 17:36:01 -06001545 CONFIG_SOFT_I2C_READ_REPEATED_START
1546
1547 defining this will force the i2c_read() function in
1548 the soft_i2c driver to perform an I2C repeated start
1549 between writing the address pointer and reading the
1550 data. If this define is omitted the default behaviour
1551 of doing a stop-start sequence will be used. Most I2C
1552 devices can use either method, but some require one or
1553 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001554
wdenkc6097192002-11-03 00:24:07 +00001555- SPI Support: CONFIG_SPI
1556
1557 Enables SPI driver (so far only tested with
1558 SPI EEPROM, also an instance works with Crystal A/D and
1559 D/As on the SACSng board)
1560
1561 CONFIG_SPI_X
1562
1563 Enables extended (16-bit) SPI EEPROM addressing.
1564 (symmetrical to CONFIG_I2C_X)
1565
1566 CONFIG_SOFT_SPI
1567
wdenk43d96162003-03-06 00:02:04 +00001568 Enables a software (bit-bang) SPI driver rather than
1569 using hardware support. This is a general purpose
1570 driver that only requires three general I/O port pins
1571 (two outputs, one input) to function. If this is
1572 defined, the board configuration must define several
1573 SPI configuration items (port pins to use, etc). For
1574 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001575
Ben Warren04a9e112008-01-16 22:37:35 -05001576 CONFIG_HARD_SPI
1577
1578 Enables a hardware SPI driver for general-purpose reads
1579 and writes. As with CONFIG_SOFT_SPI, the board configuration
1580 must define a list of chip-select function pointers.
1581 Currently supported on some MPC8xxx processors. For an
1582 example, see include/configs/mpc8349emds.h.
1583
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001584 CONFIG_MXC_SPI
1585
1586 Enables the driver for the SPI controllers on i.MX and MXC
1587 SoCs. Currently only i.MX31 is supported.
1588
Matthias Fuchs01335022007-12-27 17:12:34 +01001589- FPGA Support: CONFIG_FPGA
1590
1591 Enables FPGA subsystem.
1592
1593 CONFIG_FPGA_<vendor>
1594
1595 Enables support for specific chip vendors.
1596 (ALTERA, XILINX)
1597
1598 CONFIG_FPGA_<family>
1599
1600 Enables support for FPGA family.
1601 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1602
1603 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001604
wdenk43d96162003-03-06 00:02:04 +00001605 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001606
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001607 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001608
wdenk8bde7f72003-06-27 21:31:46 +00001609 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001611 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001612
wdenk43d96162003-03-06 00:02:04 +00001613 Enable checks on FPGA configuration interface busy
1614 status by the configuration function. This option
1615 will require a board or device specific function to
1616 be written.
wdenkc6097192002-11-03 00:24:07 +00001617
1618 CONFIG_FPGA_DELAY
1619
1620 If defined, a function that provides delays in the FPGA
1621 configuration driver.
1622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001623 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001624 Allow Control-C to interrupt FPGA configuration
1625
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001626 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001627
wdenk43d96162003-03-06 00:02:04 +00001628 Check for configuration errors during FPGA bitfile
1629 loading. For example, abort during Virtex II
1630 configuration if the INIT_B line goes low (which
1631 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001633 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001634
wdenk43d96162003-03-06 00:02:04 +00001635 Maximum time to wait for the INIT_B line to deassert
1636 after PROB_B has been deasserted during a Virtex II
1637 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001638 ms.
wdenkc6097192002-11-03 00:24:07 +00001639
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001640 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001641
wdenk43d96162003-03-06 00:02:04 +00001642 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001643 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001644
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001645 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001646
wdenk43d96162003-03-06 00:02:04 +00001647 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001648 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001649
1650- Configuration Management:
1651 CONFIG_IDENT_STRING
1652
wdenk43d96162003-03-06 00:02:04 +00001653 If defined, this string will be added to the U-Boot
1654 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001655
1656- Vendor Parameter Protection:
1657
wdenk43d96162003-03-06 00:02:04 +00001658 U-Boot considers the values of the environment
1659 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001660 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001661 are set once by the board vendor / manufacturer, and
1662 protects these variables from casual modification by
1663 the user. Once set, these variables are read-only,
1664 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001665 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001666
1667 If CONFIG_ENV_OVERWRITE is #defined in your config
1668 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001669 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001670 these parameters.
1671
1672 Alternatively, if you #define _both_ CONFIG_ETHADDR
1673 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001674 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001675 which can be changed exactly ONCE by the user. [The
1676 serial# is unaffected by this, i. e. it remains
1677 read-only.]
1678
1679- Protected RAM:
1680 CONFIG_PRAM
1681
1682 Define this variable to enable the reservation of
1683 "protected RAM", i. e. RAM which is not overwritten
1684 by U-Boot. Define CONFIG_PRAM to hold the number of
1685 kB you want to reserve for pRAM. You can overwrite
1686 this default value by defining an environment
1687 variable "pram" to the number of kB you want to
1688 reserve. Note that the board info structure will
1689 still show the full amount of RAM. If pRAM is
1690 reserved, a new environment variable "mem" will
1691 automatically be defined to hold the amount of
1692 remaining RAM in a form that can be passed as boot
1693 argument to Linux, for instance like that:
1694
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001695 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001696 saveenv
1697
1698 This way you can tell Linux not to use this memory,
1699 either, which results in a memory region that will
1700 not be affected by reboots.
1701
1702 *WARNING* If your board configuration uses automatic
1703 detection of the RAM size, you must make sure that
1704 this memory test is non-destructive. So far, the
1705 following board configurations are known to be
1706 "pRAM-clean":
1707
1708 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1709 HERMES, IP860, RPXlite, LWMON, LANTEC,
1710 PCU_E, FLAGADM, TQM8260
1711
1712- Error Recovery:
1713 CONFIG_PANIC_HANG
1714
1715 Define this variable to stop the system in case of a
1716 fatal error, so that you have to reset it manually.
1717 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001718 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001719 automatically as fast as possible, but it may be
1720 useful during development since you can try to debug
1721 the conditions that lead to the situation.
1722
1723 CONFIG_NET_RETRY_COUNT
1724
wdenk43d96162003-03-06 00:02:04 +00001725 This variable defines the number of retries for
1726 network operations like ARP, RARP, TFTP, or BOOTP
1727 before giving up the operation. If not defined, a
1728 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001729
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001730 CONFIG_ARP_TIMEOUT
1731
1732 Timeout waiting for an ARP reply in milliseconds.
1733
wdenkc6097192002-11-03 00:24:07 +00001734- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001735 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001736
1737 Enable auto completion of commands using TAB.
1738
Wolfgang Denka9398e02006-11-27 15:32:42 +01001739 Note that this feature has NOT been implemented yet
1740 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001741
1742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001743 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001744
1745 Define this variable to enable the "hush" shell (from
1746 Busybox) as command line interpreter, thus enabling
1747 powerful command line syntax like
1748 if...then...else...fi conditionals or `&&' and '||'
1749 constructs ("shell scripts").
1750
1751 If undefined, you get the old, much simpler behaviour
1752 with a somewhat smaller memory footprint.
1753
1754
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001755 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001756
1757 This defines the secondary prompt string, which is
1758 printed when the command interpreter needs more input
1759 to complete a command. Usually "> ".
1760
1761 Note:
1762
wdenk8bde7f72003-06-27 21:31:46 +00001763 In the current implementation, the local variables
1764 space and global environment variables space are
1765 separated. Local variables are those you define by
1766 simply typing `name=value'. To access a local
1767 variable later on, you have write `$name' or
1768 `${name}'; to execute the contents of a variable
1769 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001770
wdenk43d96162003-03-06 00:02:04 +00001771 Global environment variables are those you use
1772 setenv/printenv to work with. To run a command stored
1773 in such a variable, you need to use the run command,
1774 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001775
1776 To store commands and special characters in a
1777 variable, please use double quotation marks
1778 surrounding the whole text of the variable, instead
1779 of the backslashes before semicolons and special
1780 symbols.
1781
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001782- Commandline Editing and History:
1783 CONFIG_CMDLINE_EDITING
1784
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001785 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001786 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001787
wdenka8c7c702003-12-06 19:49:23 +00001788- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001789 CONFIG_EXTRA_ENV_SETTINGS
1790
wdenk43d96162003-03-06 00:02:04 +00001791 Define this to contain any number of null terminated
1792 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001793 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001794
wdenk43d96162003-03-06 00:02:04 +00001795 For example, place something like this in your
1796 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001797
1798 #define CONFIG_EXTRA_ENV_SETTINGS \
1799 "myvar1=value1\0" \
1800 "myvar2=value2\0"
1801
wdenk43d96162003-03-06 00:02:04 +00001802 Warning: This method is based on knowledge about the
1803 internal format how the environment is stored by the
1804 U-Boot code. This is NOT an official, exported
1805 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001806 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001807 You better know what you are doing here.
1808
wdenk43d96162003-03-06 00:02:04 +00001809 Note: overly (ab)use of the default environment is
1810 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001811 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001812 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001813
wdenka8c7c702003-12-06 19:49:23 +00001814- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001815 CONFIG_HAS_DATAFLASH
1816
wdenk8bde7f72003-06-27 21:31:46 +00001817 Defining this option enables DataFlash features and
1818 allows to read/write in Dataflash via the standard
1819 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001820
wdenk3f85ce22004-02-23 16:11:30 +00001821- SystemACE Support:
1822 CONFIG_SYSTEMACE
1823
1824 Adding this option adds support for Xilinx SystemACE
1825 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001826 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001827 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001828
1829 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001830 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001831
1832 When SystemACE support is added, the "ace" device type
1833 becomes available to the fat commands, i.e. fatls.
1834
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001835- TFTP Fixed UDP Port:
1836 CONFIG_TFTP_PORT
1837
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001838 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001839 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001840 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001841 number generator is used.
1842
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001843 Also, the environment variable tftpdstp is used to supply
1844 the TFTP UDP destination port value. If tftpdstp isn't
1845 defined, the normal port 69 is used.
1846
1847 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001848 blindly start the TFTP transfer using the pre-configured
1849 target IP address and UDP port. This has the effect of
1850 "punching through" the (Windows XP) firewall, allowing
1851 the remainder of the TFTP transfer to proceed normally.
1852 A better solution is to properly configure the firewall,
1853 but sometimes that is not allowed.
1854
wdenka8c7c702003-12-06 19:49:23 +00001855- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001856 CONFIG_SHOW_BOOT_PROGRESS
1857
wdenk43d96162003-03-06 00:02:04 +00001858 Defining this option allows to add some board-
1859 specific code (calling a user-provided function
1860 "show_boot_progress(int)") that enables you to show
1861 the system's boot progress on some display (for
1862 example, some LED's) on your board. At the moment,
1863 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001864
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02001865- Automatic software updates via TFTP server
1866 CONFIG_UPDATE_TFTP
1867 CONFIG_UPDATE_TFTP_CNT_MAX
1868 CONFIG_UPDATE_TFTP_MSEC_MAX
1869
1870 These options enable and control the auto-update feature;
1871 for a more detailed description refer to doc/README.update.
1872
Stefan Roesed5581072009-05-12 14:31:18 +02001873- MTD Support (mtdparts command, UBI support)
1874 CONFIG_MTD_DEVICE
1875
1876 Adds the MTD device infrastructure from the Linux kernel.
1877 Needed for mtdparts command support.
1878
1879 CONFIG_MTD_PARTITIONS
1880
1881 Adds the MTD partitioning infrastructure from the Linux
1882 kernel. Needed for UBI support.
1883
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001884Legacy uImage format:
1885
wdenkc6097192002-11-03 00:24:07 +00001886 Arg Where When
1887 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001888 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001889 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001890 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001891 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001892 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001893 4 common/cmd_bootm.c Image data has correct checksum
1894 -4 common/cmd_bootm.c Image is for unsupported architecture
1895 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001896 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001897 6 common/cmd_bootm.c Image Type check OK
1898 -6 common/cmd_bootm.c gunzip uncompression error
1899 -7 common/cmd_bootm.c Unimplemented compression type
1900 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001901 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001902 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001903
1904 9 common/image.c Start initial ramdisk verification
1905 -10 common/image.c Ramdisk header has bad magic number
1906 -11 common/image.c Ramdisk header has bad checksum
1907 10 common/image.c Ramdisk header is OK
1908 -12 common/image.c Ramdisk data has bad checksum
1909 11 common/image.c Ramdisk data has correct checksum
1910 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001911 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001912 13 common/image.c Start multifile image verification
1913 14 common/image.c No initial ramdisk, no multifile, continue.
1914
1915 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001916
wdenk11dadd52004-02-27 00:07:27 +00001917 -30 lib_ppc/board.c Fatal error, hang the system
1918 -31 post/post.c POST test failed, detected by post_output_backlog()
1919 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001920
Heiko Schocher566a4942007-06-22 19:11:54 +02001921 34 common/cmd_doc.c before loading a Image from a DOC device
1922 -35 common/cmd_doc.c Bad usage of "doc" command
1923 35 common/cmd_doc.c correct usage of "doc" command
1924 -36 common/cmd_doc.c No boot device
1925 36 common/cmd_doc.c correct boot device
1926 -37 common/cmd_doc.c Unknown Chip ID on boot device
1927 37 common/cmd_doc.c correct chip ID found, device available
1928 -38 common/cmd_doc.c Read Error on boot device
1929 38 common/cmd_doc.c reading Image header from DOC device OK
1930 -39 common/cmd_doc.c Image header has bad magic number
1931 39 common/cmd_doc.c Image header has correct magic number
1932 -40 common/cmd_doc.c Error reading Image from DOC device
1933 40 common/cmd_doc.c Image header has correct magic number
1934 41 common/cmd_ide.c before loading a Image from a IDE device
1935 -42 common/cmd_ide.c Bad usage of "ide" command
1936 42 common/cmd_ide.c correct usage of "ide" command
1937 -43 common/cmd_ide.c No boot device
1938 43 common/cmd_ide.c boot device found
1939 -44 common/cmd_ide.c Device not available
1940 44 common/cmd_ide.c Device available
1941 -45 common/cmd_ide.c wrong partition selected
1942 45 common/cmd_ide.c partition selected
1943 -46 common/cmd_ide.c Unknown partition table
1944 46 common/cmd_ide.c valid partition table found
1945 -47 common/cmd_ide.c Invalid partition type
1946 47 common/cmd_ide.c correct partition type
1947 -48 common/cmd_ide.c Error reading Image Header on boot device
1948 48 common/cmd_ide.c reading Image Header from IDE device OK
1949 -49 common/cmd_ide.c Image header has bad magic number
1950 49 common/cmd_ide.c Image header has correct magic number
1951 -50 common/cmd_ide.c Image header has bad checksum
1952 50 common/cmd_ide.c Image header has correct checksum
1953 -51 common/cmd_ide.c Error reading Image from IDE device
1954 51 common/cmd_ide.c reading Image from IDE device OK
1955 52 common/cmd_nand.c before loading a Image from a NAND device
1956 -53 common/cmd_nand.c Bad usage of "nand" command
1957 53 common/cmd_nand.c correct usage of "nand" command
1958 -54 common/cmd_nand.c No boot device
1959 54 common/cmd_nand.c boot device found
1960 -55 common/cmd_nand.c Unknown Chip ID on boot device
1961 55 common/cmd_nand.c correct chip ID found, device available
1962 -56 common/cmd_nand.c Error reading Image Header on boot device
1963 56 common/cmd_nand.c reading Image Header from NAND device OK
1964 -57 common/cmd_nand.c Image header has bad magic number
1965 57 common/cmd_nand.c Image header has correct magic number
1966 -58 common/cmd_nand.c Error reading Image from NAND device
1967 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00001968
Heiko Schocher566a4942007-06-22 19:11:54 +02001969 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001970
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001971 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02001972 -64 net/eth.c no Ethernet found.
1973 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00001974
Heiko Schocher566a4942007-06-22 19:11:54 +02001975 -80 common/cmd_net.c usage wrong
1976 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001977 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02001978 81 common/cmd_net.c NetLoop() back without error
1979 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1980 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001981 83 common/cmd_net.c running "source" command
1982 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02001983 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00001984
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001985FIT uImage format:
1986
1987 Arg Where When
1988 100 common/cmd_bootm.c Kernel FIT Image has correct format
1989 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1990 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1991 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1992 102 common/cmd_bootm.c Kernel unit name specified
1993 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01001994 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001995 104 common/cmd_bootm.c Got kernel subimage node offset
1996 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1997 105 common/cmd_bootm.c Kernel subimage hash verification OK
1998 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1999 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002000 -106 common/cmd_bootm.c Kernel subimage has wrong type
2001 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002002 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2003 108 common/cmd_bootm.c Got kernel subimage data/size
2004 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2005 -109 common/cmd_bootm.c Can't get kernel subimage type
2006 -110 common/cmd_bootm.c Can't get kernel subimage comp
2007 -111 common/cmd_bootm.c Can't get kernel subimage os
2008 -112 common/cmd_bootm.c Can't get kernel subimage load address
2009 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2010
2011 120 common/image.c Start initial ramdisk verification
2012 -120 common/image.c Ramdisk FIT image has incorrect format
2013 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002014 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002015 -122 common/image.c Can't get configuration for ramdisk subimage
2016 123 common/image.c Ramdisk unit name specified
2017 -124 common/image.c Can't get ramdisk subimage node offset
2018 125 common/image.c Got ramdisk subimage node offset
2019 -125 common/image.c Ramdisk subimage hash verification failed
2020 126 common/image.c Ramdisk subimage hash verification OK
2021 -126 common/image.c Ramdisk subimage for unsupported architecture
2022 127 common/image.c Architecture check OK
2023 -127 common/image.c Can't get ramdisk subimage data/size
2024 128 common/image.c Got ramdisk subimage data/size
2025 129 common/image.c Can't get ramdisk load address
2026 -129 common/image.c Got ramdisk load address
2027
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002028 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002029 131 common/cmd_doc.c FIT image format OK
2030
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002031 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002032 141 common/cmd_ide.c FIT image format OK
2033
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002034 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002035 151 common/cmd_nand.c FIT image format OK
2036
2037
wdenkc6097192002-11-03 00:24:07 +00002038Modem Support:
2039--------------
2040
wdenk85ec0bc2003-03-31 16:34:49 +00002041[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002042
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002043- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002044 CONFIG_MODEM_SUPPORT
2045
2046- RTS/CTS Flow control enable:
2047 CONFIG_HWFLOW
2048
2049- Modem debug support:
2050 CONFIG_MODEM_SUPPORT_DEBUG
2051
wdenk43d96162003-03-06 00:02:04 +00002052 Enables debugging stuff (char screen[1024], dbg())
2053 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002054
wdenka8c7c702003-12-06 19:49:23 +00002055- Interrupt support (PPC):
2056
wdenkd4ca31c2004-01-02 14:00:00 +00002057 There are common interrupt_init() and timer_interrupt()
2058 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002059 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002060 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002061 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002062 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002063 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002064 specific handling. If board has watchdog / status_led
2065 / other_activity_monitor it works automatically from
2066 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002067
wdenkc6097192002-11-03 00:24:07 +00002068- General:
2069
wdenk43d96162003-03-06 00:02:04 +00002070 In the target system modem support is enabled when a
2071 specific key (key combination) is pressed during
2072 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002073 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002074 board_init(). Currently key_pressed() is a dummy
2075 function, returning 1 and thus enabling modem
2076 initialization.
wdenkc6097192002-11-03 00:24:07 +00002077
wdenk43d96162003-03-06 00:02:04 +00002078 If there are no modem init strings in the
2079 environment, U-Boot proceed to autoboot; the
2080 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002081 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002082
2083 See also: doc/README.Modem
2084
2085
wdenkc6097192002-11-03 00:24:07 +00002086Configuration Settings:
2087-----------------------
2088
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002089- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002090 undefine this when you're short of memory.
2091
Peter Tyser2fb26042009-01-27 18:03:12 -06002092- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2093 width of the commands listed in the 'help' command output.
2094
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002095- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002096 prompt for user input.
2097
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002098- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002099
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002100- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002101
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002102- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002103
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002104- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002105 the application (usually a Linux kernel) when it is
2106 booted
2107
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002108- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002109 List of legal baudrate settings for this board.
2110
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002111- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002112 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002113
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002114- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002115 If the board specific function
2116 extern int overwrite_console (void);
2117 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002118 serial port, else the settings in the environment are used.
2119
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002120- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002121 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002123- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002124 Enable overwrite of previous console environment settings.
2125
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002126- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002127 Begin and End addresses of the area used by the
2128 simple memory test.
2129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002130- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002131 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002133- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002134 Scratch address used by the alternate memory test
2135 You only need to set this if address zero isn't writeable
2136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002137- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2138 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002139 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002140 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002141 fixing up gd->ram_size the Linux kernel should gets passed
2142 the now "corrected" memory size and won't touch it either.
2143 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002144 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002145 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002146 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002147
2148 This option can be used as a workaround for the 440EPx/GRx
2149 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2150 be touched.
2151
2152 WARNING: Please make sure that this value is a multiple of
2153 the Linux page size (normally 4k). If this is not the case,
2154 then the end address of the Linux memory will be located at a
2155 non page size aligned address and this could cause major
2156 problems.
2157
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002158- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002159 Default load address for network file downloads
2160
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002161- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002162 Enable temporary baudrate change while serial download
2163
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002164- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002165 Physical start address of SDRAM. _Must_ be 0 here.
2166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002167- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002168 Physical start address of Motherboard I/O (if using a
2169 Cogent motherboard)
2170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002171- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002172 Physical start address of Flash memory.
2173
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002174- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002175 Physical start address of boot monitor code (set by
2176 make config files to be same as the text base address
2177 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002178 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002179
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002180- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002181 Size of memory reserved for monitor code, used to
2182 determine _at_compile_time_ (!) if the environment is
2183 embedded within the U-Boot image, or in a separate
2184 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002185
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002186- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002187 Size of DRAM reserved for malloc() use.
2188
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002189- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002190 Normally compressed uImages are limited to an
2191 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002192 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002193 to adjust this setting to your needs.
2194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002195- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002196 Maximum size of memory mapped by the startup code of
2197 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002198 the Linux kernel (bd_info, boot arguments, FDT blob if
2199 used) must be put below this limit, unless "bootm_low"
2200 enviroment variable is defined and non-zero. In such case
2201 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002202 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002204- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002205 Max number of Flash memory banks
2206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002207- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002208 Max number of sectors on a Flash chip
2209
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002210- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002211 Timeout for Flash erase operations (in ms)
2212
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002213- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002214 Timeout for Flash write operations (in ms)
2215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002216- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002217 Timeout for Flash set sector lock bit operation (in ms)
2218
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002219- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002220 Timeout for Flash clear lock bits operation (in ms)
2221
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002222- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002223 If defined, hardware flash sectors protection is used
2224 instead of U-Boot software protection.
2225
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002226- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002227
2228 Enable TFTP transfers directly to flash memory;
2229 without this option such a download has to be
2230 performed in two steps: (1) download to RAM, and (2)
2231 copy from RAM to flash.
2232
2233 The two-step approach is usually more reliable, since
2234 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002235 the flash, but in some situations (when system RAM is
2236 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002237 downloaded image) this option may be very useful.
2238
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002239- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002240 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002241 common flash structure for storing flash geometry.
2242
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002243- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002244 This option also enables the building of the cfi_flash driver
2245 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002246
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002247- CONFIG_FLASH_CFI_MTD
2248 This option enables the building of the cfi_mtd driver
2249 in the drivers directory. The driver exports CFI flash
2250 to the MTD layer.
2251
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002252- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002253 Use buffered writes to flash.
2254
2255- CONFIG_FLASH_SPANSION_S29WS_N
2256 s29ws-n MirrorBit flash has non-standard addresses for buffered
2257 write commands.
2258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002259- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002260 If this option is defined, the common CFI flash doesn't
2261 print it's warning upon not recognized FLASH banks. This
2262 is useful, if some of the configured banks are only
2263 optionally available.
2264
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002265- CONFIG_FLASH_SHOW_PROGRESS
2266 If defined (must be an integer), print out countdown
2267 digits and dots. Recommended value: 45 (9..1) for 80
2268 column displays, 15 (3..1) for 40 column displays.
2269
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002270- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002271 Defines the number of Ethernet receive buffers. On some
2272 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002273 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2274 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002275 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002276 Defaults to 4 if not defined.
2277
wdenkc6097192002-11-03 00:24:07 +00002278The following definitions that deal with the placement and management
2279of environment data (variable area); in general, we support the
2280following configurations:
2281
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002282- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002283
2284 Define this if the environment is in flash memory.
2285
2286 a) The environment occupies one whole flash sector, which is
2287 "embedded" in the text segment with the U-Boot code. This
2288 happens usually with "bottom boot sector" or "top boot
2289 sector" type flash chips, which have several smaller
2290 sectors at the start or the end. For instance, such a
2291 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2292 such a case you would place the environment in one of the
2293 4 kB sectors - with U-Boot code before and after it. With
2294 "top boot sector" type flash chips, you would put the
2295 environment in one of the last sectors, leaving a gap
2296 between U-Boot and the environment.
2297
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002298 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002299
2300 Offset of environment data (variable area) to the
2301 beginning of flash memory; for instance, with bottom boot
2302 type flash chips the second sector can be used: the offset
2303 for this sector is given here.
2304
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002305 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002306
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002307 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002308
2309 This is just another way to specify the start address of
2310 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002311 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002312
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002313 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002314
2315 Size of the sector containing the environment.
2316
2317
2318 b) Sometimes flash chips have few, equal sized, BIG sectors.
2319 In such a case you don't want to spend a whole sector for
2320 the environment.
2321
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002322 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002323
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002324 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002325 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002326 of this flash sector for the environment. This saves
2327 memory for the RAM copy of the environment.
2328
2329 It may also save flash memory if you decide to use this
2330 when your environment is "embedded" within U-Boot code,
2331 since then the remainder of the flash sector could be used
2332 for U-Boot code. It should be pointed out that this is
2333 STRONGLY DISCOURAGED from a robustness point of view:
2334 updating the environment in flash makes it always
2335 necessary to erase the WHOLE sector. If something goes
2336 wrong before the contents has been restored from a copy in
2337 RAM, your target system will be dead.
2338
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002339 - CONFIG_ENV_ADDR_REDUND
2340 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002341
wdenk43d96162003-03-06 00:02:04 +00002342 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002343 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002344 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002345 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002346
2347BE CAREFUL! Any changes to the flash layout, and some changes to the
2348source code will make it necessary to adapt <board>/u-boot.lds*
2349accordingly!
2350
2351
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002352- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002353
2354 Define this if you have some non-volatile memory device
2355 (NVRAM, battery buffered SRAM) which you want to use for the
2356 environment.
2357
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002358 - CONFIG_ENV_ADDR:
2359 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002360
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002361 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002362 want to use for environment. It is assumed that this memory
2363 can just be read and written to, without any special
2364 provision.
2365
2366BE CAREFUL! The first access to the environment happens quite early
2367in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002368console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002369U-Boot will hang.
2370
2371Please note that even with NVRAM we still use a copy of the
2372environment in RAM: we could work on NVRAM directly, but we want to
2373keep settings there always unmodified except somebody uses "saveenv"
2374to save the current settings.
2375
2376
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002377- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002378
2379 Use this if you have an EEPROM or similar serial access
2380 device and a driver for it.
2381
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002382 - CONFIG_ENV_OFFSET:
2383 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002384
2385 These two #defines specify the offset and size of the
2386 environment area within the total memory of your EEPROM.
2387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002388 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002389 If defined, specified the chip address of the EEPROM device.
2390 The default address is zero.
2391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002392 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002393 If defined, the number of bits used to address bytes in a
2394 single page in the EEPROM device. A 64 byte page, for example
2395 would require six bits.
2396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002397 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002398 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002399 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002401 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002402 The length in bytes of the EEPROM memory array address. Note
2403 that this is NOT the chip address length!
2404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002405 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002406 EEPROM chips that implement "address overflow" are ones
2407 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2408 address and the extra bits end up in the "chip address" bit
2409 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2410 byte chips.
2411
2412 Note that we consider the length of the address field to
2413 still be one byte because the extra address bits are hidden
2414 in the chip address.
2415
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002416 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002417 The size in bytes of the EEPROM device.
2418
wdenkc6097192002-11-03 00:24:07 +00002419
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002420- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002421
wdenkd4ca31c2004-01-02 14:00:00 +00002422 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002423 want to use for the environment.
2424
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002425 - CONFIG_ENV_OFFSET:
2426 - CONFIG_ENV_ADDR:
2427 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002428
2429 These three #defines specify the offset and size of the
2430 environment area within the total memory of your DataFlash placed
2431 at the specified address.
2432
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002433- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002434
2435 Define this if you have a NAND device which you want to use
2436 for the environment.
2437
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002438 - CONFIG_ENV_OFFSET:
2439 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002440
2441 These two #defines specify the offset and size of the environment
2442 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00002443
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002444 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002445
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002446 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002447 size used to hold a redundant copy of the environment data,
2448 so that there is a valid backup copy in case there is a
2449 power failure during a "saveenv" operation.
2450
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002451 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2452 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002453 the NAND devices block size.
2454
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002455- CONFIG_NAND_ENV_DST
2456
2457 Defines address in RAM to which the nand_spl code should copy the
2458 environment. If redundant environment is used, it will be copied to
2459 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002461- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002462
2463 Defines offset to the initial SPI buffer area in DPRAM. The
2464 area is used at an early stage (ROM part) if the environment
2465 is configured to reside in the SPI EEPROM: We need a 520 byte
2466 scratch DPRAM area. It is used between the two initialization
2467 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2468 to be a good choice since it makes it far enough from the
2469 start of the data area as well as from the stack pointer.
2470
Bruce Adlere881cb52007-11-02 13:15:42 -07002471Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002472has been relocated to RAM and a RAM copy of the environment has been
2473created; also, when using EEPROM you will have to use getenv_r()
2474until then to read environment variables.
2475
wdenk85ec0bc2003-03-31 16:34:49 +00002476The environment is protected by a CRC32 checksum. Before the monitor
2477is relocated into RAM, as a result of a bad CRC you will be working
2478with the compiled-in default environment - *silently*!!! [This is
2479necessary, because the first environment variable we need is the
2480"baudrate" setting for the console - if we have a bad CRC, we don't
2481have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002482
2483Note: once the monitor has been relocated, then it will complain if
2484the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002485use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002487- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002488 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002489
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002490 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002491 also needs to be defined.
2492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002493- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002494 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002495
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002496- CONFIG_SYS_64BIT_VSPRINTF:
wdenkc40b2952004-03-13 23:29:43 +00002497 Makes vsprintf (and all *printf functions) support printing
2498 of 64bit values by using the L quantifier
2499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002500- CONFIG_SYS_64BIT_STRTOUL:
wdenkc40b2952004-03-13 23:29:43 +00002501 Adds simple_strtoull that returns a 64bit value
2502
Ron Madridf5675aa2009-02-18 14:30:44 -08002503- CONFIG_NS16550_MIN_FUNCTIONS:
2504 Define this if you desire to only have use of the NS16550_init
2505 and NS16550_putc functions for the serial driver located at
2506 drivers/serial/ns16550.c. This option is useful for saving
2507 space for already greatly restricted images, including but not
2508 limited to NAND_SPL configurations.
2509
wdenkc6097192002-11-03 00:24:07 +00002510Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002511---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002512
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002513- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002514 Cache Line Size of the CPU.
2515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002516- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002517 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002518
wdenk42d1f032003-10-15 23:53:47 +00002519 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2520 and RPXsuper) to be able to adjust the position of
2521 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002522
wdenk7f6c2cb2002-11-10 22:06:23 +00002523- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002524 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002525
2526 the default drive number (default value 0)
2527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002528 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002529
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002530 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002531 (default value 1)
2532
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002533 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002534
wdenk43d96162003-03-06 00:02:04 +00002535 defines the offset of register from address. It
2536 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002537 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002539 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2540 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002541 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002543 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002544 fdc_hw_init() is called at the beginning of the FDC
2545 setup. fdc_hw_init() must be provided by the board
2546 source code. It is used to make hardware dependant
2547 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002549- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002550 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002551 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002553- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002554
wdenk7152b1d2003-09-05 23:19:14 +00002555 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002556 initial data and stack; please note that this must be
2557 writable memory that is working WITHOUT special
2558 initialization, i. e. you CANNOT use normal RAM which
2559 will become available only after programming the
2560 memory controller and running certain initialization
2561 sequences.
2562
2563 U-Boot uses the following memory types:
2564 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2565 - MPC824X: data cache
2566 - PPC4xx: data cache
2567
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002568- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002569
2570 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002571 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2572 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002573 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002574 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2575 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2576 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2577 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002578
2579 Note:
2580 On the MPC824X (or other systems that use the data
2581 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002582 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002583 point to an otherwise UNUSED address space between
2584 the top of RAM and the start of the PCI space.
2585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002586- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002588- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002589
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002590- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002591
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002592- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002594- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002596- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002597
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002598- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002599 SDRAM timing
2600
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002601- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002602 periodic timer for refresh
2603
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002604- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002605
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002606- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2607 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2608 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2609 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002610 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2611
2612- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002613 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2614 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002615 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2616
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002617- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2618 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002619 Machine Mode Register and Memory Periodic Timer
2620 Prescaler definitions (SDRAM timing)
2621
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002622- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002623 enable I2C microcode relocation patch (MPC8xx);
2624 define relocation offset in DPRAM [DSP2]
2625
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002626- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002627 enable SMC microcode relocation patch (MPC8xx);
2628 define relocation offset in DPRAM [SMC1]
2629
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002630- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002631 enable SPI microcode relocation patch (MPC8xx);
2632 define relocation offset in DPRAM [SCC4]
2633
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002634- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002635 Use OSCM clock mode on MBX8xx board. Be careful,
2636 wrong setting might damage your board. Read
2637 doc/README.MBX before setting this variable!
2638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002639- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002640 Offset of the bootmode word in DPRAM used by post
2641 (Power On Self Tests). This definition overrides
2642 #define'd default value in commproc.h resp.
2643 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002644
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002645- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2646 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2647 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2648 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2649 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2650 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2651 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2652 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
wdenk5d232d02003-05-22 22:52:13 +00002653 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2654
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002655- CONFIG_PCI_DISABLE_PCIE:
2656 Disable PCI-Express on systems where it is supported but not
2657 required.
2658
Ben Warrenbb99ad62006-09-07 16:50:54 -04002659- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002660 Get DDR timing information from an I2C EEPROM. Common
2661 with pluggable memory modules such as SODIMMs
2662
Ben Warrenbb99ad62006-09-07 16:50:54 -04002663 SPD_EEPROM_ADDRESS
2664 I2C address of the SPD EEPROM
2665
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002666- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002667 If SPD EEPROM is on an I2C bus other than the first
2668 one, specify here. Note that the value must resolve
2669 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002670
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002671- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002672 Only for 83xx systems. If specified, then DDR should
2673 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002674
wdenkc26e4542004-04-18 10:13:26 +00002675- CONFIG_ETHER_ON_FEC[12]
2676 Define to enable FEC[12] on a 8xx series processor.
2677
2678- CONFIG_FEC[12]_PHY
2679 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002680 to the given FEC; i. e.
2681 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002682 means that the PHY with address 4 is connected to FEC1
2683
2684 When set to -1, means to probe for first available.
2685
2686- CONFIG_FEC[12]_PHY_NORXERR
2687 The PHY does not have a RXERR line (RMII only).
2688 (so program the FEC to ignore it).
2689
2690- CONFIG_RMII
2691 Enable RMII mode for all FECs.
2692 Note that this is a global option, we can't
2693 have one FEC in standard MII mode and another in RMII mode.
2694
wdenk5cf91d62004-04-23 20:32:05 +00002695- CONFIG_CRC32_VERIFY
2696 Add a verify option to the crc32 command.
2697 The syntax is:
2698
2699 => crc32 -v <address> <count> <crc32>
2700
2701 Where address/count indicate a memory area
2702 and crc32 is the correct crc32 which the
2703 area should have.
2704
wdenk56523f12004-07-11 17:40:54 +00002705- CONFIG_LOOPW
2706 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002707 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002708
stroese7b466642004-12-16 18:46:55 +00002709- CONFIG_MX_CYCLIC
2710 Add the "mdc" and "mwc" memory commands. These are cyclic
2711 "md/mw" commands.
2712 Examples:
2713
wdenkefe2a4d2004-12-16 21:44:03 +00002714 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002715 This command will print 4 bytes (10,11,12,13) each 500 ms.
2716
wdenkefe2a4d2004-12-16 21:44:03 +00002717 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002718 This command will write 12345678 to address 100 all 10 ms.
2719
wdenkefe2a4d2004-12-16 21:44:03 +00002720 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002721 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002722
wdenk8aa1a2d2005-04-04 12:44:11 +00002723- CONFIG_SKIP_LOWLEVEL_INIT
2724- CONFIG_SKIP_RELOCATE_UBOOT
2725
wdenk3c2b3d42005-04-05 23:32:21 +00002726 [ARM only] If these variables are defined, then
2727 certain low level initializations (like setting up
2728 the memory controller) are omitted and/or U-Boot does
2729 not relocate itself into RAM.
2730 Normally these variables MUST NOT be defined. The
2731 only exception is when U-Boot is loaded (to RAM) by
2732 some other boot loader or by a debugger which
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002733 performs these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002734
Magnus Liljadf812382009-06-13 20:50:00 +02002735- CONFIG_PRELOADER
2736
2737 Modifies the behaviour of start.S when compiling a loader
2738 that is executed before the actual U-Boot. E.g. when
2739 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002740
wdenkc6097192002-11-03 00:24:07 +00002741Building the Software:
2742======================
2743
Wolfgang Denk218ca722008-03-26 10:40:12 +01002744Building U-Boot has been tested in several native build environments
2745and in many different cross environments. Of course we cannot support
2746all possibly existing versions of cross development tools in all
2747(potentially obsolete) versions. In case of tool chain problems we
2748recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2749which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002750
Wolfgang Denk218ca722008-03-26 10:40:12 +01002751If you are not using a native environment, it is assumed that you
2752have GNU cross compiling tools available in your path. In this case,
2753you must set the environment variable CROSS_COMPILE in your shell.
2754Note that no changes to the Makefile or any other source files are
2755necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002756
Wolfgang Denk218ca722008-03-26 10:40:12 +01002757 $ CROSS_COMPILE=ppc_4xx-
2758 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002759
Peter Tyser2f8d3962009-03-13 18:54:51 -05002760Note: If you wish to generate Windows versions of the utilities in
2761 the tools directory you can use the MinGW toolchain
2762 (http://www.mingw.org). Set your HOST tools to the MinGW
2763 toolchain and execute 'make tools'. For example:
2764
2765 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2766
2767 Binaries such as tools/mkimage.exe will be created which can
2768 be executed on computers running Windows.
2769
Wolfgang Denk218ca722008-03-26 10:40:12 +01002770U-Boot is intended to be simple to build. After installing the
2771sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002772is done by typing:
2773
2774 make NAME_config
2775
Wolfgang Denk218ca722008-03-26 10:40:12 +01002776where "NAME_config" is the name of one of the existing configu-
2777rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002778
wdenk2729af92004-05-03 20:45:30 +00002779Note: for some board special configuration names may exist; check if
2780 additional information is available from the board vendor; for
2781 instance, the TQM823L systems are available without (standard)
2782 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002783 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002784
wdenk2729af92004-05-03 20:45:30 +00002785 make TQM823L_config
2786 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002787
wdenk2729af92004-05-03 20:45:30 +00002788 make TQM823L_LCD_config
2789 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002790
wdenk2729af92004-05-03 20:45:30 +00002791 etc.
wdenkc6097192002-11-03 00:24:07 +00002792
wdenkc6097192002-11-03 00:24:07 +00002793
wdenk2729af92004-05-03 20:45:30 +00002794Finally, type "make all", and you should get some working U-Boot
2795images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002796
wdenk2729af92004-05-03 20:45:30 +00002797- "u-boot.bin" is a raw binary image
2798- "u-boot" is an image in ELF binary format
2799- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002800
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002801By default the build is performed locally and the objects are saved
2802in the source directory. One of the two methods can be used to change
2803this behavior and build U-Boot to some external directory:
2804
28051. Add O= to the make command line invocations:
2806
2807 make O=/tmp/build distclean
2808 make O=/tmp/build NAME_config
2809 make O=/tmp/build all
2810
28112. Set environment variable BUILD_DIR to point to the desired location:
2812
2813 export BUILD_DIR=/tmp/build
2814 make distclean
2815 make NAME_config
2816 make all
2817
2818Note that the command line "O=" setting overrides the BUILD_DIR environment
2819variable.
2820
wdenkc6097192002-11-03 00:24:07 +00002821
wdenk2729af92004-05-03 20:45:30 +00002822Please be aware that the Makefiles assume you are using GNU make, so
2823for instance on NetBSD you might need to use "gmake" instead of
2824native "make".
wdenkc6097192002-11-03 00:24:07 +00002825
wdenkc6097192002-11-03 00:24:07 +00002826
wdenk2729af92004-05-03 20:45:30 +00002827If the system board that you have is not listed, then you will need
2828to port U-Boot to your hardware platform. To do this, follow these
2829steps:
wdenkc6097192002-11-03 00:24:07 +00002830
wdenk2729af92004-05-03 20:45:30 +000028311. Add a new configuration option for your board to the toplevel
2832 "Makefile" and to the "MAKEALL" script, using the existing
2833 entries as examples. Note that here and at many other places
2834 boards and other names are listed in alphabetical sort order. Please
2835 keep this order.
28362. Create a new directory to hold your board specific code. Add any
2837 files you need. In your board directory, you will need at least
2838 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
28393. Create a new configuration file "include/configs/<board>.h" for
2840 your board
28413. If you're porting U-Boot to a new CPU, then also create a new
2842 directory to hold your CPU specific code. Add any files you need.
28434. Run "make <board>_config" with your new name.
28445. Type "make", and you should get a working "u-boot.srec" file
2845 to be installed on your target system.
28466. Debug and solve any problems that might arise.
2847 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002848
wdenkc6097192002-11-03 00:24:07 +00002849
wdenk2729af92004-05-03 20:45:30 +00002850Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2851==============================================================
wdenkc6097192002-11-03 00:24:07 +00002852
Wolfgang Denk218ca722008-03-26 10:40:12 +01002853If you have modified U-Boot sources (for instance added a new board
2854or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002855provide feedback to the other developers. The feedback normally takes
2856the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01002857official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002858
Wolfgang Denk218ca722008-03-26 10:40:12 +01002859But before you submit such a patch, please verify that your modifi-
2860cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00002861the supported boards compile WITHOUT ANY compiler warnings. To do so,
2862just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01002863for ALL supported system. Be warned, this will take a while. You can
2864select which (cross) compiler to use by passing a `CROSS_COMPILE'
2865environment variable to the script, i. e. to use the ELDK cross tools
2866you can type
wdenkc6097192002-11-03 00:24:07 +00002867
wdenk2729af92004-05-03 20:45:30 +00002868 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002869
wdenk2729af92004-05-03 20:45:30 +00002870or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002871
wdenk2729af92004-05-03 20:45:30 +00002872 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002873
Wolfgang Denk218ca722008-03-26 10:40:12 +01002874When using the MAKEALL script, the default behaviour is to build
2875U-Boot in the source directory. This location can be changed by
2876setting the BUILD_DIR environment variable. Also, for each target
2877built, the MAKEALL script saves two log files (<target>.ERR and
2878<target>.MAKEALL) in the <source dir>/LOG directory. This default
2879location can be changed by setting the MAKEALL_LOGDIR environment
2880variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002881
2882 export BUILD_DIR=/tmp/build
2883 export MAKEALL_LOGDIR=/tmp/log
2884 CROSS_COMPILE=ppc_8xx- MAKEALL
2885
Wolfgang Denk218ca722008-03-26 10:40:12 +01002886With the above settings build objects are saved in the /tmp/build,
2887log files are saved in the /tmp/log and the source tree remains clean
2888during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002889
2890
wdenk2729af92004-05-03 20:45:30 +00002891See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002892
wdenkc6097192002-11-03 00:24:07 +00002893
wdenk2729af92004-05-03 20:45:30 +00002894Monitor Commands - Overview:
2895============================
wdenkc6097192002-11-03 00:24:07 +00002896
wdenk2729af92004-05-03 20:45:30 +00002897go - start application at address 'addr'
2898run - run commands in an environment variable
2899bootm - boot application image from memory
2900bootp - boot image via network using BootP/TFTP protocol
2901tftpboot- boot image via network using TFTP protocol
2902 and env variables "ipaddr" and "serverip"
2903 (and eventually "gatewayip")
2904rarpboot- boot image via network using RARP/TFTP protocol
2905diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2906loads - load S-Record file over serial line
2907loadb - load binary file over serial line (kermit mode)
2908md - memory display
2909mm - memory modify (auto-incrementing)
2910nm - memory modify (constant address)
2911mw - memory write (fill)
2912cp - memory copy
2913cmp - memory compare
2914crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05002915i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00002916sspi - SPI utility commands
2917base - print or set address offset
2918printenv- print environment variables
2919setenv - set environment variables
2920saveenv - save environment variables to persistent storage
2921protect - enable or disable FLASH write protection
2922erase - erase FLASH memory
2923flinfo - print FLASH memory information
2924bdinfo - print Board Info structure
2925iminfo - print header information for application image
2926coninfo - print console devices and informations
2927ide - IDE sub-system
2928loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002929loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002930mtest - simple RAM test
2931icache - enable or disable instruction cache
2932dcache - enable or disable data cache
2933reset - Perform RESET of the CPU
2934echo - echo args to console
2935version - print monitor version
2936help - print online help
2937? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002938
wdenkc6097192002-11-03 00:24:07 +00002939
wdenk2729af92004-05-03 20:45:30 +00002940Monitor Commands - Detailed Description:
2941========================================
wdenkc6097192002-11-03 00:24:07 +00002942
wdenk2729af92004-05-03 20:45:30 +00002943TODO.
wdenkc6097192002-11-03 00:24:07 +00002944
wdenk2729af92004-05-03 20:45:30 +00002945For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002946
2947
wdenk2729af92004-05-03 20:45:30 +00002948Environment Variables:
2949======================
wdenkc6097192002-11-03 00:24:07 +00002950
wdenk2729af92004-05-03 20:45:30 +00002951U-Boot supports user configuration using Environment Variables which
2952can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002953
wdenk2729af92004-05-03 20:45:30 +00002954Environment Variables are set using "setenv", printed using
2955"printenv", and saved to Flash using "saveenv". Using "setenv"
2956without a value can be used to delete a variable from the
2957environment. As long as you don't save the environment you are
2958working with an in-memory copy. In case the Flash area containing the
2959environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002960
wdenk2729af92004-05-03 20:45:30 +00002961Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002962
wdenk2729af92004-05-03 20:45:30 +00002963 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002964
wdenk2729af92004-05-03 20:45:30 +00002965 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002966
wdenk2729af92004-05-03 20:45:30 +00002967 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002968
wdenk2729af92004-05-03 20:45:30 +00002969 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002970
wdenk2729af92004-05-03 20:45:30 +00002971 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002972
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002973 bootm_low - Memory range available for image processing in the bootm
2974 command can be restricted. This variable is given as
2975 a hexadecimal number and defines lowest address allowed
2976 for use by the bootm command. See also "bootm_size"
2977 environment variable. Address defined by "bootm_low" is
2978 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002979 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002980
2981 bootm_size - Memory range available for image processing in the bootm
2982 command can be restricted. This variable is given as
2983 a hexadecimal number and defines the size of the region
2984 allowed for use by the bootm command. See also "bootm_low"
2985 environment variable.
2986
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02002987 updatefile - Location of the software update file on a TFTP server, used
2988 by the automatic software update feature. Please refer to
2989 documentation in doc/README.update for more details.
2990
wdenk2729af92004-05-03 20:45:30 +00002991 autoload - if set to "no" (any string beginning with 'n'),
2992 "bootp" will just load perform a lookup of the
2993 configuration from the BOOTP server, but not try to
2994 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002995
Marian Balakowicz3310c542008-03-12 12:13:13 +01002996 autoscript - if set to "yes" commands like "loadb", "loady",
2997 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
2998 to automatically run script images (by internally
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002999 calling "source").
Marian Balakowicz3310c542008-03-12 12:13:13 +01003000
3001 autoscript_uname - if script image is in a format (FIT) this
3002 variable is used to get script subimage unit name.
3003
wdenk2729af92004-05-03 20:45:30 +00003004 autostart - if set to "yes", an image loaded using the "bootp",
3005 "rarpboot", "tftpboot" or "diskboot" commands will
3006 be automatically started (by internally calling
3007 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003008
wdenk2729af92004-05-03 20:45:30 +00003009 If set to "no", a standalone image passed to the
3010 "bootm" command will be copied to the load address
3011 (and eventually uncompressed), but NOT be started.
3012 This can be used to load and uncompress arbitrary
3013 data.
wdenkc6097192002-11-03 00:24:07 +00003014
wdenk17ea1172004-06-06 21:51:03 +00003015 i2cfast - (PPC405GP|PPC405EP only)
3016 if set to 'y' configures Linux I2C driver for fast
3017 mode (400kHZ). This environment variable is used in
3018 initialization code. So, for changes to be effective
3019 it must be saved and board must be reset.
3020
wdenk2729af92004-05-03 20:45:30 +00003021 initrd_high - restrict positioning of initrd images:
3022 If this variable is not set, initrd images will be
3023 copied to the highest possible address in RAM; this
3024 is usually what you want since it allows for
3025 maximum initrd size. If for some reason you want to
3026 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003027 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003028 variable to a value of "no" or "off" or "0".
3029 Alternatively, you can set it to a maximum upper
3030 address to use (U-Boot will still check that it
3031 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003032
wdenk2729af92004-05-03 20:45:30 +00003033 For instance, when you have a system with 16 MB
3034 RAM, and want to reserve 4 MB from use by Linux,
3035 you can do this by adding "mem=12M" to the value of
3036 the "bootargs" variable. However, now you must make
3037 sure that the initrd image is placed in the first
3038 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003039
wdenk2729af92004-05-03 20:45:30 +00003040 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003041
wdenk2729af92004-05-03 20:45:30 +00003042 If you set initrd_high to 0xFFFFFFFF, this is an
3043 indication to U-Boot that all addresses are legal
3044 for the Linux kernel, including addresses in flash
3045 memory. In this case U-Boot will NOT COPY the
3046 ramdisk at all. This may be useful to reduce the
3047 boot time on your system, but requires that this
3048 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003049
wdenk2729af92004-05-03 20:45:30 +00003050 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003051
wdenk2729af92004-05-03 20:45:30 +00003052 loadaddr - Default load address for commands like "bootp",
3053 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003054
wdenk2729af92004-05-03 20:45:30 +00003055 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003056
wdenk2729af92004-05-03 20:45:30 +00003057 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003058
wdenk2729af92004-05-03 20:45:30 +00003059 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003060
wdenk2729af92004-05-03 20:45:30 +00003061 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003062
wdenk2729af92004-05-03 20:45:30 +00003063 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003064
wdenk2729af92004-05-03 20:45:30 +00003065 ethprime - When CONFIG_NET_MULTI is enabled controls which
3066 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003067
wdenk2729af92004-05-03 20:45:30 +00003068 ethact - When CONFIG_NET_MULTI is enabled controls which
3069 interface is currently active. For example you
3070 can do the following
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072 => setenv ethact FEC ETHERNET
3073 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3074 => setenv ethact SCC ETHERNET
3075 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00003076
Matthias Fuchse1692572008-01-17 07:45:05 +01003077 ethrotate - When set to "no" U-Boot does not go through all
3078 available network interfaces.
3079 It just stays at the currently selected interface.
3080
wdenk2729af92004-05-03 20:45:30 +00003081 netretry - When set to "no" each network operation will
3082 either succeed or fail without retrying.
3083 When set to "once" the network operation will
3084 fail when all the available network interfaces
3085 are tried once without success.
3086 Useful on scripts which control the retry operation
3087 themselves.
wdenkc6097192002-11-03 00:24:07 +00003088
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003089 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003090
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003091 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003092 UDP source port.
3093
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003094 tftpdstport - If this is set, the value is used for TFTP's UDP
3095 destination port instead of the Well Know Port 69.
3096
wdenk2729af92004-05-03 20:45:30 +00003097 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003098 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003099 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003100
wdenk2729af92004-05-03 20:45:30 +00003101The following environment variables may be used and automatically
3102updated by the network boot commands ("bootp" and "rarpboot"),
3103depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003104
wdenk2729af92004-05-03 20:45:30 +00003105 bootfile - see above
3106 dnsip - IP address of your Domain Name Server
3107 dnsip2 - IP address of your secondary Domain Name Server
3108 gatewayip - IP address of the Gateway (Router) to use
3109 hostname - Target hostname
3110 ipaddr - see above
3111 netmask - Subnet Mask
3112 rootpath - Pathname of the root filesystem on the NFS server
3113 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003114
wdenka3d991b2004-04-15 21:48:45 +00003115
wdenk2729af92004-05-03 20:45:30 +00003116There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003117
wdenk2729af92004-05-03 20:45:30 +00003118 serial# - contains hardware identification information such
3119 as type string and/or serial number
3120 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003121
wdenk2729af92004-05-03 20:45:30 +00003122These variables can be set only once (usually during manufacturing of
3123the board). U-Boot refuses to delete or overwrite these variables
3124once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003125
3126
wdenk2729af92004-05-03 20:45:30 +00003127Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003128
wdenk2729af92004-05-03 20:45:30 +00003129 ver - Contains the U-Boot version string as printed
3130 with the "version" command. This variable is
3131 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003132
wdenkc6097192002-11-03 00:24:07 +00003133
wdenk2729af92004-05-03 20:45:30 +00003134Please note that changes to some configuration parameters may take
3135only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003136
stroesec1551ea2003-04-04 15:53:41 +00003137
wdenk2729af92004-05-03 20:45:30 +00003138Command Line Parsing:
3139=====================
stroesec1551ea2003-04-04 15:53:41 +00003140
wdenk2729af92004-05-03 20:45:30 +00003141There are two different command line parsers available with U-Boot:
3142the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003143
wdenk2729af92004-05-03 20:45:30 +00003144Old, simple command line parser:
3145--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003146
wdenk2729af92004-05-03 20:45:30 +00003147- supports environment variables (through setenv / saveenv commands)
3148- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003149- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003150- special characters ('$', ';') can be escaped by prefixing with '\',
3151 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003152 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003153- You can also escape text by enclosing in single apostrophes, for example:
3154 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003155
wdenk2729af92004-05-03 20:45:30 +00003156Hush shell:
3157-----------
wdenkf07771c2003-05-28 08:06:31 +00003158
wdenk2729af92004-05-03 20:45:30 +00003159- similar to Bourne shell, with control structures like
3160 if...then...else...fi, for...do...done; while...do...done,
3161 until...do...done, ...
3162- supports environment ("global") variables (through setenv / saveenv
3163 commands) and local shell variables (through standard shell syntax
3164 "name=value"); only environment variables can be used with "run"
3165 command
wdenkf07771c2003-05-28 08:06:31 +00003166
wdenk2729af92004-05-03 20:45:30 +00003167General rules:
3168--------------
wdenkf07771c2003-05-28 08:06:31 +00003169
wdenk2729af92004-05-03 20:45:30 +00003170(1) If a command line (or an environment variable executed by a "run"
3171 command) contains several commands separated by semicolon, and
3172 one of these commands fails, then the remaining commands will be
3173 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003174
wdenk2729af92004-05-03 20:45:30 +00003175(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003176 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003177 command will cause "run" to terminate, i. e. the remaining
3178 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003179
wdenk2729af92004-05-03 20:45:30 +00003180Note for Redundant Ethernet Interfaces:
3181=======================================
wdenkf07771c2003-05-28 08:06:31 +00003182
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003183Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003184such configurations and is capable of automatic selection of a
3185"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003186
wdenk2729af92004-05-03 20:45:30 +00003187Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3188MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3189"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003190
wdenk2729af92004-05-03 20:45:30 +00003191If the network interface stores some valid MAC address (for instance
3192in SROM), this is used as default address if there is NO correspon-
3193ding setting in the environment; if the corresponding environment
3194variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003195
wdenk2729af92004-05-03 20:45:30 +00003196o If the SROM has a valid MAC address, and there is no address in the
3197 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003198
wdenk2729af92004-05-03 20:45:30 +00003199o If there is no valid address in the SROM, and a definition in the
3200 environment exists, then the value from the environment variable is
3201 used.
wdenkc6097192002-11-03 00:24:07 +00003202
wdenk2729af92004-05-03 20:45:30 +00003203o If both the SROM and the environment contain a MAC address, and
3204 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003205
wdenk2729af92004-05-03 20:45:30 +00003206o If both the SROM and the environment contain a MAC address, and the
3207 addresses differ, the value from the environment is used and a
3208 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003209
wdenk2729af92004-05-03 20:45:30 +00003210o If neither SROM nor the environment contain a MAC address, an error
3211 is raised.
wdenkc6097192002-11-03 00:24:07 +00003212
wdenkc6097192002-11-03 00:24:07 +00003213
wdenk2729af92004-05-03 20:45:30 +00003214Image Formats:
3215==============
wdenkc6097192002-11-03 00:24:07 +00003216
Marian Balakowicz3310c542008-03-12 12:13:13 +01003217U-Boot is capable of booting (and performing other auxiliary operations on)
3218images in two formats:
3219
3220New uImage format (FIT)
3221-----------------------
3222
3223Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3224to Flattened Device Tree). It allows the use of images with multiple
3225components (several kernels, ramdisks, etc.), with contents protected by
3226SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3227
3228
3229Old uImage format
3230-----------------
3231
3232Old image format is based on binary files which can be basically anything,
3233preceded by a special header; see the definitions in include/image.h for
3234details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk2729af92004-05-03 20:45:30 +00003236* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3237 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003238 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3239 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3240 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003241* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk2729af92004-05-03 20:45:30 +00003242 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003243 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003244* Compression Type (uncompressed, gzip, bzip2)
3245* Load Address
3246* Entry Point
3247* Image Name
3248* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003249
wdenk2729af92004-05-03 20:45:30 +00003250The header is marked by a special Magic Number, and both the header
3251and the data portions of the image are secured against corruption by
3252CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003253
wdenkc6097192002-11-03 00:24:07 +00003254
wdenk2729af92004-05-03 20:45:30 +00003255Linux Support:
3256==============
wdenkc6097192002-11-03 00:24:07 +00003257
wdenk2729af92004-05-03 20:45:30 +00003258Although U-Boot should support any OS or standalone application
3259easily, the main focus has always been on Linux during the design of
3260U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003261
wdenk2729af92004-05-03 20:45:30 +00003262U-Boot includes many features that so far have been part of some
3263special "boot loader" code within the Linux kernel. Also, any
3264"initrd" images to be used are no longer part of one big Linux image;
3265instead, kernel and "initrd" are separate images. This implementation
3266serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003267
wdenk2729af92004-05-03 20:45:30 +00003268- the same features can be used for other OS or standalone
3269 applications (for instance: using compressed images to reduce the
3270 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003271
wdenk2729af92004-05-03 20:45:30 +00003272- it becomes much easier to port new Linux kernel versions because
3273 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003274
wdenk2729af92004-05-03 20:45:30 +00003275- the same Linux kernel image can now be used with different "initrd"
3276 images; of course this also means that different kernel images can
3277 be run with the same "initrd". This makes testing easier (you don't
3278 have to build a new "zImage.initrd" Linux image when you just
3279 change a file in your "initrd"). Also, a field-upgrade of the
3280 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003281
wdenkc6097192002-11-03 00:24:07 +00003282
wdenk2729af92004-05-03 20:45:30 +00003283Linux HOWTO:
3284============
wdenkc6097192002-11-03 00:24:07 +00003285
wdenk2729af92004-05-03 20:45:30 +00003286Porting Linux to U-Boot based systems:
3287---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003288
wdenk2729af92004-05-03 20:45:30 +00003289U-Boot cannot save you from doing all the necessary modifications to
3290configure the Linux device drivers for use with your target hardware
3291(no, we don't intend to provide a full virtual machine interface to
3292Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003293
wdenk2729af92004-05-03 20:45:30 +00003294But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003295
wdenk2729af92004-05-03 20:45:30 +00003296Just make sure your machine specific header file (for instance
3297include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003298Information structure as we define in include/asm-<arch>/u-boot.h,
3299and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003300as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003301
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303Configuring the Linux kernel:
3304-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003305
wdenk2729af92004-05-03 20:45:30 +00003306No specific requirements for U-Boot. Make sure you have some root
3307device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003308
wdenkc6097192002-11-03 00:24:07 +00003309
wdenk2729af92004-05-03 20:45:30 +00003310Building a Linux Image:
3311-----------------------
wdenkc6097192002-11-03 00:24:07 +00003312
wdenk2729af92004-05-03 20:45:30 +00003313With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3314not used. If you use recent kernel source, a new build target
3315"uImage" will exist which automatically builds an image usable by
3316U-Boot. Most older kernels also have support for a "pImage" target,
3317which was introduced for our predecessor project PPCBoot and uses a
3318100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003319
wdenk2729af92004-05-03 20:45:30 +00003320Example:
wdenkc6097192002-11-03 00:24:07 +00003321
wdenk2729af92004-05-03 20:45:30 +00003322 make TQM850L_config
3323 make oldconfig
3324 make dep
3325 make uImage
wdenkc6097192002-11-03 00:24:07 +00003326
wdenk2729af92004-05-03 20:45:30 +00003327The "uImage" build target uses a special tool (in 'tools/mkimage') to
3328encapsulate a compressed Linux kernel image with header information,
3329CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk2729af92004-05-03 20:45:30 +00003331* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk2729af92004-05-03 20:45:30 +00003333* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003334
wdenk2729af92004-05-03 20:45:30 +00003335 ${CROSS_COMPILE}-objcopy -O binary \
3336 -R .note -R .comment \
3337 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003338
wdenk2729af92004-05-03 20:45:30 +00003339* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003340
wdenk2729af92004-05-03 20:45:30 +00003341 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003342
wdenk2729af92004-05-03 20:45:30 +00003343* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003344
wdenk2729af92004-05-03 20:45:30 +00003345 mkimage -A ppc -O linux -T kernel -C gzip \
3346 -a 0 -e 0 -n "Linux Kernel Image" \
3347 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003348
wdenk24ee89b2002-11-03 17:56:27 +00003349
wdenk2729af92004-05-03 20:45:30 +00003350The "mkimage" tool can also be used to create ramdisk images for use
3351with U-Boot, either separated from the Linux kernel image, or
3352combined into one file. "mkimage" encapsulates the images with a 64
3353byte header containing information about target architecture,
3354operating system, image type, compression method, entry points, time
3355stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003356
wdenk2729af92004-05-03 20:45:30 +00003357"mkimage" can be called in two ways: to verify existing images and
3358print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003359
wdenk2729af92004-05-03 20:45:30 +00003360In the first form (with "-l" option) mkimage lists the information
3361contained in the header of an existing U-Boot image; this includes
3362checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003363
wdenk2729af92004-05-03 20:45:30 +00003364 tools/mkimage -l image
3365 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003366
wdenk2729af92004-05-03 20:45:30 +00003367The second form (with "-d" option) is used to build a U-Boot image
3368from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003369
wdenk2729af92004-05-03 20:45:30 +00003370 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3371 -n name -d data_file image
3372 -A ==> set architecture to 'arch'
3373 -O ==> set operating system to 'os'
3374 -T ==> set image type to 'type'
3375 -C ==> set compression type 'comp'
3376 -a ==> set load address to 'addr' (hex)
3377 -e ==> set entry point to 'ep' (hex)
3378 -n ==> set image name to 'name'
3379 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003380
wdenk69459792004-05-29 16:53:29 +00003381Right now, all Linux kernels for PowerPC systems use the same load
3382address (0x00000000), but the entry point address depends on the
3383kernel version:
wdenkc6097192002-11-03 00:24:07 +00003384
wdenk2729af92004-05-03 20:45:30 +00003385- 2.2.x kernels have the entry point at 0x0000000C,
3386- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003387
wdenk2729af92004-05-03 20:45:30 +00003388So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003389
wdenk2729af92004-05-03 20:45:30 +00003390 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3391 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3392 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3393 > examples/uImage.TQM850L
3394 Image Name: 2.4.4 kernel for TQM850L
3395 Created: Wed Jul 19 02:34:59 2000
3396 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3397 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3398 Load Address: 0x00000000
3399 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003400
wdenk2729af92004-05-03 20:45:30 +00003401To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403 -> tools/mkimage -l examples/uImage.TQM850L
3404 Image Name: 2.4.4 kernel for TQM850L
3405 Created: Wed Jul 19 02:34:59 2000
3406 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3407 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3408 Load Address: 0x00000000
3409 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003410
wdenk2729af92004-05-03 20:45:30 +00003411NOTE: for embedded systems where boot time is critical you can trade
3412speed for memory and install an UNCOMPRESSED image instead: this
3413needs more space in Flash, but boots much faster since it does not
3414need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003415
wdenk2729af92004-05-03 20:45:30 +00003416 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3417 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3418 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3419 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3420 > examples/uImage.TQM850L-uncompressed
3421 Image Name: 2.4.4 kernel for TQM850L
3422 Created: Wed Jul 19 02:34:59 2000
3423 Image Type: PowerPC Linux Kernel Image (uncompressed)
3424 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3425 Load Address: 0x00000000
3426 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003427
wdenkc6097192002-11-03 00:24:07 +00003428
wdenk2729af92004-05-03 20:45:30 +00003429Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3430when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003431
wdenk2729af92004-05-03 20:45:30 +00003432 -> tools/mkimage -n 'Simple Ramdisk Image' \
3433 > -A ppc -O linux -T ramdisk -C gzip \
3434 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3435 Image Name: Simple Ramdisk Image
3436 Created: Wed Jan 12 14:01:50 2000
3437 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3438 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3439 Load Address: 0x00000000
3440 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003441
wdenkdb01a2e2004-04-15 23:14:49 +00003442
wdenk2729af92004-05-03 20:45:30 +00003443Installing a Linux Image:
3444-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003445
wdenk2729af92004-05-03 20:45:30 +00003446To downloading a U-Boot image over the serial (console) interface,
3447you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003448
wdenk2729af92004-05-03 20:45:30 +00003449 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003450
wdenk2729af92004-05-03 20:45:30 +00003451The 'objcopy' does not understand the information in the U-Boot
3452image header, so the resulting S-Record file will be relative to
3453address 0x00000000. To load it to a given address, you need to
3454specify the target address as 'offset' parameter with the 'loads'
3455command.
wdenkc6097192002-11-03 00:24:07 +00003456
wdenk2729af92004-05-03 20:45:30 +00003457Example: install the image to address 0x40100000 (which on the
3458TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003459
wdenk2729af92004-05-03 20:45:30 +00003460 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003461
wdenk2729af92004-05-03 20:45:30 +00003462 .......... done
3463 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003464
wdenk2729af92004-05-03 20:45:30 +00003465 => loads 40100000
3466 ## Ready for S-Record download ...
3467 ~>examples/image.srec
3468 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3469 ...
3470 15989 15990 15991 15992
3471 [file transfer complete]
3472 [connected]
3473 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003474
3475
wdenk2729af92004-05-03 20:45:30 +00003476You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003477this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003478corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk2729af92004-05-03 20:45:30 +00003480 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk2729af92004-05-03 20:45:30 +00003482 ## Checking Image at 40100000 ...
3483 Image Name: 2.2.13 for initrd on TQM850L
3484 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3485 Data Size: 335725 Bytes = 327 kB = 0 MB
3486 Load Address: 00000000
3487 Entry Point: 0000000c
3488 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003489
3490
wdenk2729af92004-05-03 20:45:30 +00003491Boot Linux:
3492-----------
wdenkc6097192002-11-03 00:24:07 +00003493
wdenk2729af92004-05-03 20:45:30 +00003494The "bootm" command is used to boot an application that is stored in
3495memory (RAM or Flash). In case of a Linux kernel image, the contents
3496of the "bootargs" environment variable is passed to the kernel as
3497parameters. You can check and modify this variable using the
3498"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003499
3500
wdenk2729af92004-05-03 20:45:30 +00003501 => printenv bootargs
3502 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504 => 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 +00003505
wdenk2729af92004-05-03 20:45:30 +00003506 => printenv bootargs
3507 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 +00003508
wdenk2729af92004-05-03 20:45:30 +00003509 => bootm 40020000
3510 ## Booting Linux kernel at 40020000 ...
3511 Image Name: 2.2.13 for NFS on TQM850L
3512 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3513 Data Size: 381681 Bytes = 372 kB = 0 MB
3514 Load Address: 00000000
3515 Entry Point: 0000000c
3516 Verifying Checksum ... OK
3517 Uncompressing Kernel Image ... OK
3518 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
3519 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3520 time_init: decrementer frequency = 187500000/60
3521 Calibrating delay loop... 49.77 BogoMIPS
3522 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3523 ...
wdenkc6097192002-11-03 00:24:07 +00003524
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003525If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003526the memory addresses of both the kernel and the initrd image (PPBCOOT
3527format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003528
wdenk2729af92004-05-03 20:45:30 +00003529 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003530
wdenk2729af92004-05-03 20:45:30 +00003531 ## Checking Image at 40100000 ...
3532 Image Name: 2.2.13 for initrd on TQM850L
3533 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3534 Data Size: 335725 Bytes = 327 kB = 0 MB
3535 Load Address: 00000000
3536 Entry Point: 0000000c
3537 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk2729af92004-05-03 20:45:30 +00003539 ## Checking Image at 40200000 ...
3540 Image Name: Simple Ramdisk Image
3541 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3542 Data Size: 566530 Bytes = 553 kB = 0 MB
3543 Load Address: 00000000
3544 Entry Point: 00000000
3545 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003546
wdenk2729af92004-05-03 20:45:30 +00003547 => bootm 40100000 40200000
3548 ## Booting Linux kernel at 40100000 ...
3549 Image Name: 2.2.13 for initrd on TQM850L
3550 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3551 Data Size: 335725 Bytes = 327 kB = 0 MB
3552 Load Address: 00000000
3553 Entry Point: 0000000c
3554 Verifying Checksum ... OK
3555 Uncompressing Kernel Image ... OK
3556 ## Loading RAMDisk Image at 40200000 ...
3557 Image Name: Simple Ramdisk Image
3558 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3559 Data Size: 566530 Bytes = 553 kB = 0 MB
3560 Load Address: 00000000
3561 Entry Point: 00000000
3562 Verifying Checksum ... OK
3563 Loading Ramdisk ... OK
3564 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
3565 Boot arguments: root=/dev/ram
3566 time_init: decrementer frequency = 187500000/60
3567 Calibrating delay loop... 49.77 BogoMIPS
3568 ...
3569 RAMDISK: Compressed image found at block 0
3570 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003571
wdenk2729af92004-05-03 20:45:30 +00003572 bash#
wdenkc6097192002-11-03 00:24:07 +00003573
Matthew McClintock02677682006-06-28 10:41:37 -05003574Boot Linux and pass a flat device tree:
3575-----------
3576
3577First, U-Boot must be compiled with the appropriate defines. See the section
3578titled "Linux Kernel Interface" above for a more in depth explanation. The
3579following is an example of how to start a kernel and pass an updated
3580flat device tree:
3581
3582=> print oftaddr
3583oftaddr=0x300000
3584=> print oft
3585oft=oftrees/mpc8540ads.dtb
3586=> tftp $oftaddr $oft
3587Speed: 1000, full duplex
3588Using TSEC0 device
3589TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3590Filename 'oftrees/mpc8540ads.dtb'.
3591Load address: 0x300000
3592Loading: #
3593done
3594Bytes transferred = 4106 (100a hex)
3595=> tftp $loadaddr $bootfile
3596Speed: 1000, full duplex
3597Using TSEC0 device
3598TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3599Filename 'uImage'.
3600Load address: 0x200000
3601Loading:############
3602done
3603Bytes transferred = 1029407 (fb51f hex)
3604=> print loadaddr
3605loadaddr=200000
3606=> print oftaddr
3607oftaddr=0x300000
3608=> bootm $loadaddr - $oftaddr
3609## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003610 Image Name: Linux-2.6.17-dirty
3611 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3612 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003613 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003614 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003615 Verifying Checksum ... OK
3616 Uncompressing Kernel Image ... OK
3617Booting using flat device tree at 0x300000
3618Using MPC85xx ADS machine description
3619Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3620[snip]
3621
3622
wdenk2729af92004-05-03 20:45:30 +00003623More About U-Boot Image Types:
3624------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003625
wdenk2729af92004-05-03 20:45:30 +00003626U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003627
wdenk2729af92004-05-03 20:45:30 +00003628 "Standalone Programs" are directly runnable in the environment
3629 provided by U-Boot; it is expected that (if they behave
3630 well) you can continue to work in U-Boot after return from
3631 the Standalone Program.
3632 "OS Kernel Images" are usually images of some Embedded OS which
3633 will take over control completely. Usually these programs
3634 will install their own set of exception handlers, device
3635 drivers, set up the MMU, etc. - this means, that you cannot
3636 expect to re-enter U-Boot except by resetting the CPU.
3637 "RAMDisk Images" are more or less just data blocks, and their
3638 parameters (address, size) are passed to an OS kernel that is
3639 being started.
3640 "Multi-File Images" contain several images, typically an OS
3641 (Linux) kernel image and one or more data images like
3642 RAMDisks. This construct is useful for instance when you want
3643 to boot over the network using BOOTP etc., where the boot
3644 server provides just a single image file, but you want to get
3645 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003646
wdenk2729af92004-05-03 20:45:30 +00003647 "Multi-File Images" start with a list of image sizes, each
3648 image size (in bytes) specified by an "uint32_t" in network
3649 byte order. This list is terminated by an "(uint32_t)0".
3650 Immediately after the terminating 0 follow the images, one by
3651 one, all aligned on "uint32_t" boundaries (size rounded up to
3652 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003653
wdenk2729af92004-05-03 20:45:30 +00003654 "Firmware Images" are binary images containing firmware (like
3655 U-Boot or FPGA images) which usually will be programmed to
3656 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003657
wdenk2729af92004-05-03 20:45:30 +00003658 "Script files" are command sequences that will be executed by
3659 U-Boot's command interpreter; this feature is especially
3660 useful when you configure U-Boot to use a real shell (hush)
3661 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003662
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk2729af92004-05-03 20:45:30 +00003664Standalone HOWTO:
3665=================
wdenkc6097192002-11-03 00:24:07 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667One of the features of U-Boot is that you can dynamically load and
3668run "standalone" applications, which can use some resources of
3669U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003670
wdenk2729af92004-05-03 20:45:30 +00003671Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003672
wdenk2729af92004-05-03 20:45:30 +00003673"Hello World" Demo:
3674-------------------
wdenkc6097192002-11-03 00:24:07 +00003675
wdenk2729af92004-05-03 20:45:30 +00003676'examples/hello_world.c' contains a small "Hello World" Demo
3677application; it is automatically compiled when you build U-Boot.
3678It's configured to run at address 0x00040004, so you can play with it
3679like that:
wdenkc6097192002-11-03 00:24:07 +00003680
wdenk2729af92004-05-03 20:45:30 +00003681 => loads
3682 ## Ready for S-Record download ...
3683 ~>examples/hello_world.srec
3684 1 2 3 4 5 6 7 8 9 10 11 ...
3685 [file transfer complete]
3686 [connected]
3687 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003688
wdenk2729af92004-05-03 20:45:30 +00003689 => go 40004 Hello World! This is a test.
3690 ## Starting application at 0x00040004 ...
3691 Hello World
3692 argc = 7
3693 argv[0] = "40004"
3694 argv[1] = "Hello"
3695 argv[2] = "World!"
3696 argv[3] = "This"
3697 argv[4] = "is"
3698 argv[5] = "a"
3699 argv[6] = "test."
3700 argv[7] = "<NULL>"
3701 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk2729af92004-05-03 20:45:30 +00003703 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003704
wdenk2729af92004-05-03 20:45:30 +00003705Another example, which demonstrates how to register a CPM interrupt
3706handler with the U-Boot code, can be found in 'examples/timer.c'.
3707Here, a CPM timer is set up to generate an interrupt every second.
3708The interrupt service routine is trivial, just printing a '.'
3709character, but this is just a demo program. The application can be
3710controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003711
wdenk2729af92004-05-03 20:45:30 +00003712 ? - print current values og the CPM Timer registers
3713 b - enable interrupts and start timer
3714 e - stop timer and disable interrupts
3715 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003716
wdenk2729af92004-05-03 20:45:30 +00003717 => loads
3718 ## Ready for S-Record download ...
3719 ~>examples/timer.srec
3720 1 2 3 4 5 6 7 8 9 10 11 ...
3721 [file transfer complete]
3722 [connected]
3723 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003724
wdenk2729af92004-05-03 20:45:30 +00003725 => go 40004
3726 ## Starting application at 0x00040004 ...
3727 TIMERS=0xfff00980
3728 Using timer 1
3729 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003730
wdenk2729af92004-05-03 20:45:30 +00003731Hit 'b':
3732 [q, b, e, ?] Set interval 1000000 us
3733 Enabling timer
3734Hit '?':
3735 [q, b, e, ?] ........
3736 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3737Hit '?':
3738 [q, b, e, ?] .
3739 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3740Hit '?':
3741 [q, b, e, ?] .
3742 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3743Hit '?':
3744 [q, b, e, ?] .
3745 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3746Hit 'e':
3747 [q, b, e, ?] ...Stopping timer
3748Hit 'q':
3749 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003750
3751
wdenk2729af92004-05-03 20:45:30 +00003752Minicom warning:
3753================
wdenk85ec0bc2003-03-31 16:34:49 +00003754
wdenk2729af92004-05-03 20:45:30 +00003755Over time, many people have reported problems when trying to use the
3756"minicom" terminal emulation program for serial download. I (wd)
3757consider minicom to be broken, and recommend not to use it. Under
3758Unix, I recommend to use C-Kermit for general purpose use (and
3759especially for kermit binary protocol download ("loadb" command), and
3760use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003761
wdenk2729af92004-05-03 20:45:30 +00003762Nevertheless, if you absolutely want to use it try adding this
3763configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003764
wdenk2729af92004-05-03 20:45:30 +00003765 Name Program Name U/D FullScr IO-Red. Multi
3766 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3767 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003768
3769
wdenk2729af92004-05-03 20:45:30 +00003770NetBSD Notes:
3771=============
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773Starting at version 0.9.2, U-Boot supports NetBSD both as host
3774(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776Building requires a cross environment; it is known to work on
3777NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3778need gmake since the Makefiles are not compatible with BSD make).
3779Note that the cross-powerpc package does not install include files;
3780attempting to build U-Boot will fail because <machine/ansi.h> is
3781missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003782
wdenk2729af92004-05-03 20:45:30 +00003783 # cd /usr/pkg/cross/powerpc-netbsd/include
3784 # mkdir powerpc
3785 # ln -s powerpc machine
3786 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3787 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003788
wdenk2729af92004-05-03 20:45:30 +00003789Native builds *don't* work due to incompatibilities between native
3790and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003791
wdenk2729af92004-05-03 20:45:30 +00003792Booting assumes that (the first part of) the image booted is a
3793stage-2 loader which in turn loads and then invokes the kernel
3794proper. Loader sources will eventually appear in the NetBSD source
3795tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003796meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003797
3798
wdenk2729af92004-05-03 20:45:30 +00003799Implementation Internals:
3800=========================
wdenkc6097192002-11-03 00:24:07 +00003801
wdenk2729af92004-05-03 20:45:30 +00003802The following is not intended to be a complete description of every
3803implementation detail. However, it should help to understand the
3804inner workings of U-Boot and make it easier to port it to custom
3805hardware.
wdenkc6097192002-11-03 00:24:07 +00003806
3807
wdenk2729af92004-05-03 20:45:30 +00003808Initial Stack, Global Data:
3809---------------------------
wdenkc6097192002-11-03 00:24:07 +00003810
wdenk2729af92004-05-03 20:45:30 +00003811The implementation of U-Boot is complicated by the fact that U-Boot
3812starts running out of ROM (flash memory), usually without access to
3813system RAM (because the memory controller is not initialized yet).
3814This means that we don't have writable Data or BSS segments, and BSS
3815is not initialized as zero. To be able to get a C environment working
3816at all, we have to allocate at least a minimal stack. Implementation
3817options for this are defined and restricted by the CPU used: Some CPU
3818models provide on-chip memory (like the IMMR area on MPC8xx and
3819MPC826x processors), on others (parts of) the data cache can be
3820locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003821
Wolfgang Denk218ca722008-03-26 10:40:12 +01003822 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01003823 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00003824
wdenk2729af92004-05-03 20:45:30 +00003825 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3826 From: "Chris Hallinan" <clh@net1plus.com>
3827 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3828 ...
wdenk43d96162003-03-06 00:02:04 +00003829
wdenk2729af92004-05-03 20:45:30 +00003830 Correct me if I'm wrong, folks, but the way I understand it
3831 is this: Using DCACHE as initial RAM for Stack, etc, does not
3832 require any physical RAM backing up the cache. The cleverness
3833 is that the cache is being used as a temporary supply of
3834 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003835 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00003836 can see how this works by studying the cache architecture and
3837 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003838
wdenk2729af92004-05-03 20:45:30 +00003839 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3840 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003841 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00003842 option should work for you. Using CS 4 should be fine if your
3843 board designers haven't used it for something that would
3844 cause you grief during the initial boot! It is frequently not
3845 used.
wdenk43d96162003-03-06 00:02:04 +00003846
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003847 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00003848 with your processor/board/system design. The default value
3849 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003850 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003851 than your SDRAM module. If you have a 64MB SDRAM module, set
3852 it above 400_0000. Just make sure your board has no resources
3853 that are supposed to respond to that address! That code in
3854 start.S has been around a while and should work as is when
3855 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003856
wdenk2729af92004-05-03 20:45:30 +00003857 -Chris Hallinan
3858 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003859
wdenk2729af92004-05-03 20:45:30 +00003860It is essential to remember this, since it has some impact on the C
3861code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003862
wdenk2729af92004-05-03 20:45:30 +00003863* Initialized global data (data segment) is read-only. Do not attempt
3864 to write it.
wdenkc6097192002-11-03 00:24:07 +00003865
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003866* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00003867 as zero data - BSS segment) at all - this is undefined, initiali-
3868 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003869
wdenk2729af92004-05-03 20:45:30 +00003870* Stack space is very limited. Avoid big data buffers or things like
3871 that.
wdenkc6097192002-11-03 00:24:07 +00003872
wdenk2729af92004-05-03 20:45:30 +00003873Having only the stack as writable memory limits means we cannot use
3874normal global data to share information beween the code. But it
3875turned out that the implementation of U-Boot can be greatly
3876simplified by making a global data structure (gd_t) available to all
3877functions. We could pass a pointer to this data as argument to _all_
3878functions, but this would bloat the code. Instead we use a feature of
3879the GCC compiler (Global Register Variables) to share the data: we
3880place a pointer (gd) to the global data into a register which we
3881reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk2729af92004-05-03 20:45:30 +00003883When choosing a register for such a purpose we are restricted by the
3884relevant (E)ABI specifications for the current architecture, and by
3885GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003886
wdenk2729af92004-05-03 20:45:30 +00003887For PowerPC, the following registers have specific use:
3888 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01003889 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00003890 R3-R4: parameter passing and return values
3891 R5-R10: parameter passing
3892 R13: small data area pointer
3893 R30: GOT pointer
3894 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003897
Wolfgang Denke7670f62008-02-14 22:43:22 +01003898 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003899
wdenk2729af92004-05-03 20:45:30 +00003900 Note: on PPC, we could use a static initializer (since the
3901 address of the global data structure is known at compile time),
3902 but it turned out that reserving a register results in somewhat
3903 smaller code - although the code savings are not that big (on
3904 average for all boards 752 bytes for the whole U-Boot image,
3905 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003906
Mike Frysinger4c58eb52008-02-04 19:26:54 -05003907On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3908 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3909
3910 ==> U-Boot will use P5 to hold a pointer to the global data
3911
wdenk2729af92004-05-03 20:45:30 +00003912On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003913
wdenk2729af92004-05-03 20:45:30 +00003914 R0: function argument word/integer result
3915 R1-R3: function argument word
3916 R9: GOT pointer
3917 R10: stack limit (used only if stack checking if enabled)
3918 R11: argument (frame) pointer
3919 R12: temporary workspace
3920 R13: stack pointer
3921 R14: link register
3922 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003923
wdenk2729af92004-05-03 20:45:30 +00003924 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003925
Wolfgang Denkd87080b2006-03-31 18:32:53 +02003926NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3927or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003928
wdenk2729af92004-05-03 20:45:30 +00003929Memory Management:
3930------------------
wdenkc6097192002-11-03 00:24:07 +00003931
wdenk2729af92004-05-03 20:45:30 +00003932U-Boot runs in system state and uses physical addresses, i.e. the
3933MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003934
wdenk2729af92004-05-03 20:45:30 +00003935The available memory is mapped to fixed addresses using the memory
3936controller. In this process, a contiguous block is formed for each
3937memory type (Flash, SDRAM, SRAM), even when it consists of several
3938physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003939
wdenk2729af92004-05-03 20:45:30 +00003940U-Boot is installed in the first 128 kB of the first Flash bank (on
3941TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3942booting and sizing and initializing DRAM, the code relocates itself
3943to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003944memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00003945configuration setting]. Below that, a structure with global Board
3946Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003947
wdenk2729af92004-05-03 20:45:30 +00003948Additionally, some exception handler code is copied to the low 8 kB
3949of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951So a typical memory configuration with 16 MB of DRAM could look like
3952this:
wdenkc6097192002-11-03 00:24:07 +00003953
wdenk2729af92004-05-03 20:45:30 +00003954 0x0000 0000 Exception Vector code
3955 :
3956 0x0000 1FFF
3957 0x0000 2000 Free for Application Use
3958 :
3959 :
wdenkc6097192002-11-03 00:24:07 +00003960
wdenk2729af92004-05-03 20:45:30 +00003961 :
3962 :
3963 0x00FB FF20 Monitor Stack (Growing downward)
3964 0x00FB FFAC Board Info Data and permanent copy of global data
3965 0x00FC 0000 Malloc Arena
3966 :
3967 0x00FD FFFF
3968 0x00FE 0000 RAM Copy of Monitor Code
3969 ... eventually: LCD or video framebuffer
3970 ... eventually: pRAM (Protected RAM - unchanged by reset)
3971 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003972
3973
wdenk2729af92004-05-03 20:45:30 +00003974System Initialization:
3975----------------------
wdenkc6097192002-11-03 00:24:07 +00003976
wdenk2729af92004-05-03 20:45:30 +00003977In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003978(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00003979configuration for CS0# this is a mirror of the onboard Flash memory.
3980To be able to re-map memory U-Boot then jumps to its link address.
3981To be able to implement the initialization code in C, a (small!)
3982initial stack is set up in the internal Dual Ported RAM (in case CPUs
3983which provide such a feature like MPC8xx or MPC8260), or in a locked
3984part of the data cache. After that, U-Boot initializes the CPU core,
3985the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003986
wdenk2729af92004-05-03 20:45:30 +00003987Next, all (potentially) available memory banks are mapped using a
3988preliminary mapping. For example, we put them on 512 MB boundaries
3989(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3990on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3991programmed for SDRAM access. Using the temporary configuration, a
3992simple memory test is run that determines the size of the SDRAM
3993banks.
wdenkc6097192002-11-03 00:24:07 +00003994
wdenk2729af92004-05-03 20:45:30 +00003995When there is more than one SDRAM bank, and the banks are of
3996different size, the largest is mapped first. For equal size, the first
3997bank (CS2#) is mapped first. The first mapping is always for address
39980x00000000, with any additional banks following immediately to create
3999contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004000
wdenk2729af92004-05-03 20:45:30 +00004001Then, the monitor installs itself at the upper end of the SDRAM area
4002and allocates memory for use by malloc() and for the global Board
4003Info data; also, the exception vector code is copied to the low RAM
4004pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004005
wdenk2729af92004-05-03 20:45:30 +00004006Only after this relocation will you have a "normal" C environment;
4007until that you are restricted in several ways, mostly because you are
4008running from ROM, and because the code will have to be relocated to a
4009new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004010
4011
wdenk2729af92004-05-03 20:45:30 +00004012U-Boot Porting Guide:
4013----------------------
wdenkc6097192002-11-03 00:24:07 +00004014
wdenk2729af92004-05-03 20:45:30 +00004015[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4016list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004017
4018
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004019int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004020{
4021 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004022
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004023 signal(SIGALRM, no_more_time);
4024 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004025
wdenk2729af92004-05-03 20:45:30 +00004026 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004027 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004028 return 0;
4029 }
4030
wdenk2729af92004-05-03 20:45:30 +00004031 Download latest U-Boot source;
4032
Wolfgang Denk06682362008-12-30 22:56:11 +01004033 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004034
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004035 if (clueless)
4036 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004037
wdenk2729af92004-05-03 20:45:30 +00004038 while (learning) {
4039 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004040 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4041 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004042 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004043 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004044 }
wdenkc6097192002-11-03 00:24:07 +00004045
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004046 if (available_money > toLocalCurrency ($2500))
4047 Buy a BDI3000;
4048 else
wdenk2729af92004-05-03 20:45:30 +00004049 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004050
4051 if (a similar board exists) { /* hopefully... */
4052 cp -a board/<similar> board/<myboard>
4053 cp include/configs/<similar>.h include/configs/<myboard>.h
4054 } else {
4055 Create your own board support subdirectory;
4056 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004057 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004058 Edit new board/<myboard> files
4059 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004060
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004061 while (!accepted) {
4062 while (!running) {
4063 do {
4064 Add / modify source code;
4065 } until (compiles);
4066 Debug;
4067 if (clueless)
4068 email("Hi, I am having problems...");
4069 }
4070 Send patch file to the U-Boot email list;
4071 if (reasonable critiques)
4072 Incorporate improvements from email list code review;
4073 else
4074 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004075 }
wdenkc6097192002-11-03 00:24:07 +00004076
wdenk2729af92004-05-03 20:45:30 +00004077 return 0;
4078}
4079
4080void no_more_time (int sig)
4081{
4082 hire_a_guru();
4083}
wdenkc6097192002-11-03 00:24:07 +00004084
4085
wdenk2729af92004-05-03 20:45:30 +00004086Coding Standards:
4087-----------------
wdenkc6097192002-11-03 00:24:07 +00004088
wdenk2729af92004-05-03 20:45:30 +00004089All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004090coding style; see the file "Documentation/CodingStyle" and the script
4091"scripts/Lindent" in your Linux kernel source directory. In sources
4092originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4093spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004094
Detlev Zundel2c051652006-09-01 15:39:02 +02004095Source files originating from a different project (for example the
4096MTD subsystem) are generally exempt from these guidelines and are not
4097reformated to ease subsequent migration to newer versions of those
4098sources.
4099
4100Please note that U-Boot is implemented in C (and to some small parts in
4101Assembler); no C++ is used, so please do not use C++ style comments (//)
4102in your code.
wdenk2729af92004-05-03 20:45:30 +00004103
4104Please also stick to the following formatting rules:
4105- remove any trailing white space
4106- use TAB characters for indentation, not spaces
4107- make sure NOT to use DOS '\r\n' line feeds
4108- do not add more than 2 empty lines to source files
4109- do not add trailing empty lines to source files
4110
4111Submissions which do not conform to the standards may be returned
4112with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004113
4114
wdenk2729af92004-05-03 20:45:30 +00004115Submitting Patches:
4116-------------------
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk2729af92004-05-03 20:45:30 +00004118Since the number of patches for U-Boot is growing, we need to
4119establish some rules. Submissions which do not conform to these rules
4120may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004121
Magnus Lilja0d28f342008-08-06 19:32:33 +02004122Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004123
Wolfgang Denk06682362008-12-30 22:56:11 +01004124Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4125see http://lists.denx.de/mailman/listinfo/u-boot
4126
wdenk2729af92004-05-03 20:45:30 +00004127When you send a patch, please include the following information with
4128it:
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk2729af92004-05-03 20:45:30 +00004130* For bug fixes: a description of the bug and how your patch fixes
4131 this bug. Please try to include a way of demonstrating that the
4132 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134* For new features: a description of the feature and your
4135 implementation.
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk2729af92004-05-03 20:45:30 +00004137* A CHANGELOG entry as plaintext (separate from the patch)
4138
4139* For major contributions, your entry to the CREDITS file
4140
4141* When you add support for a new board, don't forget to add this
4142 board to the MAKEALL script, too.
4143
4144* If your patch adds new configuration options, don't forget to
4145 document these in the README file.
4146
Wolfgang Denk218ca722008-03-26 10:40:12 +01004147* The patch itself. If you are using git (which is *strongly*
4148 recommended) you can easily generate the patch using the
4149 "git-format-patch". If you then use "git-send-email" to send it to
4150 the U-Boot mailing list, you will avoid most of the common problems
4151 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004152
Wolfgang Denk218ca722008-03-26 10:40:12 +01004153 If you cannot use git, use "diff -purN OLD NEW". If your version of
4154 diff does not support these options, then get the latest version of
4155 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004156
Wolfgang Denk218ca722008-03-26 10:40:12 +01004157 The current directory when running this command shall be the parent
4158 directory of the U-Boot source tree (i. e. please make sure that
4159 your patch includes sufficient directory information for the
4160 affected files).
4161
4162 We prefer patches as plain text. MIME attachments are discouraged,
4163 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004164
4165* If one logical set of modifications affects or creates several
4166 files, all these changes shall be submitted in a SINGLE patch file.
4167
4168* Changesets that contain different, unrelated modifications shall be
4169 submitted as SEPARATE patches, one patch per changeset.
4170
4171
4172Notes:
4173
4174* Before sending the patch, run the MAKEALL script on your patched
4175 source tree and make sure that no errors or warnings are reported
4176 for any of the boards.
4177
4178* Keep your modifications to the necessary minimum: A patch
4179 containing several unrelated changes or arbitrary reformats will be
4180 returned with a request to re-formatting / split it.
4181
4182* If you modify existing code, make sure that your new code does not
4183 add to the memory footprint of the code ;-) Small is beautiful!
4184 When adding new features, these should compile conditionally only
4185 (using #ifdef), and the resulting code with the new feature
4186 disabled must not need more memory than the old code without your
4187 modification.
wdenk90dc6702005-05-03 14:12:25 +00004188
Wolfgang Denk06682362008-12-30 22:56:11 +01004189* Remember that there is a size limit of 100 kB per message on the
4190 u-boot mailing list. Bigger patches will be moderated. If they are
4191 reasonable and not too big, they will be acknowledged. But patches
4192 bigger than the size limit should be avoided.