blob: 7e43c21d267f740b30d47edcd5bb1e0c6d58fa71 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb240aef2008-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
wdenkce4832c2004-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 Denkb240aef2008-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 Tyser8804a612008-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 Denkb240aef2008-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 Ziswilerabd8dcb2008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschin08337f32008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-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 Ziswilerabd8dcb2008-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 Liljaf3b287b2008-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:
wdenkc6097192002-11-03 00:24:07 +0000121
wdenk24ee89b2002-11-03 17:56:27 +0000122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
124
wdenkc6097192002-11-03 00:24:07 +0000125
wdenk7474aca2002-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
wdenkeb20ad32003-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
wdenk337f5652004-10-28 00:09:35 +0000144 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenkd729d302004-02-27 00:07:27 +0000145 - arm720t Files specific to ARM 720 CPUs
146 - arm920t Files specific to ARM 920 CPUs
wdenk91fcc952005-04-06 13:52:31 +0000147 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk337f5652004-10-28 00:09:35 +0000148 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenkf8e9a232004-10-09 22:21:29 +0000149 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenkd729d302004-02-27 00:07:27 +0000150 - arm925t Files specific to ARM 925 CPUs
151 - arm926ejs Files specific to ARM 926 CPUs
wdenkf8062712005-01-09 23:16:25 +0000152 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk64702552006-10-24 14:27:35 +0200153 - at32ap Files specific to Atmel AVR32 AP CPUs
Mike Frysinger5d018ca2008-08-07 17:50:26 -0400154 - blackfin Files specific to Analog Devices Blackfin CPUs
wdenkd729d302004-02-27 00:07:27 +0000155 - i386 Files specific to i386 CPUs
156 - ixp Files specific to Intel XScale IXP CPUs
Daniel Hellstrom207e6952008-03-28 10:00:33 +0100157 - leon2 Files specific to Gaisler LEON2 SPARC CPU
Daniel Hellstromb552dbe2008-03-26 22:51:29 +0100158 - leon3 Files specific to Gaisler LEON3 SPARC CPU
wdenk337f5652004-10-28 00:09:35 +0000159 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
TsiChungLiew99b037a2008-01-14 17:43:33 -0600160 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
TsiChung Liewf6afe722007-06-18 13:50:13 -0500161 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
TsiChungLiewfc3ca3b62007-08-16 15:05:11 -0500162 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
TsiChungLiew8cb946d2008-01-15 14:15:46 -0600163 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
wdenkd729d302004-02-27 00:07:27 +0000164 - mips Files specific to MIPS CPUs
wdenk337f5652004-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
wdenkd729d302004-02-27 00:07:27 +0000172 - nios Files specific to Altera NIOS CPUs
wdenkef3386f2004-10-10 21:27:30 +0000173 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0ee70772005-09-23 11:05:55 +0200174 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenkd729d302004-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)
wdenkeb20ad32003-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
wdenkd729d302004-02-27 00:07:27 +0000184- lib_arm Files generic to ARM architecture
Wolfgang Denk83c15852006-10-24 14:21:16 +0200185- lib_avr32 Files generic to AVR32 architecture
Mike Frysinger5d018ca2008-08-07 17:50:26 -0400186- lib_blackfin Files generic to Blackfin architecture
wdenkd729d302004-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 Hellstrom9d7c6b22008-03-28 09:47:00 +0100193- lib_sparc Files generic to SPARC architecture
Wolfgang Denkb240aef2008-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-VILLARD03836942008-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 Ziswilerabd8dcb2008-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
wdenk1272e232002-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 Phillips203fee32007-08-10 13:28:25 -0500258- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000259
Kim Phillips203fee32007-08-10 13:28:25 -0500260- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200261
262- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200283 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000284 a "rotator" |\-/|\-/
285
wdenk2bb11052003-07-17 23:16:40 +0000286- Board flavour: (if CONFIG_MPC8260ADS is defined)
287 CONFIG_ADSTYPE
288 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-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
wdenk2bb11052003-07-17 23:16:40 +0000293
wdenkc6097192002-11-03 00:24:07 +0000294- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000295 Define exactly one of
296 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000297
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200298- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000299 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
300 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000301 e.g. if there is no 32KHz
302 reference PIT/RTC clock
wdenk20bddb32004-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
wdenk20bddb32004-09-28 17:59:53 +0000306- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200307 CONFIG_SYS_8xx_CPUCLK_MIN
308 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000309 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000310 See doc/README.MPC866
311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200312 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000313
wdenk544e9732004-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-VILLARD03836942008-10-16 15:01:15 +0200319 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000320
Heiko Schocher734f0272009-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 Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100326- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200327 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-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-VILLARD03836942008-10-16 15:01:15 +0200333 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200334
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100335 Defines the Monahans turbo mode to oscillator
336 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200337 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100338 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200339
wdenk9b7f3842003-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 Denkb240aef2008-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
wdenk9b7f3842003-10-09 20:09:04 +0000354 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
355
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200356 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-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 Barenfcd91bb2008-06-03 20:34:45 -0400360 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200361
362 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-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 Phillips9b46eb62007-08-10 14:34:14 -0500369 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400370
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200371 OF_CPU - The proper name of the cpus node.
Kumar Galae40c2b52006-01-11 13:59:02 -0600372 OF_SOC - The proper name of the soc node.
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200373 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600374 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200375
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200376 boards with QUICC Engines require OF_QE to set UCC MAC
377 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500378
Kumar Gala1e26aa52006-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
wdenkda04a8b2004-08-02 23:22:59 +0000383
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500384 CONFIG_OF_BOOT_CPU
385
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200386 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500387 param header, the default value is zero if undefined.
388
Niklaus Giger0ab978d2008-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
wdenkda04a8b2004-08-02 23:22:59 +0000407- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200408 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000409
410 Define this if you want support for Amba PrimeCell PL010 UARTs.
411
Andreas Engel0813b122008-09-08 14:30:53 +0200412 CONFIG_PL011_SERIAL
wdenkda04a8b2004-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:
wdenk4a5c8a72003-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)
wdenk544e9732004-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)
wdenk544e9732004-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-VILLARD03836942008-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 Loeligerc1da5c92007-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
wdenk9dd2b882002-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 Ziswilerabd8dcb2008-07-09 08:17:15 +0200474 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000475 the logo
476
wdenk4a5c8a72003-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
wdenk1ebf41e2004-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.
wdenk3da587e2003-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-VILLARD03836942008-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 Schocher327480a2009-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 Schocher362447f2009-02-10 09:31:47 +0100495 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-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
wdenkf16b5162004-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
stroese3d24d6e2003-05-23 11:39:05 +0000512- Console UART Number:
513 CONFIG_UART1_CONSOLE
514
Wolfgang Denk0ee70772005-09-23 11:05:55 +0200515 AMCC PPC4xx only.
stroese3d24d6e2003-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
wdenk4a5c8a72003-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
wdenk4a5c8a72003-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 Ziswilerabd8dcb2008-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 Loeligerc1da5c92007-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-VILLARD03836942008-10-16 15:01:15 +0200582 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000583
584- Monitor Functions:
Jon Loeligerc1da5c92007-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 Loeligerc1da5c92007-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 Loeligerc1da5c92007-06-11 19:03:39 -0500595 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-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
606 CONFIG_CMD_DOC * Disk-On-Chip Support
Peter Tyser15258042008-12-17 16:36:22 -0600607 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
608 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
609 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
610 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500611 CONFIG_CMD_DTT * Digital Therm and Thermostat
612 CONFIG_CMD_ECHO echo arguments
613 CONFIG_CMD_EEPROM * EEPROM read/write support
614 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500615 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500616 CONFIG_CMD_FDC * Floppy Disk Support
617 CONFIG_CMD_FAT * FAT partition support
618 CONFIG_CMD_FDOS * Dos diskette Support
619 CONFIG_CMD_FLASH flinfo, erase, protect
620 CONFIG_CMD_FPGA FPGA device initialization support
621 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
622 CONFIG_CMD_I2C * I2C serial bus support
623 CONFIG_CMD_IDE * IDE harddisk support
624 CONFIG_CMD_IMI iminfo
625 CONFIG_CMD_IMLS List all found images
626 CONFIG_CMD_IMMAP * IMMR dump support
627 CONFIG_CMD_IRQ * irqinfo
628 CONFIG_CMD_ITEST Integer/string test of 2 values
629 CONFIG_CMD_JFFS2 * JFFS2 Support
630 CONFIG_CMD_KGDB * kgdb
631 CONFIG_CMD_LOADB loadb
632 CONFIG_CMD_LOADS loads
633 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
634 loop, loopw, mtest
635 CONFIG_CMD_MISC Misc functions like sleep etc
636 CONFIG_CMD_MMC * MMC memory mapped support
637 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100638 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500639 CONFIG_CMD_NAND * NAND support
640 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600641 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
642 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500643 CONFIG_CMD_PCI * pciinfo
644 CONFIG_CMD_PCMCIA * PCMCIA support
645 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
646 host
647 CONFIG_CMD_PORTIO * Port I/O
648 CONFIG_CMD_REGINFO * Register dump
649 CONFIG_CMD_RUN run command in env variable
650 CONFIG_CMD_SAVES * save S record dump
651 CONFIG_CMD_SCSI * SCSI Support
652 CONFIG_CMD_SDRAM * print SDRAM configuration information
653 (requires CONFIG_CMD_I2C)
654 CONFIG_CMD_SETGETDCR Support for DCR Register access
655 (4xx only)
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200656 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500657 CONFIG_CMD_SPI * SPI serial bus support
658 CONFIG_CMD_USB * USB support
659 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500660 CONFIG_CMD_CDP * Cisco Discover Protocol support
661 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000662
wdenkc6097192002-11-03 00:24:07 +0000663
664 EXAMPLE: If you want all functions except of network
665 support you can write:
666
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500667 #include "config_cmd_all.h"
668 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000669
Gerald Van Barend6abef42007-03-31 12:23:51 -0400670 Other Commands:
671 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000672
673 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500674 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000675 what you (and your U-Boot users) are doing. Data
676 cache cannot be enabled on systems like the 8xx or
677 8260 (where accesses to the IMMR region must be
678 uncached), and it cannot be disabled on all other
679 systems where we (mis-) use the data cache to hold an
680 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000681
682
683 XXX - this list needs to get updated!
684
685- Watchdog:
686 CONFIG_WATCHDOG
687 If this variable is defined, it enables watchdog
wdenkeb20ad32003-09-05 23:19:14 +0000688 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000689 code for a watchdog. For the 8xx and 8260 CPUs, the
690 SIU Watchdog feature is enabled in the SYPCR
691 register.
692
stroeseb9c17c52003-04-04 15:53:41 +0000693- U-Boot Version:
694 CONFIG_VERSION_VARIABLE
695 If this variable is defined, an environment variable
696 named "ver" is created by U-Boot showing the U-Boot
697 version as printed by the "version" command.
698 This variable is readonly.
699
wdenkc6097192002-11-03 00:24:07 +0000700- Real-Time Clock:
701
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500702 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000703 has to be selected, too. Define exactly one of the
704 following options:
705
706 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
707 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetskid4387492008-04-15 14:15:30 +0200708 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000709 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000710 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000711 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000712 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000713 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100714 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000715 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200716 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000717
wdenkb9bbd242003-06-30 16:24:52 +0000718 Note that if the RTC uses I2C, then the I2C interface
719 must also be configured. See I2C Support, below.
720
Peter Tyser9902e422008-12-17 16:36:21 -0600721- GPIO Support:
722 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
723 CONFIG_PCA953X_INFO - enable pca953x info command
724
725 Note that if the GPIO device uses I2C, then the I2C interface
726 must also be configured. See I2C Support, below.
727
wdenkc6097192002-11-03 00:24:07 +0000728- Timestamp Support:
729
wdenk4a5c8a72003-03-06 00:02:04 +0000730 When CONFIG_TIMESTAMP is selected, the timestamp
731 (date and time) of an image is printed by image
732 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500733 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000734
735- Partition Support:
736 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubune6745592008-09-26 11:13:22 -0400737 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000738
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100739 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
740 CONFIG_CMD_SCSI) you must configure support for at
741 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000742
743- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000744 CONFIG_IDE_RESET_ROUTINE - this is defined in several
745 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000746
wdenk369d43d2004-03-14 14:09:05 +0000747 CONFIG_IDE_RESET - is this is defined, IDE Reset will
748 be performed by calling the function
749 ide_set_reset(int reset)
750 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000751
752- ATAPI Support:
753 CONFIG_ATAPI
754
755 Set this to enable ATAPI support.
756
wdenkf602aa02004-03-13 23:29:43 +0000757- LBA48 Support
758 CONFIG_LBA48
759
760 Set this to enable support for disks larger than 137GB
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200761 Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
wdenkf602aa02004-03-13 23:29:43 +0000762 Whithout these , LBA48 support uses 32bit variables and will 'only'
763 support disks up to 2.1TB.
764
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200765 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000766 When enabled, makes the IDE subsystem use 64bit sector addresses.
767 Default is 32bit.
768
wdenkc6097192002-11-03 00:24:07 +0000769- SCSI Support:
770 At the moment only there is only support for the
771 SYM53C8XX SCSI controller; define
772 CONFIG_SCSI_SYM53C8XX to enable it.
773
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200774 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
775 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
776 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000777 maximum numbers of LUNs, SCSI ID's and target
778 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200779 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000780
781- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000782 CONFIG_E1000
783 Support for Intel 8254x gigabit chips.
stroese94ef1cf2003-06-05 15:39:44 +0000784
Andre Schwarz68c2a302008-03-06 16:45:44 +0100785 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200786 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +0100787
wdenkc6097192002-11-03 00:24:07 +0000788 CONFIG_EEPRO100
789 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200790 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000791 write routine for first time initialisation.
792
793 CONFIG_TULIP
794 Support for Digital 2114x chips.
795 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
796 modem chip initialisation (KS8761/QS6611).
797
798 CONFIG_NATSEMI
799 Support for National dp83815 chips.
800
801 CONFIG_NS8382X
802 Support for National dp8382[01] gigabit chips.
803
wdenkaa603362003-05-12 21:50:16 +0000804- NETWORK Support (other):
805
806 CONFIG_DRIVER_LAN91C96
807 Support for SMSC's LAN91C96 chips.
808
809 CONFIG_LAN91C96_BASE
810 Define this to hold the physical address
811 of the LAN91C96's I/O space
812
813 CONFIG_LAN91C96_USE_32_BIT
814 Define this to enable 32 bit addressing
815
wdenk3c711762004-06-09 13:37:52 +0000816 CONFIG_DRIVER_SMC91111
817 Support for SMSC's LAN91C111 chip
818
819 CONFIG_SMC91111_BASE
820 Define this to hold the physical address
821 of the device (I/O space)
822
823 CONFIG_SMC_USE_32_BIT
824 Define this if data bus is 32 bits
825
826 CONFIG_SMC_USE_IOFUNCS
827 Define this to use i/o functions instead of macros
828 (some hardware wont work with macros)
829
Jens Gehrlein1dd48252008-05-05 14:06:11 +0200830 CONFIG_DRIVER_SMC911X
831 Support for SMSC's LAN911x and LAN921x chips
832
833 CONFIG_DRIVER_SMC911X_BASE
834 Define this to hold the physical address
835 of the device (I/O space)
836
837 CONFIG_DRIVER_SMC911X_32_BIT
838 Define this if data bus is 32 bits
839
840 CONFIG_DRIVER_SMC911X_16_BIT
841 Define this if data bus is 16 bits. If your processor
842 automatically converts one 32 bit word to two 16 bit
843 words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
844
wdenkc6097192002-11-03 00:24:07 +0000845- USB Support:
846 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +0000847 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000848 CONFIG_USB_UHCI to enable it.
849 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +0000850 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000851 storage devices.
852 Note:
853 Supported are USB Keyboards and USB Floppy drives
854 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +0000855 MPC5200 USB requires additional defines:
856 CONFIG_USB_CLOCK
857 for 528 MHz Clock: 0x0001bbbb
858 CONFIG_USB_CONFIG
859 for differential drivers: 0x00001000
860 for single ended drivers: 0x00005000
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200861 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +0200862 May be defined to allow interrupt polling
863 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +0000864
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200865- USB Device:
866 Define the below if you wish to use the USB console.
867 Once firmware is rebuilt from a serial console issue the
868 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200869 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200870 it has found a new device. The environment variable usbtty
871 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +0200872 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200873 Common Device Class Abstract Control Model serial device.
874 If you select usbtty = gserial you should be able to enumerate
875 a Linux host by
876 # modprobe usbserial vendor=0xVendorID product=0xProductID
877 else if using cdc_acm, simply setting the environment
878 variable usbtty to be cdc_acm should suffice. The following
879 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200880
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200881 CONFIG_USB_DEVICE
882 Define this to build a UDC device
883
884 CONFIG_USB_TTY
885 Define this to have a tty type of device available to
886 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +0200887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200888 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200889 Define this if you want stdin, stdout &/or stderr to
890 be set to usbtty.
891
892 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200893 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200894 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200895 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +0200896
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200897 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200898 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200899 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200900
Wolfgang Denke2601822006-06-14 18:14:56 +0200901 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200902 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200903 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200904 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
905 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
906 should pretend to be a Linux device to it's target host.
907
908 CONFIG_USBD_MANUFACTURER
909 Define this string as the name of your company for
910 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +0200911
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200912 CONFIG_USBD_PRODUCT_NAME
913 Define this string as the name of your product
914 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +0000915
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200916 CONFIG_USBD_VENDORID
917 Define this as your assigned Vendor ID from the USB
918 Implementors Forum. This *must* be a genuine Vendor ID
919 to avoid polluting the USB namespace.
920 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200921
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200922 CONFIG_USBD_PRODUCTID
923 Define this as the unique Product ID
924 for your device
925 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200926
wdenkc6097192002-11-03 00:24:07 +0000927
wdenk7a428cc2003-06-15 22:40:42 +0000928- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +0000929 The MMC controller on the Intel PXA is supported. To
930 enable this define CONFIG_MMC. The MMC can be
931 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +0000932 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500933 enabled with CONFIG_CMD_MMC. The MMC driver also works with
934 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +0000935
wdenkda04a8b2004-08-02 23:22:59 +0000936- Journaling Flash filesystem support:
937 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
938 CONFIG_JFFS2_NAND_DEV
939 Define these for a default partition on a NAND device
940
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200941 CONFIG_SYS_JFFS2_FIRST_SECTOR,
942 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +0000943 Define these for a default partition on a NOR device
944
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200945 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +0000946 Define this to create an own partition. You have to provide a
947 function struct part_info* jffs2_part_info(int part_num)
948
949 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200950 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +0000951 to disable the command chpart. This is the default when you
952 have not defined a custom partition
953
wdenkc6097192002-11-03 00:24:07 +0000954- Keyboard Support:
955 CONFIG_ISA_KEYBOARD
956
957 Define this to enable standard (PC-Style) keyboard
958 support
959
960 CONFIG_I8042_KBD
961 Standard PC keyboard driver with US (is default) and
962 GERMAN key layout (switch via environment 'keymap=de') support.
963 Export function i8042_kbd_init, i8042_tstc and i8042_getc
964 for cfb_console. Supports cursor blinking.
965
966- Video support:
967 CONFIG_VIDEO
968
969 Define this to enable video support (for output to
970 video).
971
972 CONFIG_VIDEO_CT69000
973
974 Enable Chips & Technologies 69000 Video chip
975
976 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +0000977 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +0000978 video output is selected via environment 'videoout'
979 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
980 assumed.
wdenkc6097192002-11-03 00:24:07 +0000981
wdenkd3602132004-03-25 15:14:43 +0000982 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200983 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +0000984 are possible:
985 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +0000986 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +0000987
988 Colors 640x480 800x600 1024x768 1152x864 1280x1024
989 -------------+---------------------------------------------
990 8 bits | 0x301* 0x303 0x305 0x161 0x307
991 15 bits | 0x310 0x313 0x316 0x162 0x319
992 16 bits | 0x311 0x314 0x317 0x163 0x31A
993 24 bits | 0x312 0x315 0x318 ? 0x31B
994 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000995 (i.e. setenv videomode 317; saveenv; reset;)
996
wdenkd3602132004-03-25 15:14:43 +0000997 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +0100998 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +0000999
1000
stroeseb9c17c52003-04-04 15:53:41 +00001001 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001002 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001003 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1004 or CONFIG_VIDEO_SED13806_16BPP
1005
wdenk4e112c12003-06-03 23:54:09 +00001006- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001007 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001008
wdenk57b2d802003-06-27 21:31:46 +00001009 Define this to enable a custom keyboard support.
1010 This simply calls drv_keyboard_init() which must be
1011 defined in your board-specific files.
1012 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001013
wdenkc6097192002-11-03 00:24:07 +00001014- LCD Support: CONFIG_LCD
1015
1016 Define this to enable LCD support (for output to LCD
1017 display); also select one of the supported displays
1018 by defining one of these:
1019
Stelian Popf6f86652008-05-09 21:57:18 +02001020 CONFIG_ATMEL_LCD:
1021
1022 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1023
wdenkc0d54ae2003-11-25 16:55:19 +00001024 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001025
wdenkc0d54ae2003-11-25 16:55:19 +00001026 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001027
wdenkc0d54ae2003-11-25 16:55:19 +00001028 CONFIG_NEC_NL6448BC20
1029
1030 NEC NL6448BC20-08. 6.5", 640x480.
1031 Active, color, single scan.
1032
1033 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001034
wdenkc0d54ae2003-11-25 16:55:19 +00001035 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001036 Active, color, single scan.
1037
1038 CONFIG_SHARP_16x9
1039
1040 Sharp 320x240. Active, color, single scan.
1041 It isn't 16x9, and I am not sure what it is.
1042
1043 CONFIG_SHARP_LQ64D341
1044
1045 Sharp LQ64D341 display, 640x480.
1046 Active, color, single scan.
1047
1048 CONFIG_HLD1045
1049
1050 HLD1045 display, 640x480.
1051 Active, color, single scan.
1052
1053 CONFIG_OPTREX_BW
1054
1055 Optrex CBL50840-2 NF-FW 99 22 M5
1056 or
1057 Hitachi LMG6912RPFC-00T
1058 or
1059 Hitachi SP14Q002
1060
1061 320x240. Black & white.
1062
1063 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001064 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001065
wdenkeb20ad32003-09-05 23:19:14 +00001066- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001067
wdenk57b2d802003-06-27 21:31:46 +00001068 If this option is set, the environment is checked for
1069 a variable "splashimage". If found, the usual display
1070 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001071 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001072 specified in "splashimage" is loaded instead. The
1073 console is redirected to the "nulldev", too. This
1074 allows for a "silent" boot where a splash screen is
1075 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001076
Matthias Weisser53884182009-07-09 16:07:30 +02001077 CONFIG_SPLASH_SCREEN_ALIGN
1078
1079 If this option is set the splash image can be freely positioned
1080 on the screen. Environment variable "splashpos" specifies the
1081 position as "x,y". If a positive number is given it is used as
1082 number of pixel from left/top. If a negative number is given it
1083 is used as number of pixel from right/bottom. You can also
1084 specify 'm' for centering the image.
1085
1086 Example:
1087 setenv splashpos m,m
1088 => image at center of screen
1089
1090 setenv splashpos 30,20
1091 => image at x = 30 and y = 20
1092
1093 setenv splashpos -10,m
1094 => vertically centered image
1095 at x = dspWidth - bmpWidth - 9
1096
Stefan Roesed9d97742005-09-22 09:04:17 +02001097- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1098
1099 If this option is set, additionally to standard BMP
1100 images, gzipped BMP images can be displayed via the
1101 splashscreen support or the bmp command.
1102
wdenk710e3502003-08-29 20:57:53 +00001103- Compression support:
1104 CONFIG_BZIP2
1105
1106 If this option is set, support for bzip2 compressed
1107 images is included. If not, only uncompressed and gzip
1108 compressed images are supported.
1109
wdenk9c53f402003-10-15 23:53:47 +00001110 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001111 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001112 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001113
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001114 CONFIG_LZMA
1115
1116 If this option is set, support for lzma compressed
1117 images is included.
1118
1119 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1120 requires an amount of dynamic memory that is given by the
1121 formula:
1122
1123 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1124
1125 Where lc and lp stand for, respectively, Literal context bits
1126 and Literal pos bits.
1127
1128 This value is upper-bounded by 14MB in the worst case. Anyway,
1129 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1130 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1131 a very small buffer.
1132
1133 Use the lzmainfo tool to determinate the lc and lp values and
1134 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001135 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001136
wdenk0e2bd9c2004-06-06 21:51:03 +00001137- MII/PHY support:
1138 CONFIG_PHY_ADDR
1139
1140 The address of PHY on MII bus.
1141
1142 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1143
1144 The clock frequency of the MII bus
1145
1146 CONFIG_PHY_GIGE
1147
1148 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001149 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001150
1151 CONFIG_PHY_RESET_DELAY
1152
1153 Some PHY like Intel LXT971A need extra delay after
1154 reset before any MII register access is possible.
1155 For such PHY, set this option to the usec delay
1156 required. (minimum 300usec for LXT971A)
1157
1158 CONFIG_PHY_CMD_DELAY (ppc4xx)
1159
1160 Some PHY like Intel LXT971A need extra delay after
1161 command issued before MII status register can be read
1162
wdenkc6097192002-11-03 00:24:07 +00001163- Ethernet address:
1164 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001165 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001166 CONFIG_ETH2ADDR
1167 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001168 CONFIG_ETH4ADDR
1169 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001170
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001171 Define a default value for Ethernet address to use
1172 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001173 is not determined automatically.
1174
1175- IP address:
1176 CONFIG_IPADDR
1177
1178 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001179 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001180 determined through e.g. bootp.
1181
1182- Server IP address:
1183 CONFIG_SERVERIP
1184
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001185 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001186 server to contact when using the "tftboot" command.
1187
David Updegraff7280da72007-06-11 10:41:07 -05001188- Multicast TFTP Mode:
1189 CONFIG_MCAST_TFTP
1190
1191 Defines whether you want to support multicast TFTP as per
1192 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001193 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001194 driver in use must provide a function: mcast() to join/leave a
1195 multicast group.
1196
1197 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001198- BOOTP Recovery Mode:
1199 CONFIG_BOOTP_RANDOM_DELAY
1200
1201 If you have many targets in a network that try to
1202 boot using BOOTP, you may want to avoid that all
1203 systems send out BOOTP requests at precisely the same
1204 moment (which would happen for instance at recovery
1205 from a power failure, when all systems will try to
1206 boot, thus flooding the BOOTP server. Defining
1207 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1208 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001209 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001210
1211 1st BOOTP request: delay 0 ... 1 sec
1212 2nd BOOTP request: delay 0 ... 2 sec
1213 3rd BOOTP request: delay 0 ... 4 sec
1214 4th and following
1215 BOOTP requests: delay 0 ... 8 sec
1216
stroesee0aadfb2003-08-28 14:17:32 +00001217- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001218 You can fine tune the DHCP functionality by defining
1219 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001220
Jon Loeliger5336a762007-07-09 22:08:34 -05001221 CONFIG_BOOTP_SUBNETMASK
1222 CONFIG_BOOTP_GATEWAY
1223 CONFIG_BOOTP_HOSTNAME
1224 CONFIG_BOOTP_NISDOMAIN
1225 CONFIG_BOOTP_BOOTPATH
1226 CONFIG_BOOTP_BOOTFILESIZE
1227 CONFIG_BOOTP_DNS
1228 CONFIG_BOOTP_DNS2
1229 CONFIG_BOOTP_SEND_HOSTNAME
1230 CONFIG_BOOTP_NTPSERVER
1231 CONFIG_BOOTP_TIMEOFFSET
1232 CONFIG_BOOTP_VENDOREX
stroesee0aadfb2003-08-28 14:17:32 +00001233
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001234 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1235 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001236
1237 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1238 serverip from a DHCP server, it is possible that more
1239 than one DNS serverip is offered to the client.
1240 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1241 serverip will be stored in the additional environment
1242 variable "dnsip2". The first DNS serverip is always
1243 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001244 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001245
1246 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1247 to do a dynamic update of a DNS server. To do this, they
1248 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001249 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001250 of the "hostname" environment variable is passed as
1251 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001252
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001253 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1254
1255 A 32bit value in microseconds for a delay between
1256 receiving a "DHCP Offer" and sending the "DHCP Request".
1257 This fixes a problem with certain DHCP servers that don't
1258 respond 100% of the time to a "DHCP request". E.g. On an
1259 AT91RM9200 processor running at 180MHz, this delay needed
1260 to be *at least* 15,000 usec before a Windows Server 2003
1261 DHCP server would reply 100% of the time. I recommend at
1262 least 50,000 usec to be safe. The alternative is to hope
1263 that one of the retries will be successful but note that
1264 the DHCP timeout and retry process takes a longer than
1265 this delay.
1266
wdenk145d2c12004-04-15 21:48:45 +00001267 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001268 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001269
1270 The device id used in CDP trigger frames.
1271
1272 CONFIG_CDP_DEVICE_ID_PREFIX
1273
1274 A two character string which is prefixed to the MAC address
1275 of the device.
1276
1277 CONFIG_CDP_PORT_ID
1278
1279 A printf format string which contains the ascii name of
1280 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001281 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001282
1283 CONFIG_CDP_CAPABILITIES
1284
1285 A 32bit integer which indicates the device capabilities;
1286 0x00000010 for a normal host which does not forwards.
1287
1288 CONFIG_CDP_VERSION
1289
1290 An ascii string containing the version of the software.
1291
1292 CONFIG_CDP_PLATFORM
1293
1294 An ascii string containing the name of the platform.
1295
1296 CONFIG_CDP_TRIGGER
1297
1298 A 32bit integer sent on the trigger.
1299
1300 CONFIG_CDP_POWER_CONSUMPTION
1301
1302 A 16bit integer containing the power consumption of the
1303 device in .1 of milliwatts.
1304
1305 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1306
1307 A byte containing the id of the VLAN.
1308
wdenkc6097192002-11-03 00:24:07 +00001309- Status LED: CONFIG_STATUS_LED
1310
1311 Several configurations allow to display the current
1312 status using a LED. For instance, the LED will blink
1313 fast while running U-Boot code, stop blinking as
1314 soon as a reply to a BOOTP request was received, and
1315 start blinking slow once the Linux kernel is running
1316 (supported by a status LED driver in the Linux
1317 kernel). Defining CONFIG_STATUS_LED enables this
1318 feature in U-Boot.
1319
1320- CAN Support: CONFIG_CAN_DRIVER
1321
1322 Defining CONFIG_CAN_DRIVER enables CAN driver support
1323 on those systems that support this (optional)
1324 feature, like the TQM8xxL modules.
1325
1326- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1327
wdenkb9bbd242003-06-30 16:24:52 +00001328 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001329 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001330 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001331
wdenk21136db2003-07-16 21:53:01 +00001332 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001333 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001334 CONFIG_COMMANDS) and communicate with i2c based realtime
1335 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001336 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001337
Ben Warren45657152006-09-07 16:50:54 -04001338 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001339
wdenk21136db2003-07-16 21:53:01 +00001340 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001341 bit-banging) driver instead of CPM or similar hardware
1342 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001343
wdenk21136db2003-07-16 21:53:01 +00001344 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001345 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001347 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001348 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001349 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001350 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001351
wdenkb9bbd242003-06-30 16:24:52 +00001352 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001353 sets the CPU up as a master node and so its address should
wdenkb9bbd242003-06-30 16:24:52 +00001354 therefore be cleared to 0 (See, eg, MPC823e User's Manual
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001355 p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001356
wdenk21136db2003-07-16 21:53:01 +00001357 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001358
wdenkb9bbd242003-06-30 16:24:52 +00001359 If you use the software i2c interface (CONFIG_SOFT_I2C)
1360 then the following macros need to be defined (examples are
1361 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001362
1363 I2C_INIT
1364
wdenkb9bbd242003-06-30 16:24:52 +00001365 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001366 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001367
wdenk544e9732004-02-06 23:19:44 +00001368 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001369
wdenkc6097192002-11-03 00:24:07 +00001370 I2C_PORT
1371
wdenk4a5c8a72003-03-06 00:02:04 +00001372 (Only for MPC8260 CPU). The I/O port to use (the code
1373 assumes both bits are on the same port). Valid values
1374 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001375
1376 I2C_ACTIVE
1377
1378 The code necessary to make the I2C data line active
1379 (driven). If the data line is open collector, this
1380 define can be null.
1381
wdenkb9bbd242003-06-30 16:24:52 +00001382 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1383
wdenkc6097192002-11-03 00:24:07 +00001384 I2C_TRISTATE
1385
1386 The code necessary to make the I2C data line tri-stated
1387 (inactive). If the data line is open collector, this
1388 define can be null.
1389
wdenkb9bbd242003-06-30 16:24:52 +00001390 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1391
wdenkc6097192002-11-03 00:24:07 +00001392 I2C_READ
1393
1394 Code that returns TRUE if the I2C data line is high,
1395 FALSE if it is low.
1396
wdenkb9bbd242003-06-30 16:24:52 +00001397 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1398
wdenkc6097192002-11-03 00:24:07 +00001399 I2C_SDA(bit)
1400
1401 If <bit> is TRUE, sets the I2C data line high. If it
1402 is FALSE, it clears it (low).
1403
wdenkb9bbd242003-06-30 16:24:52 +00001404 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001405 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001406 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001407
wdenkc6097192002-11-03 00:24:07 +00001408 I2C_SCL(bit)
1409
1410 If <bit> is TRUE, sets the I2C clock line high. If it
1411 is FALSE, it clears it (low).
1412
wdenkb9bbd242003-06-30 16:24:52 +00001413 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001414 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001415 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001416
wdenkc6097192002-11-03 00:24:07 +00001417 I2C_DELAY
1418
1419 This delay is invoked four times per clock cycle so this
1420 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001421 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001422 like:
1423
wdenkb9bbd242003-06-30 16:24:52 +00001424 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001425
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001426 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001427
wdenk57b2d802003-06-27 21:31:46 +00001428 When a board is reset during an i2c bus transfer
1429 chips might think that the current transfer is still
1430 in progress. On some boards it is possible to access
1431 the i2c SCLK line directly, either by using the
1432 processor pin as a GPIO or by having a second pin
1433 connected to the bus. If this option is defined a
1434 custom i2c_init_board() routine in boards/xxx/board.c
1435 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001436
wdenk0e2bd9c2004-06-06 21:51:03 +00001437 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1438
1439 This option enables configuration of bi_iic_fast[] flags
1440 in u-boot bd_info structure based on u-boot environment
1441 variable "i2cfast". (see also i2cfast)
1442
Ben Warren45657152006-09-07 16:50:54 -04001443 CONFIG_I2C_MULTI_BUS
1444
1445 This option allows the use of multiple I2C buses, each of which
1446 must have a controller. At any point in time, only one bus is
1447 active. To switch to a different bus, use the 'i2c dev' command.
1448 Note that bus numbering is zero-based.
1449
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001450 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001451
1452 This option specifies a list of I2C devices that will be skipped
Peter Tyser469cde42009-04-18 22:34:03 -05001453 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1454 is set, specify a list of bus-device pairs. Otherwise, specify
1455 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001456
1457 e.g.
1458 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001459 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001460
1461 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1462
1463 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001464 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001465
1466 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1467
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001468 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001469
1470 If defined, then this indicates the I2C bus number for DDR SPD.
1471 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1472
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001473 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001474
1475 If defined, then this indicates the I2C bus number for the RTC.
1476 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1477
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001478 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001479
1480 If defined, then this indicates the I2C bus number for the DTT.
1481 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1482
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001483 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07001484
1485 If defined, specifies the I2C address of the DTT device.
1486 If not defined, then U-Boot uses predefined value for
1487 specified DTT device.
1488
Timur Tabiab347542006-11-03 19:15:00 -06001489 CONFIG_FSL_I2C
1490
1491 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01001492 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06001493
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001494 CONFIG_I2C_MUX
1495
1496 Define this option if you have I2C devices reached over 1 .. n
1497 I2C Muxes like the pca9544a. This option addes a new I2C
1498 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1499 new I2C Bus to the existing I2C Busses. If you select the
1500 new Bus with "i2c dev", u-bbot sends first the commandos for
1501 the muxes to activate this new "bus".
1502
1503 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1504 feature!
1505
1506 Example:
1507 Adding a new I2C Bus reached over 2 pca9544a muxes
1508 The First mux with address 70 and channel 6
1509 The Second mux with address 71 and channel 4
1510
1511 => i2c bus pca9544a:70:6:pca9544a:71:4
1512
1513 Use the "i2c bus" command without parameter, to get a list
1514 of I2C Busses with muxes:
1515
1516 => i2c bus
1517 Busses reached over muxes:
1518 Bus ID: 2
1519 reached over Mux(es):
1520 pca9544a@70 ch: 4
1521 Bus ID: 3
1522 reached over Mux(es):
1523 pca9544a@70 ch: 6
1524 pca9544a@71 ch: 4
1525 =>
1526
1527 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1528 u-boot sends First the Commando to the mux@70 to enable
1529 channel 6, and then the Commando to the mux@71 to enable
1530 the channel 4.
1531
1532 After that, you can use the "normal" i2c commands as
1533 usual, to communicate with your I2C devices behind
1534 the 2 muxes.
1535
1536 This option is actually implemented for the bitbanging
1537 algorithm in common/soft_i2c.c and for the Hardware I2C
1538 Bus on the MPC8260. But it should be not so difficult
1539 to add this option to other architectures.
1540
Andrew Dyer58c41f92008-12-29 17:36:01 -06001541 CONFIG_SOFT_I2C_READ_REPEATED_START
1542
1543 defining this will force the i2c_read() function in
1544 the soft_i2c driver to perform an I2C repeated start
1545 between writing the address pointer and reading the
1546 data. If this define is omitted the default behaviour
1547 of doing a stop-start sequence will be used. Most I2C
1548 devices can use either method, but some require one or
1549 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001550
wdenkc6097192002-11-03 00:24:07 +00001551- SPI Support: CONFIG_SPI
1552
1553 Enables SPI driver (so far only tested with
1554 SPI EEPROM, also an instance works with Crystal A/D and
1555 D/As on the SACSng board)
1556
1557 CONFIG_SPI_X
1558
1559 Enables extended (16-bit) SPI EEPROM addressing.
1560 (symmetrical to CONFIG_I2C_X)
1561
1562 CONFIG_SOFT_SPI
1563
wdenk4a5c8a72003-03-06 00:02:04 +00001564 Enables a software (bit-bang) SPI driver rather than
1565 using hardware support. This is a general purpose
1566 driver that only requires three general I/O port pins
1567 (two outputs, one input) to function. If this is
1568 defined, the board configuration must define several
1569 SPI configuration items (port pins to use, etc). For
1570 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001571
Ben Warren7efe9272008-01-16 22:37:35 -05001572 CONFIG_HARD_SPI
1573
1574 Enables a hardware SPI driver for general-purpose reads
1575 and writes. As with CONFIG_SOFT_SPI, the board configuration
1576 must define a list of chip-select function pointers.
1577 Currently supported on some MPC8xxx processors. For an
1578 example, see include/configs/mpc8349emds.h.
1579
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02001580 CONFIG_MXC_SPI
1581
1582 Enables the driver for the SPI controllers on i.MX and MXC
1583 SoCs. Currently only i.MX31 is supported.
1584
Matthias Fuchsa4400872007-12-27 17:12:34 +01001585- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001586
Matthias Fuchsa4400872007-12-27 17:12:34 +01001587 Enables FPGA subsystem.
1588
1589 CONFIG_FPGA_<vendor>
1590
1591 Enables support for specific chip vendors.
1592 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001593
Matthias Fuchsa4400872007-12-27 17:12:34 +01001594 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001595
Matthias Fuchsa4400872007-12-27 17:12:34 +01001596 Enables support for FPGA family.
1597 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1598
1599 CONFIG_FPGA_COUNT
1600
1601 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001602
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001603 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001604
wdenk57b2d802003-06-27 21:31:46 +00001605 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001606
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001607 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001608
wdenk4a5c8a72003-03-06 00:02:04 +00001609 Enable checks on FPGA configuration interface busy
1610 status by the configuration function. This option
1611 will require a board or device specific function to
1612 be written.
wdenkc6097192002-11-03 00:24:07 +00001613
1614 CONFIG_FPGA_DELAY
1615
1616 If defined, a function that provides delays in the FPGA
1617 configuration driver.
1618
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001619 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001620 Allow Control-C to interrupt FPGA configuration
1621
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001622 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001623
wdenk4a5c8a72003-03-06 00:02:04 +00001624 Check for configuration errors during FPGA bitfile
1625 loading. For example, abort during Virtex II
1626 configuration if the INIT_B line goes low (which
1627 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001628
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001629 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001630
wdenk4a5c8a72003-03-06 00:02:04 +00001631 Maximum time to wait for the INIT_B line to deassert
1632 after PROB_B has been deasserted during a Virtex II
1633 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001634 ms.
wdenkc6097192002-11-03 00:24:07 +00001635
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001636 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001637
wdenk4a5c8a72003-03-06 00:02:04 +00001638 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001639 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001641 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001642
wdenk4a5c8a72003-03-06 00:02:04 +00001643 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001644 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001645
1646- Configuration Management:
1647 CONFIG_IDENT_STRING
1648
wdenk4a5c8a72003-03-06 00:02:04 +00001649 If defined, this string will be added to the U-Boot
1650 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001651
1652- Vendor Parameter Protection:
1653
wdenk4a5c8a72003-03-06 00:02:04 +00001654 U-Boot considers the values of the environment
1655 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001656 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001657 are set once by the board vendor / manufacturer, and
1658 protects these variables from casual modification by
1659 the user. Once set, these variables are read-only,
1660 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001661 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001662
1663 If CONFIG_ENV_OVERWRITE is #defined in your config
1664 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001665 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001666 these parameters.
1667
1668 Alternatively, if you #define _both_ CONFIG_ETHADDR
1669 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001670 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001671 which can be changed exactly ONCE by the user. [The
1672 serial# is unaffected by this, i. e. it remains
1673 read-only.]
1674
1675- Protected RAM:
1676 CONFIG_PRAM
1677
1678 Define this variable to enable the reservation of
1679 "protected RAM", i. e. RAM which is not overwritten
1680 by U-Boot. Define CONFIG_PRAM to hold the number of
1681 kB you want to reserve for pRAM. You can overwrite
1682 this default value by defining an environment
1683 variable "pram" to the number of kB you want to
1684 reserve. Note that the board info structure will
1685 still show the full amount of RAM. If pRAM is
1686 reserved, a new environment variable "mem" will
1687 automatically be defined to hold the amount of
1688 remaining RAM in a form that can be passed as boot
1689 argument to Linux, for instance like that:
1690
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001691 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001692 saveenv
1693
1694 This way you can tell Linux not to use this memory,
1695 either, which results in a memory region that will
1696 not be affected by reboots.
1697
1698 *WARNING* If your board configuration uses automatic
1699 detection of the RAM size, you must make sure that
1700 this memory test is non-destructive. So far, the
1701 following board configurations are known to be
1702 "pRAM-clean":
1703
1704 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1705 HERMES, IP860, RPXlite, LWMON, LANTEC,
1706 PCU_E, FLAGADM, TQM8260
1707
1708- Error Recovery:
1709 CONFIG_PANIC_HANG
1710
1711 Define this variable to stop the system in case of a
1712 fatal error, so that you have to reset it manually.
1713 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001714 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001715 automatically as fast as possible, but it may be
1716 useful during development since you can try to debug
1717 the conditions that lead to the situation.
1718
1719 CONFIG_NET_RETRY_COUNT
1720
wdenk4a5c8a72003-03-06 00:02:04 +00001721 This variable defines the number of retries for
1722 network operations like ARP, RARP, TFTP, or BOOTP
1723 before giving up the operation. If not defined, a
1724 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001725
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02001726 CONFIG_ARP_TIMEOUT
1727
1728 Timeout waiting for an ARP reply in milliseconds.
1729
wdenkc6097192002-11-03 00:24:07 +00001730- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001731 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00001732
1733 Enable auto completion of commands using TAB.
1734
Wolfgang Denk018147d2006-11-27 15:32:42 +01001735 Note that this feature has NOT been implemented yet
1736 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001737
1738
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001739 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001740
1741 Define this variable to enable the "hush" shell (from
1742 Busybox) as command line interpreter, thus enabling
1743 powerful command line syntax like
1744 if...then...else...fi conditionals or `&&' and '||'
1745 constructs ("shell scripts").
1746
1747 If undefined, you get the old, much simpler behaviour
1748 with a somewhat smaller memory footprint.
1749
1750
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001751 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001752
1753 This defines the secondary prompt string, which is
1754 printed when the command interpreter needs more input
1755 to complete a command. Usually "> ".
1756
1757 Note:
1758
wdenk57b2d802003-06-27 21:31:46 +00001759 In the current implementation, the local variables
1760 space and global environment variables space are
1761 separated. Local variables are those you define by
1762 simply typing `name=value'. To access a local
1763 variable later on, you have write `$name' or
1764 `${name}'; to execute the contents of a variable
1765 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001766
wdenk4a5c8a72003-03-06 00:02:04 +00001767 Global environment variables are those you use
1768 setenv/printenv to work with. To run a command stored
1769 in such a variable, you need to use the run command,
1770 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001771
1772 To store commands and special characters in a
1773 variable, please use double quotation marks
1774 surrounding the whole text of the variable, instead
1775 of the backslashes before semicolons and special
1776 symbols.
1777
Wolfgang Denk2039a072006-07-21 11:35:21 +02001778- Commandline Editing and History:
1779 CONFIG_CMDLINE_EDITING
1780
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001781 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02001782 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02001783
wdenkc0aa5c52003-12-06 19:49:23 +00001784- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001785 CONFIG_EXTRA_ENV_SETTINGS
1786
wdenk4a5c8a72003-03-06 00:02:04 +00001787 Define this to contain any number of null terminated
1788 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00001789 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00001790
wdenk4a5c8a72003-03-06 00:02:04 +00001791 For example, place something like this in your
1792 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001793
1794 #define CONFIG_EXTRA_ENV_SETTINGS \
1795 "myvar1=value1\0" \
1796 "myvar2=value2\0"
1797
wdenk4a5c8a72003-03-06 00:02:04 +00001798 Warning: This method is based on knowledge about the
1799 internal format how the environment is stored by the
1800 U-Boot code. This is NOT an official, exported
1801 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00001802 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001803 You better know what you are doing here.
1804
wdenk4a5c8a72003-03-06 00:02:04 +00001805 Note: overly (ab)use of the default environment is
1806 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001807 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00001808 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001809
wdenkc0aa5c52003-12-06 19:49:23 +00001810- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00001811 CONFIG_HAS_DATAFLASH
1812
wdenk57b2d802003-06-27 21:31:46 +00001813 Defining this option enables DataFlash features and
1814 allows to read/write in Dataflash via the standard
1815 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00001816
wdenkef893942004-02-23 16:11:30 +00001817- SystemACE Support:
1818 CONFIG_SYSTEMACE
1819
1820 Adding this option adds support for Xilinx SystemACE
1821 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001822 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001823 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00001824
1825 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001826 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00001827
1828 When SystemACE support is added, the "ace" device type
1829 becomes available to the fat commands, i.e. fatls.
1830
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001831- TFTP Fixed UDP Port:
1832 CONFIG_TFTP_PORT
1833
Wolfgang Denk227b5192005-09-24 23:25:46 +02001834 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001835 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02001836 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001837 number generator is used.
1838
Wolfgang Denk227b5192005-09-24 23:25:46 +02001839 Also, the environment variable tftpdstp is used to supply
1840 the TFTP UDP destination port value. If tftpdstp isn't
1841 defined, the normal port 69 is used.
1842
1843 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001844 blindly start the TFTP transfer using the pre-configured
1845 target IP address and UDP port. This has the effect of
1846 "punching through" the (Windows XP) firewall, allowing
1847 the remainder of the TFTP transfer to proceed normally.
1848 A better solution is to properly configure the firewall,
1849 but sometimes that is not allowed.
1850
wdenkc0aa5c52003-12-06 19:49:23 +00001851- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001852 CONFIG_SHOW_BOOT_PROGRESS
1853
wdenk4a5c8a72003-03-06 00:02:04 +00001854 Defining this option allows to add some board-
1855 specific code (calling a user-provided function
1856 "show_boot_progress(int)") that enables you to show
1857 the system's boot progress on some display (for
1858 example, some LED's) on your board. At the moment,
1859 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001860
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02001861- Automatic software updates via TFTP server
1862 CONFIG_UPDATE_TFTP
1863 CONFIG_UPDATE_TFTP_CNT_MAX
1864 CONFIG_UPDATE_TFTP_MSEC_MAX
1865
1866 These options enable and control the auto-update feature;
1867 for a more detailed description refer to doc/README.update.
1868
Stefan Roese22ce6f92009-05-12 14:31:18 +02001869- MTD Support (mtdparts command, UBI support)
1870 CONFIG_MTD_DEVICE
1871
1872 Adds the MTD device infrastructure from the Linux kernel.
1873 Needed for mtdparts command support.
1874
1875 CONFIG_MTD_PARTITIONS
1876
1877 Adds the MTD partitioning infrastructure from the Linux
1878 kernel. Needed for UBI support.
1879
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001880Legacy uImage format:
1881
wdenkc6097192002-11-03 00:24:07 +00001882 Arg Where When
1883 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00001884 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001885 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00001886 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001887 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00001888 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001889 4 common/cmd_bootm.c Image data has correct checksum
1890 -4 common/cmd_bootm.c Image is for unsupported architecture
1891 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001892 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001893 6 common/cmd_bootm.c Image Type check OK
1894 -6 common/cmd_bootm.c gunzip uncompression error
1895 -7 common/cmd_bootm.c Unimplemented compression type
1896 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001897 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001898 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001899
1900 9 common/image.c Start initial ramdisk verification
1901 -10 common/image.c Ramdisk header has bad magic number
1902 -11 common/image.c Ramdisk header has bad checksum
1903 10 common/image.c Ramdisk header is OK
1904 -12 common/image.c Ramdisk data has bad checksum
1905 11 common/image.c Ramdisk data has correct checksum
1906 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001907 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001908 13 common/image.c Start multifile image verification
1909 14 common/image.c No initial ramdisk, no multifile, continue.
1910
1911 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001912
wdenkd729d302004-02-27 00:07:27 +00001913 -30 lib_ppc/board.c Fatal error, hang the system
1914 -31 post/post.c POST test failed, detected by post_output_backlog()
1915 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00001916
Heiko Schocher633e03a2007-06-22 19:11:54 +02001917 34 common/cmd_doc.c before loading a Image from a DOC device
1918 -35 common/cmd_doc.c Bad usage of "doc" command
1919 35 common/cmd_doc.c correct usage of "doc" command
1920 -36 common/cmd_doc.c No boot device
1921 36 common/cmd_doc.c correct boot device
1922 -37 common/cmd_doc.c Unknown Chip ID on boot device
1923 37 common/cmd_doc.c correct chip ID found, device available
1924 -38 common/cmd_doc.c Read Error on boot device
1925 38 common/cmd_doc.c reading Image header from DOC device OK
1926 -39 common/cmd_doc.c Image header has bad magic number
1927 39 common/cmd_doc.c Image header has correct magic number
1928 -40 common/cmd_doc.c Error reading Image from DOC device
1929 40 common/cmd_doc.c Image header has correct magic number
1930 41 common/cmd_ide.c before loading a Image from a IDE device
1931 -42 common/cmd_ide.c Bad usage of "ide" command
1932 42 common/cmd_ide.c correct usage of "ide" command
1933 -43 common/cmd_ide.c No boot device
1934 43 common/cmd_ide.c boot device found
1935 -44 common/cmd_ide.c Device not available
1936 44 common/cmd_ide.c Device available
1937 -45 common/cmd_ide.c wrong partition selected
1938 45 common/cmd_ide.c partition selected
1939 -46 common/cmd_ide.c Unknown partition table
1940 46 common/cmd_ide.c valid partition table found
1941 -47 common/cmd_ide.c Invalid partition type
1942 47 common/cmd_ide.c correct partition type
1943 -48 common/cmd_ide.c Error reading Image Header on boot device
1944 48 common/cmd_ide.c reading Image Header from IDE device OK
1945 -49 common/cmd_ide.c Image header has bad magic number
1946 49 common/cmd_ide.c Image header has correct magic number
1947 -50 common/cmd_ide.c Image header has bad checksum
1948 50 common/cmd_ide.c Image header has correct checksum
1949 -51 common/cmd_ide.c Error reading Image from IDE device
1950 51 common/cmd_ide.c reading Image from IDE device OK
1951 52 common/cmd_nand.c before loading a Image from a NAND device
1952 -53 common/cmd_nand.c Bad usage of "nand" command
1953 53 common/cmd_nand.c correct usage of "nand" command
1954 -54 common/cmd_nand.c No boot device
1955 54 common/cmd_nand.c boot device found
1956 -55 common/cmd_nand.c Unknown Chip ID on boot device
1957 55 common/cmd_nand.c correct chip ID found, device available
1958 -56 common/cmd_nand.c Error reading Image Header on boot device
1959 56 common/cmd_nand.c reading Image Header from NAND device OK
1960 -57 common/cmd_nand.c Image header has bad magic number
1961 57 common/cmd_nand.c Image header has correct magic number
1962 -58 common/cmd_nand.c Error reading Image from NAND device
1963 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00001964
Heiko Schocher633e03a2007-06-22 19:11:54 +02001965 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001966
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001967 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02001968 -64 net/eth.c no Ethernet found.
1969 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00001970
Heiko Schocher633e03a2007-06-22 19:11:54 +02001971 -80 common/cmd_net.c usage wrong
1972 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001973 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02001974 81 common/cmd_net.c NetLoop() back without error
1975 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1976 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001977 83 common/cmd_net.c running "source" command
1978 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02001979 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00001980
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001981FIT uImage format:
1982
1983 Arg Where When
1984 100 common/cmd_bootm.c Kernel FIT Image has correct format
1985 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1986 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1987 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1988 102 common/cmd_bootm.c Kernel unit name specified
1989 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01001990 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001991 104 common/cmd_bootm.c Got kernel subimage node offset
1992 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1993 105 common/cmd_bootm.c Kernel subimage hash verification OK
1994 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1995 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001996 -106 common/cmd_bootm.c Kernel subimage has wrong type
1997 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001998 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1999 108 common/cmd_bootm.c Got kernel subimage data/size
2000 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2001 -109 common/cmd_bootm.c Can't get kernel subimage type
2002 -110 common/cmd_bootm.c Can't get kernel subimage comp
2003 -111 common/cmd_bootm.c Can't get kernel subimage os
2004 -112 common/cmd_bootm.c Can't get kernel subimage load address
2005 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2006
2007 120 common/image.c Start initial ramdisk verification
2008 -120 common/image.c Ramdisk FIT image has incorrect format
2009 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002010 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002011 -122 common/image.c Can't get configuration for ramdisk subimage
2012 123 common/image.c Ramdisk unit name specified
2013 -124 common/image.c Can't get ramdisk subimage node offset
2014 125 common/image.c Got ramdisk subimage node offset
2015 -125 common/image.c Ramdisk subimage hash verification failed
2016 126 common/image.c Ramdisk subimage hash verification OK
2017 -126 common/image.c Ramdisk subimage for unsupported architecture
2018 127 common/image.c Architecture check OK
2019 -127 common/image.c Can't get ramdisk subimage data/size
2020 128 common/image.c Got ramdisk subimage data/size
2021 129 common/image.c Can't get ramdisk load address
2022 -129 common/image.c Got ramdisk load address
2023
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002024 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002025 131 common/cmd_doc.c FIT image format OK
2026
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002027 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002028 141 common/cmd_ide.c FIT image format OK
2029
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002030 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002031 151 common/cmd_nand.c FIT image format OK
2032
2033
wdenkc6097192002-11-03 00:24:07 +00002034Modem Support:
2035--------------
2036
wdenk8dba0502003-03-31 16:34:49 +00002037[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002038
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002039- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002040 CONFIG_MODEM_SUPPORT
2041
2042- RTS/CTS Flow control enable:
2043 CONFIG_HWFLOW
2044
2045- Modem debug support:
2046 CONFIG_MODEM_SUPPORT_DEBUG
2047
wdenk4a5c8a72003-03-06 00:02:04 +00002048 Enables debugging stuff (char screen[1024], dbg())
2049 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002050
wdenkc0aa5c52003-12-06 19:49:23 +00002051- Interrupt support (PPC):
2052
wdenk1ebf41e2004-01-02 14:00:00 +00002053 There are common interrupt_init() and timer_interrupt()
2054 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002055 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002056 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002057 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002058 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002059 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002060 specific handling. If board has watchdog / status_led
2061 / other_activity_monitor it works automatically from
2062 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002063
wdenkc6097192002-11-03 00:24:07 +00002064- General:
2065
wdenk4a5c8a72003-03-06 00:02:04 +00002066 In the target system modem support is enabled when a
2067 specific key (key combination) is pressed during
2068 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002069 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00002070 board_init(). Currently key_pressed() is a dummy
2071 function, returning 1 and thus enabling modem
2072 initialization.
wdenkc6097192002-11-03 00:24:07 +00002073
wdenk4a5c8a72003-03-06 00:02:04 +00002074 If there are no modem init strings in the
2075 environment, U-Boot proceed to autoboot; the
2076 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002077 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002078
2079 See also: doc/README.Modem
2080
2081
wdenkc6097192002-11-03 00:24:07 +00002082Configuration Settings:
2083-----------------------
2084
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002085- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002086 undefine this when you're short of memory.
2087
Peter Tyserdfb72b82009-01-27 18:03:12 -06002088- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2089 width of the commands listed in the 'help' command output.
2090
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002091- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002092 prompt for user input.
2093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002094- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002095
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002096- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002097
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002098- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002099
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002100- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002101 the application (usually a Linux kernel) when it is
2102 booted
2103
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002104- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002105 List of legal baudrate settings for this board.
2106
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002107- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00002108 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002109
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002110- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00002111 If the board specific function
2112 extern int overwrite_console (void);
2113 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002114 serial port, else the settings in the environment are used.
2115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002116- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00002117 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002118
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002119- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002120 Enable overwrite of previous console environment settings.
2121
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002122- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002123 Begin and End addresses of the area used by the
2124 simple memory test.
2125
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002126- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002127 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002128
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002129- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002130 Scratch address used by the alternate memory test
2131 You only need to set this if address zero isn't writeable
2132
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002133- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2134 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002135 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002136 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002137 fixing up gd->ram_size the Linux kernel should gets passed
2138 the now "corrected" memory size and won't touch it either.
2139 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002140 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002141 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002142 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002143
2144 This option can be used as a workaround for the 440EPx/GRx
2145 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2146 be touched.
2147
2148 WARNING: Please make sure that this value is a multiple of
2149 the Linux page size (normally 4k). If this is not the case,
2150 then the end address of the Linux memory will be located at a
2151 non page size aligned address and this could cause major
2152 problems.
2153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002154- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002155 Default load address for network file downloads
2156
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002157- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002158 Enable temporary baudrate change while serial download
2159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002160- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002161 Physical start address of SDRAM. _Must_ be 0 here.
2162
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002163- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002164 Physical start address of Motherboard I/O (if using a
2165 Cogent motherboard)
2166
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002167- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002168 Physical start address of Flash memory.
2169
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002170- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002171 Physical start address of boot monitor code (set by
2172 make config files to be same as the text base address
2173 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002174 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002175
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002176- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002177 Size of memory reserved for monitor code, used to
2178 determine _at_compile_time_ (!) if the environment is
2179 embedded within the U-Boot image, or in a separate
2180 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002181
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002182- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002183 Size of DRAM reserved for malloc() use.
2184
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002185- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002186 Normally compressed uImages are limited to an
2187 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002188 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002189 to adjust this setting to your needs.
2190
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002191- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002192 Maximum size of memory mapped by the startup code of
2193 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002194 the Linux kernel (bd_info, boot arguments, FDT blob if
2195 used) must be put below this limit, unless "bootm_low"
2196 enviroment variable is defined and non-zero. In such case
2197 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002198 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002199
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002200- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002201 Max number of Flash memory banks
2202
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002203- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002204 Max number of sectors on a Flash chip
2205
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002206- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002207 Timeout for Flash erase operations (in ms)
2208
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002209- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002210 Timeout for Flash write operations (in ms)
2211
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002212- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002213 Timeout for Flash set sector lock bit operation (in ms)
2214
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002215- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002216 Timeout for Flash clear lock bits operation (in ms)
2217
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002218- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002219 If defined, hardware flash sectors protection is used
2220 instead of U-Boot software protection.
2221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002222- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002223
2224 Enable TFTP transfers directly to flash memory;
2225 without this option such a download has to be
2226 performed in two steps: (1) download to RAM, and (2)
2227 copy from RAM to flash.
2228
2229 The two-step approach is usually more reliable, since
2230 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002231 the flash, but in some situations (when system RAM is
2232 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002233 downloaded image) this option may be very useful.
2234
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002235- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002236 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002237 common flash structure for storing flash geometry.
2238
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002239- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002240 This option also enables the building of the cfi_flash driver
2241 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002242
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002243- CONFIG_FLASH_CFI_MTD
2244 This option enables the building of the cfi_mtd driver
2245 in the drivers directory. The driver exports CFI flash
2246 to the MTD layer.
2247
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002248- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002249 Use buffered writes to flash.
2250
2251- CONFIG_FLASH_SPANSION_S29WS_N
2252 s29ws-n MirrorBit flash has non-standard addresses for buffered
2253 write commands.
2254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002255- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002256 If this option is defined, the common CFI flash doesn't
2257 print it's warning upon not recognized FLASH banks. This
2258 is useful, if some of the configured banks are only
2259 optionally available.
2260
Jerry Van Barenaae73572008-03-08 13:48:01 -05002261- CONFIG_FLASH_SHOW_PROGRESS
2262 If defined (must be an integer), print out countdown
2263 digits and dots. Recommended value: 45 (9..1) for 80
2264 column displays, 15 (3..1) for 40 column displays.
2265
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002266- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002267 Defines the number of Ethernet receive buffers. On some
2268 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002269 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2270 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002271 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002272 Defaults to 4 if not defined.
2273
wdenkc6097192002-11-03 00:24:07 +00002274The following definitions that deal with the placement and management
2275of environment data (variable area); in general, we support the
2276following configurations:
2277
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002278- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002279
2280 Define this if the environment is in flash memory.
2281
2282 a) The environment occupies one whole flash sector, which is
2283 "embedded" in the text segment with the U-Boot code. This
2284 happens usually with "bottom boot sector" or "top boot
2285 sector" type flash chips, which have several smaller
2286 sectors at the start or the end. For instance, such a
2287 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2288 such a case you would place the environment in one of the
2289 4 kB sectors - with U-Boot code before and after it. With
2290 "top boot sector" type flash chips, you would put the
2291 environment in one of the last sectors, leaving a gap
2292 between U-Boot and the environment.
2293
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002294 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002295
2296 Offset of environment data (variable area) to the
2297 beginning of flash memory; for instance, with bottom boot
2298 type flash chips the second sector can be used: the offset
2299 for this sector is given here.
2300
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002301 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002302
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002303 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002304
2305 This is just another way to specify the start address of
2306 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002307 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002308
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002309 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002310
2311 Size of the sector containing the environment.
2312
2313
2314 b) Sometimes flash chips have few, equal sized, BIG sectors.
2315 In such a case you don't want to spend a whole sector for
2316 the environment.
2317
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002318 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002319
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002320 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002321 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002322 of this flash sector for the environment. This saves
2323 memory for the RAM copy of the environment.
2324
2325 It may also save flash memory if you decide to use this
2326 when your environment is "embedded" within U-Boot code,
2327 since then the remainder of the flash sector could be used
2328 for U-Boot code. It should be pointed out that this is
2329 STRONGLY DISCOURAGED from a robustness point of view:
2330 updating the environment in flash makes it always
2331 necessary to erase the WHOLE sector. If something goes
2332 wrong before the contents has been restored from a copy in
2333 RAM, your target system will be dead.
2334
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002335 - CONFIG_ENV_ADDR_REDUND
2336 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002337
wdenk4a5c8a72003-03-06 00:02:04 +00002338 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002339 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00002340 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00002341 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002342
2343BE CAREFUL! Any changes to the flash layout, and some changes to the
2344source code will make it necessary to adapt <board>/u-boot.lds*
2345accordingly!
2346
2347
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02002348- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002349
2350 Define this if you have some non-volatile memory device
2351 (NVRAM, battery buffered SRAM) which you want to use for the
2352 environment.
2353
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002354 - CONFIG_ENV_ADDR:
2355 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002356
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002357 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002358 want to use for environment. It is assumed that this memory
2359 can just be read and written to, without any special
2360 provision.
2361
2362BE CAREFUL! The first access to the environment happens quite early
2363in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002364console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002365U-Boot will hang.
2366
2367Please note that even with NVRAM we still use a copy of the
2368environment in RAM: we could work on NVRAM directly, but we want to
2369keep settings there always unmodified except somebody uses "saveenv"
2370to save the current settings.
2371
2372
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02002373- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002374
2375 Use this if you have an EEPROM or similar serial access
2376 device and a driver for it.
2377
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002378 - CONFIG_ENV_OFFSET:
2379 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002380
2381 These two #defines specify the offset and size of the
2382 environment area within the total memory of your EEPROM.
2383
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002384 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002385 If defined, specified the chip address of the EEPROM device.
2386 The default address is zero.
2387
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002388 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002389 If defined, the number of bits used to address bytes in a
2390 single page in the EEPROM device. A 64 byte page, for example
2391 would require six bits.
2392
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002393 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002394 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00002395 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002397 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002398 The length in bytes of the EEPROM memory array address. Note
2399 that this is NOT the chip address length!
2400
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002401 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00002402 EEPROM chips that implement "address overflow" are ones
2403 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2404 address and the extra bits end up in the "chip address" bit
2405 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2406 byte chips.
2407
2408 Note that we consider the length of the address field to
2409 still be one byte because the extra address bits are hidden
2410 in the chip address.
2411
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002412 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002413 The size in bytes of the EEPROM device.
2414
wdenkc6097192002-11-03 00:24:07 +00002415
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02002416- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00002417
wdenk1ebf41e2004-01-02 14:00:00 +00002418 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00002419 want to use for the environment.
2420
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002421 - CONFIG_ENV_OFFSET:
2422 - CONFIG_ENV_ADDR:
2423 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00002424
2425 These three #defines specify the offset and size of the
2426 environment area within the total memory of your DataFlash placed
2427 at the specified address.
2428
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02002429- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00002430
2431 Define this if you have a NAND device which you want to use
2432 for the environment.
2433
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002434 - CONFIG_ENV_OFFSET:
2435 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00002436
2437 These two #defines specify the offset and size of the environment
2438 area within the first NAND device.
wdenk86765902003-12-06 23:55:10 +00002439
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002440 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002441
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002442 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002443 size used to hold a redundant copy of the environment data,
2444 so that there is a valid backup copy in case there is a
2445 power failure during a "saveenv" operation.
2446
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002447 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2448 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002449 the NAND devices block size.
2450
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02002451- CONFIG_NAND_ENV_DST
2452
2453 Defines address in RAM to which the nand_spl code should copy the
2454 environment. If redundant environment is used, it will be copied to
2455 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2456
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002457- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002458
2459 Defines offset to the initial SPI buffer area in DPRAM. The
2460 area is used at an early stage (ROM part) if the environment
2461 is configured to reside in the SPI EEPROM: We need a 520 byte
2462 scratch DPRAM area. It is used between the two initialization
2463 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2464 to be a good choice since it makes it far enough from the
2465 start of the data area as well as from the stack pointer.
2466
Bruce Adleredecc942007-11-02 13:15:42 -07002467Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002468has been relocated to RAM and a RAM copy of the environment has been
2469created; also, when using EEPROM you will have to use getenv_r()
2470until then to read environment variables.
2471
wdenk8dba0502003-03-31 16:34:49 +00002472The environment is protected by a CRC32 checksum. Before the monitor
2473is relocated into RAM, as a result of a bad CRC you will be working
2474with the compiled-in default environment - *silently*!!! [This is
2475necessary, because the first environment variable we need is the
2476"baudrate" setting for the console - if we have a bad CRC, we don't
2477have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002478
2479Note: once the monitor has been relocated, then it will complain if
2480the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002481use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002482
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002483- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002484 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002485
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002486 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002487 also needs to be defined.
2488
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002489- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002490 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002491
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002492- CONFIG_SYS_64BIT_VSPRINTF:
wdenkf602aa02004-03-13 23:29:43 +00002493 Makes vsprintf (and all *printf functions) support printing
2494 of 64bit values by using the L quantifier
2495
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002496- CONFIG_SYS_64BIT_STRTOUL:
wdenkf602aa02004-03-13 23:29:43 +00002497 Adds simple_strtoull that returns a 64bit value
2498
Ron Madriddfa028a2009-02-18 14:30:44 -08002499- CONFIG_NS16550_MIN_FUNCTIONS:
2500 Define this if you desire to only have use of the NS16550_init
2501 and NS16550_putc functions for the serial driver located at
2502 drivers/serial/ns16550.c. This option is useful for saving
2503 space for already greatly restricted images, including but not
2504 limited to NAND_SPL configurations.
2505
wdenkc6097192002-11-03 00:24:07 +00002506Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002507---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002508
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002509- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002510 Cache Line Size of the CPU.
2511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002512- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002513 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00002514
wdenk9c53f402003-10-15 23:53:47 +00002515 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2516 and RPXsuper) to be able to adjust the position of
2517 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002518
wdenk1272e232002-11-10 22:06:23 +00002519- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002520 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00002521
2522 the default drive number (default value 0)
2523
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002524 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00002525
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002526 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00002527 (default value 1)
2528
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002529 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00002530
wdenk4a5c8a72003-03-06 00:02:04 +00002531 defines the offset of register from address. It
2532 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002533 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00002534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002535 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2536 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00002537 default value.
wdenk1272e232002-11-10 22:06:23 +00002538
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002539 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00002540 fdc_hw_init() is called at the beginning of the FDC
2541 setup. fdc_hw_init() must be provided by the board
2542 source code. It is used to make hardware dependant
2543 initializations.
wdenk1272e232002-11-10 22:06:23 +00002544
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002545- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002546 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00002547 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002548
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002549- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002550
wdenkeb20ad32003-09-05 23:19:14 +00002551 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002552 initial data and stack; please note that this must be
2553 writable memory that is working WITHOUT special
2554 initialization, i. e. you CANNOT use normal RAM which
2555 will become available only after programming the
2556 memory controller and running certain initialization
2557 sequences.
2558
2559 U-Boot uses the following memory types:
2560 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2561 - MPC824X: data cache
2562 - PPC4xx: data cache
2563
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002564- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002565
2566 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002567 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2568 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002569 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002570 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2571 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2572 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2573 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002574
2575 Note:
2576 On the MPC824X (or other systems that use the data
2577 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002578 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002579 point to an otherwise UNUSED address space between
2580 the top of RAM and the start of the PCI space.
2581
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002582- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002583
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002584- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002585
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002586- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002587
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002588- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002589
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002590- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002592- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002593
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002594- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002595 SDRAM timing
2596
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002597- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002598 periodic timer for refresh
2599
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002600- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002601
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002602- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2603 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2604 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2605 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002606 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2607
2608- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002609 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2610 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002611 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2612
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002613- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2614 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002615 Machine Mode Register and Memory Periodic Timer
2616 Prescaler definitions (SDRAM timing)
2617
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002618- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002619 enable I2C microcode relocation patch (MPC8xx);
2620 define relocation offset in DPRAM [DSP2]
2621
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002622- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01002623 enable SMC microcode relocation patch (MPC8xx);
2624 define relocation offset in DPRAM [SMC1]
2625
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002626- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002627 enable SPI microcode relocation patch (MPC8xx);
2628 define relocation offset in DPRAM [SCC4]
2629
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002630- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002631 Use OSCM clock mode on MBX8xx board. Be careful,
2632 wrong setting might damage your board. Read
2633 doc/README.MBX before setting this variable!
2634
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002635- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00002636 Offset of the bootmode word in DPRAM used by post
2637 (Power On Self Tests). This definition overrides
2638 #define'd default value in commproc.h resp.
2639 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00002640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002641- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2642 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2643 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2644 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2645 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2646 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2647 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2648 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
wdenkbf2f8c92003-05-22 22:52:13 +00002649 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2650
Dirk Eibach378d1ca2009-02-09 08:18:34 +01002651- CONFIG_PCI_DISABLE_PCIE:
2652 Disable PCI-Express on systems where it is supported but not
2653 required.
2654
Ben Warren45657152006-09-07 16:50:54 -04002655- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002656 Get DDR timing information from an I2C EEPROM. Common
2657 with pluggable memory modules such as SODIMMs
2658
Ben Warren45657152006-09-07 16:50:54 -04002659 SPD_EEPROM_ADDRESS
2660 I2C address of the SPD EEPROM
2661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002662- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002663 If SPD EEPROM is on an I2C bus other than the first
2664 one, specify here. Note that the value must resolve
2665 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002666
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002667- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002668 Only for 83xx systems. If specified, then DDR should
2669 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002670
wdenk6203e402004-04-18 10:13:26 +00002671- CONFIG_ETHER_ON_FEC[12]
2672 Define to enable FEC[12] on a 8xx series processor.
2673
2674- CONFIG_FEC[12]_PHY
2675 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00002676 to the given FEC; i. e.
2677 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00002678 means that the PHY with address 4 is connected to FEC1
2679
2680 When set to -1, means to probe for first available.
2681
2682- CONFIG_FEC[12]_PHY_NORXERR
2683 The PHY does not have a RXERR line (RMII only).
2684 (so program the FEC to ignore it).
2685
2686- CONFIG_RMII
2687 Enable RMII mode for all FECs.
2688 Note that this is a global option, we can't
2689 have one FEC in standard MII mode and another in RMII mode.
2690
wdenk20c98a62004-04-23 20:32:05 +00002691- CONFIG_CRC32_VERIFY
2692 Add a verify option to the crc32 command.
2693 The syntax is:
2694
2695 => crc32 -v <address> <count> <crc32>
2696
2697 Where address/count indicate a memory area
2698 and crc32 is the correct crc32 which the
2699 area should have.
2700
wdenk64519362004-07-11 17:40:54 +00002701- CONFIG_LOOPW
2702 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002703 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00002704
stroesecc3af832004-12-16 18:46:55 +00002705- CONFIG_MX_CYCLIC
2706 Add the "mdc" and "mwc" memory commands. These are cyclic
2707 "md/mw" commands.
2708 Examples:
2709
wdenk07d7e6b2004-12-16 21:44:03 +00002710 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002711 This command will print 4 bytes (10,11,12,13) each 500 ms.
2712
wdenk07d7e6b2004-12-16 21:44:03 +00002713 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002714 This command will write 12345678 to address 100 all 10 ms.
2715
wdenk07d7e6b2004-12-16 21:44:03 +00002716 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002717 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00002718
wdenk3d3d99f2005-04-04 12:44:11 +00002719- CONFIG_SKIP_LOWLEVEL_INIT
2720- CONFIG_SKIP_RELOCATE_UBOOT
2721
wdenke085e5b2005-04-05 23:32:21 +00002722 [ARM only] If these variables are defined, then
2723 certain low level initializations (like setting up
2724 the memory controller) are omitted and/or U-Boot does
2725 not relocate itself into RAM.
2726 Normally these variables MUST NOT be defined. The
2727 only exception is when U-Boot is loaded (to RAM) by
2728 some other boot loader or by a debugger which
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002729 performs these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00002730
Magnus Lilja1ec96d82009-06-13 20:50:00 +02002731- CONFIG_PRELOADER
2732
2733 Modifies the behaviour of start.S when compiling a loader
2734 that is executed before the actual U-Boot. E.g. when
2735 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00002736
wdenkc6097192002-11-03 00:24:07 +00002737Building the Software:
2738======================
2739
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002740Building U-Boot has been tested in several native build environments
2741and in many different cross environments. Of course we cannot support
2742all possibly existing versions of cross development tools in all
2743(potentially obsolete) versions. In case of tool chain problems we
2744recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2745which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002746
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002747If you are not using a native environment, it is assumed that you
2748have GNU cross compiling tools available in your path. In this case,
2749you must set the environment variable CROSS_COMPILE in your shell.
2750Note that no changes to the Makefile or any other source files are
2751necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002752
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002753 $ CROSS_COMPILE=ppc_4xx-
2754 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002755
Peter Tyserb06976d2009-03-13 18:54:51 -05002756Note: If you wish to generate Windows versions of the utilities in
2757 the tools directory you can use the MinGW toolchain
2758 (http://www.mingw.org). Set your HOST tools to the MinGW
2759 toolchain and execute 'make tools'. For example:
2760
2761 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2762
2763 Binaries such as tools/mkimage.exe will be created which can
2764 be executed on computers running Windows.
2765
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002766U-Boot is intended to be simple to build. After installing the
2767sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002768is done by typing:
2769
2770 make NAME_config
2771
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002772where "NAME_config" is the name of one of the existing configu-
2773rations; see the main Makefile for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00002774
wdenk6c59edc2004-05-03 20:45:30 +00002775Note: for some board special configuration names may exist; check if
2776 additional information is available from the board vendor; for
2777 instance, the TQM823L systems are available without (standard)
2778 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002779 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002780
wdenk6c59edc2004-05-03 20:45:30 +00002781 make TQM823L_config
2782 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002783
wdenk6c59edc2004-05-03 20:45:30 +00002784 make TQM823L_LCD_config
2785 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002786
wdenk6c59edc2004-05-03 20:45:30 +00002787 etc.
wdenkc6097192002-11-03 00:24:07 +00002788
wdenkc6097192002-11-03 00:24:07 +00002789
wdenk6c59edc2004-05-03 20:45:30 +00002790Finally, type "make all", and you should get some working U-Boot
2791images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002792
wdenk6c59edc2004-05-03 20:45:30 +00002793- "u-boot.bin" is a raw binary image
2794- "u-boot" is an image in ELF binary format
2795- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002796
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002797By default the build is performed locally and the objects are saved
2798in the source directory. One of the two methods can be used to change
2799this behavior and build U-Boot to some external directory:
2800
28011. Add O= to the make command line invocations:
2802
2803 make O=/tmp/build distclean
2804 make O=/tmp/build NAME_config
2805 make O=/tmp/build all
2806
28072. Set environment variable BUILD_DIR to point to the desired location:
2808
2809 export BUILD_DIR=/tmp/build
2810 make distclean
2811 make NAME_config
2812 make all
2813
2814Note that the command line "O=" setting overrides the BUILD_DIR environment
2815variable.
2816
wdenkc6097192002-11-03 00:24:07 +00002817
wdenk6c59edc2004-05-03 20:45:30 +00002818Please be aware that the Makefiles assume you are using GNU make, so
2819for instance on NetBSD you might need to use "gmake" instead of
2820native "make".
wdenkc6097192002-11-03 00:24:07 +00002821
wdenkc6097192002-11-03 00:24:07 +00002822
wdenk6c59edc2004-05-03 20:45:30 +00002823If the system board that you have is not listed, then you will need
2824to port U-Boot to your hardware platform. To do this, follow these
2825steps:
wdenkc6097192002-11-03 00:24:07 +00002826
wdenk6c59edc2004-05-03 20:45:30 +000028271. Add a new configuration option for your board to the toplevel
2828 "Makefile" and to the "MAKEALL" script, using the existing
2829 entries as examples. Note that here and at many other places
2830 boards and other names are listed in alphabetical sort order. Please
2831 keep this order.
28322. Create a new directory to hold your board specific code. Add any
2833 files you need. In your board directory, you will need at least
2834 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
28353. Create a new configuration file "include/configs/<board>.h" for
2836 your board
28373. If you're porting U-Boot to a new CPU, then also create a new
2838 directory to hold your CPU specific code. Add any files you need.
28394. Run "make <board>_config" with your new name.
28405. Type "make", and you should get a working "u-boot.srec" file
2841 to be installed on your target system.
28426. Debug and solve any problems that might arise.
2843 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002844
wdenkc6097192002-11-03 00:24:07 +00002845
wdenk6c59edc2004-05-03 20:45:30 +00002846Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2847==============================================================
wdenkc6097192002-11-03 00:24:07 +00002848
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002849If you have modified U-Boot sources (for instance added a new board
2850or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00002851provide feedback to the other developers. The feedback normally takes
2852the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002853official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002854
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002855But before you submit such a patch, please verify that your modifi-
2856cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00002857the supported boards compile WITHOUT ANY compiler warnings. To do so,
2858just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002859for ALL supported system. Be warned, this will take a while. You can
2860select which (cross) compiler to use by passing a `CROSS_COMPILE'
2861environment variable to the script, i. e. to use the ELDK cross tools
2862you can type
wdenkc6097192002-11-03 00:24:07 +00002863
wdenk6c59edc2004-05-03 20:45:30 +00002864 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002865
wdenk6c59edc2004-05-03 20:45:30 +00002866or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002867
wdenk6c59edc2004-05-03 20:45:30 +00002868 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002869
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002870When using the MAKEALL script, the default behaviour is to build
2871U-Boot in the source directory. This location can be changed by
2872setting the BUILD_DIR environment variable. Also, for each target
2873built, the MAKEALL script saves two log files (<target>.ERR and
2874<target>.MAKEALL) in the <source dir>/LOG directory. This default
2875location can be changed by setting the MAKEALL_LOGDIR environment
2876variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002877
2878 export BUILD_DIR=/tmp/build
2879 export MAKEALL_LOGDIR=/tmp/log
2880 CROSS_COMPILE=ppc_8xx- MAKEALL
2881
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002882With the above settings build objects are saved in the /tmp/build,
2883log files are saved in the /tmp/log and the source tree remains clean
2884during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002885
2886
wdenk6c59edc2004-05-03 20:45:30 +00002887See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002888
wdenkc6097192002-11-03 00:24:07 +00002889
wdenk6c59edc2004-05-03 20:45:30 +00002890Monitor Commands - Overview:
2891============================
wdenkc6097192002-11-03 00:24:07 +00002892
wdenk6c59edc2004-05-03 20:45:30 +00002893go - start application at address 'addr'
2894run - run commands in an environment variable
2895bootm - boot application image from memory
2896bootp - boot image via network using BootP/TFTP protocol
2897tftpboot- boot image via network using TFTP protocol
2898 and env variables "ipaddr" and "serverip"
2899 (and eventually "gatewayip")
2900rarpboot- boot image via network using RARP/TFTP protocol
2901diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2902loads - load S-Record file over serial line
2903loadb - load binary file over serial line (kermit mode)
2904md - memory display
2905mm - memory modify (auto-incrementing)
2906nm - memory modify (constant address)
2907mw - memory write (fill)
2908cp - memory copy
2909cmp - memory compare
2910crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05002911i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00002912sspi - SPI utility commands
2913base - print or set address offset
2914printenv- print environment variables
2915setenv - set environment variables
2916saveenv - save environment variables to persistent storage
2917protect - enable or disable FLASH write protection
2918erase - erase FLASH memory
2919flinfo - print FLASH memory information
2920bdinfo - print Board Info structure
2921iminfo - print header information for application image
2922coninfo - print console devices and informations
2923ide - IDE sub-system
2924loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00002925loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00002926mtest - simple RAM test
2927icache - enable or disable instruction cache
2928dcache - enable or disable data cache
2929reset - Perform RESET of the CPU
2930echo - echo args to console
2931version - print monitor version
2932help - print online help
2933? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002934
wdenkc6097192002-11-03 00:24:07 +00002935
wdenk6c59edc2004-05-03 20:45:30 +00002936Monitor Commands - Detailed Description:
2937========================================
wdenkc6097192002-11-03 00:24:07 +00002938
wdenk6c59edc2004-05-03 20:45:30 +00002939TODO.
wdenkc6097192002-11-03 00:24:07 +00002940
wdenk6c59edc2004-05-03 20:45:30 +00002941For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002942
2943
wdenk6c59edc2004-05-03 20:45:30 +00002944Environment Variables:
2945======================
wdenkc6097192002-11-03 00:24:07 +00002946
wdenk6c59edc2004-05-03 20:45:30 +00002947U-Boot supports user configuration using Environment Variables which
2948can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002949
wdenk6c59edc2004-05-03 20:45:30 +00002950Environment Variables are set using "setenv", printed using
2951"printenv", and saved to Flash using "saveenv". Using "setenv"
2952without a value can be used to delete a variable from the
2953environment. As long as you don't save the environment you are
2954working with an in-memory copy. In case the Flash area containing the
2955environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002956
wdenk6c59edc2004-05-03 20:45:30 +00002957Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002958
wdenk6c59edc2004-05-03 20:45:30 +00002959 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002960
wdenk6c59edc2004-05-03 20:45:30 +00002961 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002962
wdenk6c59edc2004-05-03 20:45:30 +00002963 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002964
wdenk6c59edc2004-05-03 20:45:30 +00002965 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002966
wdenk6c59edc2004-05-03 20:45:30 +00002967 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002968
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002969 bootm_low - Memory range available for image processing in the bootm
2970 command can be restricted. This variable is given as
2971 a hexadecimal number and defines lowest address allowed
2972 for use by the bootm command. See also "bootm_size"
2973 environment variable. Address defined by "bootm_low" is
2974 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002975 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002976
2977 bootm_size - Memory range available for image processing in the bootm
2978 command can be restricted. This variable is given as
2979 a hexadecimal number and defines the size of the region
2980 allowed for use by the bootm command. See also "bootm_low"
2981 environment variable.
2982
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02002983 updatefile - Location of the software update file on a TFTP server, used
2984 by the automatic software update feature. Please refer to
2985 documentation in doc/README.update for more details.
2986
wdenk6c59edc2004-05-03 20:45:30 +00002987 autoload - if set to "no" (any string beginning with 'n'),
2988 "bootp" will just load perform a lookup of the
2989 configuration from the BOOTP server, but not try to
2990 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002991
Marian Balakowicz18710b82008-03-12 12:13:13 +01002992 autoscript - if set to "yes" commands like "loadb", "loady",
2993 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
2994 to automatically run script images (by internally
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002995 calling "source").
Marian Balakowicz18710b82008-03-12 12:13:13 +01002996
2997 autoscript_uname - if script image is in a format (FIT) this
2998 variable is used to get script subimage unit name.
2999
wdenk6c59edc2004-05-03 20:45:30 +00003000 autostart - if set to "yes", an image loaded using the "bootp",
3001 "rarpboot", "tftpboot" or "diskboot" commands will
3002 be automatically started (by internally calling
3003 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003004
wdenk6c59edc2004-05-03 20:45:30 +00003005 If set to "no", a standalone image passed to the
3006 "bootm" command will be copied to the load address
3007 (and eventually uncompressed), but NOT be started.
3008 This can be used to load and uncompress arbitrary
3009 data.
wdenkc6097192002-11-03 00:24:07 +00003010
wdenk0e2bd9c2004-06-06 21:51:03 +00003011 i2cfast - (PPC405GP|PPC405EP only)
3012 if set to 'y' configures Linux I2C driver for fast
3013 mode (400kHZ). This environment variable is used in
3014 initialization code. So, for changes to be effective
3015 it must be saved and board must be reset.
3016
wdenk6c59edc2004-05-03 20:45:30 +00003017 initrd_high - restrict positioning of initrd images:
3018 If this variable is not set, initrd images will be
3019 copied to the highest possible address in RAM; this
3020 is usually what you want since it allows for
3021 maximum initrd size. If for some reason you want to
3022 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003023 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00003024 variable to a value of "no" or "off" or "0".
3025 Alternatively, you can set it to a maximum upper
3026 address to use (U-Boot will still check that it
3027 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003028
wdenk6c59edc2004-05-03 20:45:30 +00003029 For instance, when you have a system with 16 MB
3030 RAM, and want to reserve 4 MB from use by Linux,
3031 you can do this by adding "mem=12M" to the value of
3032 the "bootargs" variable. However, now you must make
3033 sure that the initrd image is placed in the first
3034 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003035
wdenk6c59edc2004-05-03 20:45:30 +00003036 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003037
wdenk6c59edc2004-05-03 20:45:30 +00003038 If you set initrd_high to 0xFFFFFFFF, this is an
3039 indication to U-Boot that all addresses are legal
3040 for the Linux kernel, including addresses in flash
3041 memory. In this case U-Boot will NOT COPY the
3042 ramdisk at all. This may be useful to reduce the
3043 boot time on your system, but requires that this
3044 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00003045
wdenk6c59edc2004-05-03 20:45:30 +00003046 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003047
wdenk6c59edc2004-05-03 20:45:30 +00003048 loadaddr - Default load address for commands like "bootp",
3049 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003050
wdenk6c59edc2004-05-03 20:45:30 +00003051 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003052
wdenk6c59edc2004-05-03 20:45:30 +00003053 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003054
wdenk6c59edc2004-05-03 20:45:30 +00003055 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003056
wdenk6c59edc2004-05-03 20:45:30 +00003057 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003058
wdenk6c59edc2004-05-03 20:45:30 +00003059 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003060
wdenk6c59edc2004-05-03 20:45:30 +00003061 ethprime - When CONFIG_NET_MULTI is enabled controls which
3062 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003063
wdenk6c59edc2004-05-03 20:45:30 +00003064 ethact - When CONFIG_NET_MULTI is enabled controls which
3065 interface is currently active. For example you
3066 can do the following
wdenkc6097192002-11-03 00:24:07 +00003067
wdenk6c59edc2004-05-03 20:45:30 +00003068 => setenv ethact FEC ETHERNET
3069 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3070 => setenv ethact SCC ETHERNET
3071 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00003072
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003073 ethrotate - When set to "no" U-Boot does not go through all
3074 available network interfaces.
3075 It just stays at the currently selected interface.
3076
wdenk6c59edc2004-05-03 20:45:30 +00003077 netretry - When set to "no" each network operation will
3078 either succeed or fail without retrying.
3079 When set to "once" the network operation will
3080 fail when all the available network interfaces
3081 are tried once without success.
3082 Useful on scripts which control the retry operation
3083 themselves.
wdenkc6097192002-11-03 00:24:07 +00003084
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003085 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003086
Wolfgang Denk227b5192005-09-24 23:25:46 +02003087 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003088 UDP source port.
3089
Wolfgang Denk227b5192005-09-24 23:25:46 +02003090 tftpdstport - If this is set, the value is used for TFTP's UDP
3091 destination port instead of the Well Know Port 69.
3092
wdenk6c59edc2004-05-03 20:45:30 +00003093 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003094 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003095 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003096
wdenk6c59edc2004-05-03 20:45:30 +00003097The following environment variables may be used and automatically
3098updated by the network boot commands ("bootp" and "rarpboot"),
3099depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003100
wdenk6c59edc2004-05-03 20:45:30 +00003101 bootfile - see above
3102 dnsip - IP address of your Domain Name Server
3103 dnsip2 - IP address of your secondary Domain Name Server
3104 gatewayip - IP address of the Gateway (Router) to use
3105 hostname - Target hostname
3106 ipaddr - see above
3107 netmask - Subnet Mask
3108 rootpath - Pathname of the root filesystem on the NFS server
3109 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003110
wdenk145d2c12004-04-15 21:48:45 +00003111
wdenk6c59edc2004-05-03 20:45:30 +00003112There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003113
wdenk6c59edc2004-05-03 20:45:30 +00003114 serial# - contains hardware identification information such
3115 as type string and/or serial number
3116 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003117
wdenk6c59edc2004-05-03 20:45:30 +00003118These variables can be set only once (usually during manufacturing of
3119the board). U-Boot refuses to delete or overwrite these variables
3120once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003121
3122
wdenk6c59edc2004-05-03 20:45:30 +00003123Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003124
wdenk6c59edc2004-05-03 20:45:30 +00003125 ver - Contains the U-Boot version string as printed
3126 with the "version" command. This variable is
3127 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003128
wdenkc6097192002-11-03 00:24:07 +00003129
wdenk6c59edc2004-05-03 20:45:30 +00003130Please note that changes to some configuration parameters may take
3131only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003132
stroeseb9c17c52003-04-04 15:53:41 +00003133
wdenk6c59edc2004-05-03 20:45:30 +00003134Command Line Parsing:
3135=====================
stroeseb9c17c52003-04-04 15:53:41 +00003136
wdenk6c59edc2004-05-03 20:45:30 +00003137There are two different command line parsers available with U-Boot:
3138the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003139
wdenk6c59edc2004-05-03 20:45:30 +00003140Old, simple command line parser:
3141--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003142
wdenk6c59edc2004-05-03 20:45:30 +00003143- supports environment variables (through setenv / saveenv commands)
3144- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003145- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003146- special characters ('$', ';') can be escaped by prefixing with '\',
3147 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003148 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003149- You can also escape text by enclosing in single apostrophes, for example:
3150 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003151
wdenk6c59edc2004-05-03 20:45:30 +00003152Hush shell:
3153-----------
wdenkf4688a22003-05-28 08:06:31 +00003154
wdenk6c59edc2004-05-03 20:45:30 +00003155- similar to Bourne shell, with control structures like
3156 if...then...else...fi, for...do...done; while...do...done,
3157 until...do...done, ...
3158- supports environment ("global") variables (through setenv / saveenv
3159 commands) and local shell variables (through standard shell syntax
3160 "name=value"); only environment variables can be used with "run"
3161 command
wdenkf4688a22003-05-28 08:06:31 +00003162
wdenk6c59edc2004-05-03 20:45:30 +00003163General rules:
3164--------------
wdenkf4688a22003-05-28 08:06:31 +00003165
wdenk6c59edc2004-05-03 20:45:30 +00003166(1) If a command line (or an environment variable executed by a "run"
3167 command) contains several commands separated by semicolon, and
3168 one of these commands fails, then the remaining commands will be
3169 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003170
wdenk6c59edc2004-05-03 20:45:30 +00003171(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003172 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003173 command will cause "run" to terminate, i. e. the remaining
3174 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003175
wdenk6c59edc2004-05-03 20:45:30 +00003176Note for Redundant Ethernet Interfaces:
3177=======================================
wdenkf4688a22003-05-28 08:06:31 +00003178
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003179Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003180such configurations and is capable of automatic selection of a
3181"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003182
wdenk6c59edc2004-05-03 20:45:30 +00003183Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3184MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3185"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003186
wdenk6c59edc2004-05-03 20:45:30 +00003187If the network interface stores some valid MAC address (for instance
3188in SROM), this is used as default address if there is NO correspon-
3189ding setting in the environment; if the corresponding environment
3190variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003191
wdenk6c59edc2004-05-03 20:45:30 +00003192o If the SROM has a valid MAC address, and there is no address in the
3193 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003194
wdenk6c59edc2004-05-03 20:45:30 +00003195o If there is no valid address in the SROM, and a definition in the
3196 environment exists, then the value from the environment variable is
3197 used.
wdenkc6097192002-11-03 00:24:07 +00003198
wdenk6c59edc2004-05-03 20:45:30 +00003199o If both the SROM and the environment contain a MAC address, and
3200 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003201
wdenk6c59edc2004-05-03 20:45:30 +00003202o If both the SROM and the environment contain a MAC address, and the
3203 addresses differ, the value from the environment is used and a
3204 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003205
wdenk6c59edc2004-05-03 20:45:30 +00003206o If neither SROM nor the environment contain a MAC address, an error
3207 is raised.
wdenkc6097192002-11-03 00:24:07 +00003208
wdenkc6097192002-11-03 00:24:07 +00003209
wdenk6c59edc2004-05-03 20:45:30 +00003210Image Formats:
3211==============
wdenkc6097192002-11-03 00:24:07 +00003212
Marian Balakowicz18710b82008-03-12 12:13:13 +01003213U-Boot is capable of booting (and performing other auxiliary operations on)
3214images in two formats:
3215
3216New uImage format (FIT)
3217-----------------------
3218
3219Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3220to Flattened Device Tree). It allows the use of images with multiple
3221components (several kernels, ramdisks, etc.), with contents protected by
3222SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3223
3224
3225Old uImage format
3226-----------------
3227
3228Old image format is based on binary files which can be basically anything,
3229preceded by a special header; see the definitions in include/image.h for
3230details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003231
wdenk6c59edc2004-05-03 20:45:30 +00003232* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3233 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003234 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3235 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3236 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02003237* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk6c59edc2004-05-03 20:45:30 +00003238 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk83c15852006-10-24 14:21:16 +02003239 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003240* Compression Type (uncompressed, gzip, bzip2)
3241* Load Address
3242* Entry Point
3243* Image Name
3244* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003245
wdenk6c59edc2004-05-03 20:45:30 +00003246The header is marked by a special Magic Number, and both the header
3247and the data portions of the image are secured against corruption by
3248CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003249
wdenkc6097192002-11-03 00:24:07 +00003250
wdenk6c59edc2004-05-03 20:45:30 +00003251Linux Support:
3252==============
wdenkc6097192002-11-03 00:24:07 +00003253
wdenk6c59edc2004-05-03 20:45:30 +00003254Although U-Boot should support any OS or standalone application
3255easily, the main focus has always been on Linux during the design of
3256U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003257
wdenk6c59edc2004-05-03 20:45:30 +00003258U-Boot includes many features that so far have been part of some
3259special "boot loader" code within the Linux kernel. Also, any
3260"initrd" images to be used are no longer part of one big Linux image;
3261instead, kernel and "initrd" are separate images. This implementation
3262serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003263
wdenk6c59edc2004-05-03 20:45:30 +00003264- the same features can be used for other OS or standalone
3265 applications (for instance: using compressed images to reduce the
3266 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003267
wdenk6c59edc2004-05-03 20:45:30 +00003268- it becomes much easier to port new Linux kernel versions because
3269 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003270
wdenk6c59edc2004-05-03 20:45:30 +00003271- the same Linux kernel image can now be used with different "initrd"
3272 images; of course this also means that different kernel images can
3273 be run with the same "initrd". This makes testing easier (you don't
3274 have to build a new "zImage.initrd" Linux image when you just
3275 change a file in your "initrd"). Also, a field-upgrade of the
3276 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003277
wdenkc6097192002-11-03 00:24:07 +00003278
wdenk6c59edc2004-05-03 20:45:30 +00003279Linux HOWTO:
3280============
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk6c59edc2004-05-03 20:45:30 +00003282Porting Linux to U-Boot based systems:
3283---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003284
wdenk6c59edc2004-05-03 20:45:30 +00003285U-Boot cannot save you from doing all the necessary modifications to
3286configure the Linux device drivers for use with your target hardware
3287(no, we don't intend to provide a full virtual machine interface to
3288Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003289
wdenk6c59edc2004-05-03 20:45:30 +00003290But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003291
wdenk6c59edc2004-05-03 20:45:30 +00003292Just make sure your machine specific header file (for instance
3293include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003294Information structure as we define in include/asm-<arch>/u-boot.h,
3295and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003296as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003297
wdenkc6097192002-11-03 00:24:07 +00003298
wdenk6c59edc2004-05-03 20:45:30 +00003299Configuring the Linux kernel:
3300-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003301
wdenk6c59edc2004-05-03 20:45:30 +00003302No specific requirements for U-Boot. Make sure you have some root
3303device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003304
wdenkc6097192002-11-03 00:24:07 +00003305
wdenk6c59edc2004-05-03 20:45:30 +00003306Building a Linux Image:
3307-----------------------
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk6c59edc2004-05-03 20:45:30 +00003309With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3310not used. If you use recent kernel source, a new build target
3311"uImage" will exist which automatically builds an image usable by
3312U-Boot. Most older kernels also have support for a "pImage" target,
3313which was introduced for our predecessor project PPCBoot and uses a
3314100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003315
wdenk6c59edc2004-05-03 20:45:30 +00003316Example:
wdenkc6097192002-11-03 00:24:07 +00003317
wdenk6c59edc2004-05-03 20:45:30 +00003318 make TQM850L_config
3319 make oldconfig
3320 make dep
3321 make uImage
wdenkc6097192002-11-03 00:24:07 +00003322
wdenk6c59edc2004-05-03 20:45:30 +00003323The "uImage" build target uses a special tool (in 'tools/mkimage') to
3324encapsulate a compressed Linux kernel image with header information,
3325CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003326
wdenk6c59edc2004-05-03 20:45:30 +00003327* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk6c59edc2004-05-03 20:45:30 +00003329* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk6c59edc2004-05-03 20:45:30 +00003331 ${CROSS_COMPILE}-objcopy -O binary \
3332 -R .note -R .comment \
3333 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003334
wdenk6c59edc2004-05-03 20:45:30 +00003335* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003336
wdenk6c59edc2004-05-03 20:45:30 +00003337 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003338
wdenk6c59edc2004-05-03 20:45:30 +00003339* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003340
wdenk6c59edc2004-05-03 20:45:30 +00003341 mkimage -A ppc -O linux -T kernel -C gzip \
3342 -a 0 -e 0 -n "Linux Kernel Image" \
3343 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003344
wdenkc6097192002-11-03 00:24:07 +00003345
wdenk6c59edc2004-05-03 20:45:30 +00003346The "mkimage" tool can also be used to create ramdisk images for use
3347with U-Boot, either separated from the Linux kernel image, or
3348combined into one file. "mkimage" encapsulates the images with a 64
3349byte header containing information about target architecture,
3350operating system, image type, compression method, entry points, time
3351stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003352
wdenk6c59edc2004-05-03 20:45:30 +00003353"mkimage" can be called in two ways: to verify existing images and
3354print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003355
wdenk6c59edc2004-05-03 20:45:30 +00003356In the first form (with "-l" option) mkimage lists the information
3357contained in the header of an existing U-Boot image; this includes
3358checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003359
wdenk6c59edc2004-05-03 20:45:30 +00003360 tools/mkimage -l image
3361 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003362
wdenk6c59edc2004-05-03 20:45:30 +00003363The second form (with "-d" option) is used to build a U-Boot image
3364from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003365
wdenk6c59edc2004-05-03 20:45:30 +00003366 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3367 -n name -d data_file image
3368 -A ==> set architecture to 'arch'
3369 -O ==> set operating system to 'os'
3370 -T ==> set image type to 'type'
3371 -C ==> set compression type 'comp'
3372 -a ==> set load address to 'addr' (hex)
3373 -e ==> set entry point to 'ep' (hex)
3374 -n ==> set image name to 'name'
3375 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003376
wdenkcd914452004-05-29 16:53:29 +00003377Right now, all Linux kernels for PowerPC systems use the same load
3378address (0x00000000), but the entry point address depends on the
3379kernel version:
wdenkc6097192002-11-03 00:24:07 +00003380
wdenk6c59edc2004-05-03 20:45:30 +00003381- 2.2.x kernels have the entry point at 0x0000000C,
3382- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003383
wdenk6c59edc2004-05-03 20:45:30 +00003384So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003385
wdenk6c59edc2004-05-03 20:45:30 +00003386 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3387 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3388 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3389 > examples/uImage.TQM850L
3390 Image Name: 2.4.4 kernel for TQM850L
3391 Created: Wed Jul 19 02:34:59 2000
3392 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3393 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3394 Load Address: 0x00000000
3395 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003396
wdenk6c59edc2004-05-03 20:45:30 +00003397To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003398
wdenk6c59edc2004-05-03 20:45:30 +00003399 -> tools/mkimage -l examples/uImage.TQM850L
3400 Image Name: 2.4.4 kernel for TQM850L
3401 Created: Wed Jul 19 02:34:59 2000
3402 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3403 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3404 Load Address: 0x00000000
3405 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003406
wdenk6c59edc2004-05-03 20:45:30 +00003407NOTE: for embedded systems where boot time is critical you can trade
3408speed for memory and install an UNCOMPRESSED image instead: this
3409needs more space in Flash, but boots much faster since it does not
3410need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003411
wdenk6c59edc2004-05-03 20:45:30 +00003412 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3413 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3414 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3415 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3416 > examples/uImage.TQM850L-uncompressed
3417 Image Name: 2.4.4 kernel for TQM850L
3418 Created: Wed Jul 19 02:34:59 2000
3419 Image Type: PowerPC Linux Kernel Image (uncompressed)
3420 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3421 Load Address: 0x00000000
3422 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003423
wdenkc6097192002-11-03 00:24:07 +00003424
wdenk6c59edc2004-05-03 20:45:30 +00003425Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3426when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003427
wdenk6c59edc2004-05-03 20:45:30 +00003428 -> tools/mkimage -n 'Simple Ramdisk Image' \
3429 > -A ppc -O linux -T ramdisk -C gzip \
3430 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3431 Image Name: Simple Ramdisk Image
3432 Created: Wed Jan 12 14:01:50 2000
3433 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3434 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3435 Load Address: 0x00000000
3436 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003437
wdenkc6097192002-11-03 00:24:07 +00003438
wdenk6c59edc2004-05-03 20:45:30 +00003439Installing a Linux Image:
3440-------------------------
wdenkc6097192002-11-03 00:24:07 +00003441
wdenk6c59edc2004-05-03 20:45:30 +00003442To downloading a U-Boot image over the serial (console) interface,
3443you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003444
wdenk6c59edc2004-05-03 20:45:30 +00003445 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003446
wdenk6c59edc2004-05-03 20:45:30 +00003447The 'objcopy' does not understand the information in the U-Boot
3448image header, so the resulting S-Record file will be relative to
3449address 0x00000000. To load it to a given address, you need to
3450specify the target address as 'offset' parameter with the 'loads'
3451command.
wdenkc6097192002-11-03 00:24:07 +00003452
wdenk6c59edc2004-05-03 20:45:30 +00003453Example: install the image to address 0x40100000 (which on the
3454TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk6c59edc2004-05-03 20:45:30 +00003456 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003457
wdenk6c59edc2004-05-03 20:45:30 +00003458 .......... done
3459 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003460
wdenk6c59edc2004-05-03 20:45:30 +00003461 => loads 40100000
3462 ## Ready for S-Record download ...
3463 ~>examples/image.srec
3464 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3465 ...
3466 15989 15990 15991 15992
3467 [file transfer complete]
3468 [connected]
3469 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003470
wdenkc6097192002-11-03 00:24:07 +00003471
wdenk6c59edc2004-05-03 20:45:30 +00003472You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003473this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00003474corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003475
wdenk6c59edc2004-05-03 20:45:30 +00003476 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003477
wdenk6c59edc2004-05-03 20:45:30 +00003478 ## Checking Image at 40100000 ...
3479 Image Name: 2.2.13 for initrd on TQM850L
3480 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3481 Data Size: 335725 Bytes = 327 kB = 0 MB
3482 Load Address: 00000000
3483 Entry Point: 0000000c
3484 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003485
3486
wdenk6c59edc2004-05-03 20:45:30 +00003487Boot Linux:
3488-----------
wdenkc6097192002-11-03 00:24:07 +00003489
wdenk6c59edc2004-05-03 20:45:30 +00003490The "bootm" command is used to boot an application that is stored in
3491memory (RAM or Flash). In case of a Linux kernel image, the contents
3492of the "bootargs" environment variable is passed to the kernel as
3493parameters. You can check and modify this variable using the
3494"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003495
wdenkc6097192002-11-03 00:24:07 +00003496
wdenk6c59edc2004-05-03 20:45:30 +00003497 => printenv bootargs
3498 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003499
wdenk6c59edc2004-05-03 20:45:30 +00003500 => 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 +00003501
wdenk6c59edc2004-05-03 20:45:30 +00003502 => printenv bootargs
3503 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 +00003504
wdenk6c59edc2004-05-03 20:45:30 +00003505 => bootm 40020000
3506 ## Booting Linux kernel at 40020000 ...
3507 Image Name: 2.2.13 for NFS on TQM850L
3508 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3509 Data Size: 381681 Bytes = 372 kB = 0 MB
3510 Load Address: 00000000
3511 Entry Point: 0000000c
3512 Verifying Checksum ... OK
3513 Uncompressing Kernel Image ... OK
3514 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
3515 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3516 time_init: decrementer frequency = 187500000/60
3517 Calibrating delay loop... 49.77 BogoMIPS
3518 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3519 ...
wdenkc6097192002-11-03 00:24:07 +00003520
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003521If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00003522the memory addresses of both the kernel and the initrd image (PPBCOOT
3523format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003524
wdenk6c59edc2004-05-03 20:45:30 +00003525 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003526
wdenk6c59edc2004-05-03 20:45:30 +00003527 ## Checking Image at 40100000 ...
3528 Image Name: 2.2.13 for initrd on TQM850L
3529 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3530 Data Size: 335725 Bytes = 327 kB = 0 MB
3531 Load Address: 00000000
3532 Entry Point: 0000000c
3533 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003534
wdenk6c59edc2004-05-03 20:45:30 +00003535 ## Checking Image at 40200000 ...
3536 Image Name: Simple Ramdisk Image
3537 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3538 Data Size: 566530 Bytes = 553 kB = 0 MB
3539 Load Address: 00000000
3540 Entry Point: 00000000
3541 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003542
wdenk6c59edc2004-05-03 20:45:30 +00003543 => bootm 40100000 40200000
3544 ## Booting Linux kernel at 40100000 ...
3545 Image Name: 2.2.13 for initrd on TQM850L
3546 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3547 Data Size: 335725 Bytes = 327 kB = 0 MB
3548 Load Address: 00000000
3549 Entry Point: 0000000c
3550 Verifying Checksum ... OK
3551 Uncompressing Kernel Image ... OK
3552 ## Loading RAMDisk Image at 40200000 ...
3553 Image Name: Simple Ramdisk Image
3554 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3555 Data Size: 566530 Bytes = 553 kB = 0 MB
3556 Load Address: 00000000
3557 Entry Point: 00000000
3558 Verifying Checksum ... OK
3559 Loading Ramdisk ... OK
3560 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
3561 Boot arguments: root=/dev/ram
3562 time_init: decrementer frequency = 187500000/60
3563 Calibrating delay loop... 49.77 BogoMIPS
3564 ...
3565 RAMDISK: Compressed image found at block 0
3566 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003567
wdenk6c59edc2004-05-03 20:45:30 +00003568 bash#
wdenkc6097192002-11-03 00:24:07 +00003569
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003570Boot Linux and pass a flat device tree:
3571-----------
3572
3573First, U-Boot must be compiled with the appropriate defines. See the section
3574titled "Linux Kernel Interface" above for a more in depth explanation. The
3575following is an example of how to start a kernel and pass an updated
3576flat device tree:
3577
3578=> print oftaddr
3579oftaddr=0x300000
3580=> print oft
3581oft=oftrees/mpc8540ads.dtb
3582=> tftp $oftaddr $oft
3583Speed: 1000, full duplex
3584Using TSEC0 device
3585TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3586Filename 'oftrees/mpc8540ads.dtb'.
3587Load address: 0x300000
3588Loading: #
3589done
3590Bytes transferred = 4106 (100a hex)
3591=> tftp $loadaddr $bootfile
3592Speed: 1000, full duplex
3593Using TSEC0 device
3594TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3595Filename 'uImage'.
3596Load address: 0x200000
3597Loading:############
3598done
3599Bytes transferred = 1029407 (fb51f hex)
3600=> print loadaddr
3601loadaddr=200000
3602=> print oftaddr
3603oftaddr=0x300000
3604=> bootm $loadaddr - $oftaddr
3605## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01003606 Image Name: Linux-2.6.17-dirty
3607 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3608 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003609 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01003610 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003611 Verifying Checksum ... OK
3612 Uncompressing Kernel Image ... OK
3613Booting using flat device tree at 0x300000
3614Using MPC85xx ADS machine description
3615Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3616[snip]
3617
3618
wdenk6c59edc2004-05-03 20:45:30 +00003619More About U-Boot Image Types:
3620------------------------------
wdenkc6097192002-11-03 00:24:07 +00003621
wdenk6c59edc2004-05-03 20:45:30 +00003622U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00003623
wdenk6c59edc2004-05-03 20:45:30 +00003624 "Standalone Programs" are directly runnable in the environment
3625 provided by U-Boot; it is expected that (if they behave
3626 well) you can continue to work in U-Boot after return from
3627 the Standalone Program.
3628 "OS Kernel Images" are usually images of some Embedded OS which
3629 will take over control completely. Usually these programs
3630 will install their own set of exception handlers, device
3631 drivers, set up the MMU, etc. - this means, that you cannot
3632 expect to re-enter U-Boot except by resetting the CPU.
3633 "RAMDisk Images" are more or less just data blocks, and their
3634 parameters (address, size) are passed to an OS kernel that is
3635 being started.
3636 "Multi-File Images" contain several images, typically an OS
3637 (Linux) kernel image and one or more data images like
3638 RAMDisks. This construct is useful for instance when you want
3639 to boot over the network using BOOTP etc., where the boot
3640 server provides just a single image file, but you want to get
3641 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00003642
wdenk6c59edc2004-05-03 20:45:30 +00003643 "Multi-File Images" start with a list of image sizes, each
3644 image size (in bytes) specified by an "uint32_t" in network
3645 byte order. This list is terminated by an "(uint32_t)0".
3646 Immediately after the terminating 0 follow the images, one by
3647 one, all aligned on "uint32_t" boundaries (size rounded up to
3648 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00003649
wdenk6c59edc2004-05-03 20:45:30 +00003650 "Firmware Images" are binary images containing firmware (like
3651 U-Boot or FPGA images) which usually will be programmed to
3652 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00003653
wdenk6c59edc2004-05-03 20:45:30 +00003654 "Script files" are command sequences that will be executed by
3655 U-Boot's command interpreter; this feature is especially
3656 useful when you configure U-Boot to use a real shell (hush)
3657 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00003658
stroeseb9c17c52003-04-04 15:53:41 +00003659
wdenk6c59edc2004-05-03 20:45:30 +00003660Standalone HOWTO:
3661=================
stroeseb9c17c52003-04-04 15:53:41 +00003662
wdenk6c59edc2004-05-03 20:45:30 +00003663One of the features of U-Boot is that you can dynamically load and
3664run "standalone" applications, which can use some resources of
3665U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00003666
wdenk6c59edc2004-05-03 20:45:30 +00003667Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00003668
wdenk6c59edc2004-05-03 20:45:30 +00003669"Hello World" Demo:
3670-------------------
wdenkc6097192002-11-03 00:24:07 +00003671
wdenk6c59edc2004-05-03 20:45:30 +00003672'examples/hello_world.c' contains a small "Hello World" Demo
3673application; it is automatically compiled when you build U-Boot.
3674It's configured to run at address 0x00040004, so you can play with it
3675like that:
wdenkc6097192002-11-03 00:24:07 +00003676
wdenk6c59edc2004-05-03 20:45:30 +00003677 => loads
3678 ## Ready for S-Record download ...
3679 ~>examples/hello_world.srec
3680 1 2 3 4 5 6 7 8 9 10 11 ...
3681 [file transfer complete]
3682 [connected]
3683 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk6c59edc2004-05-03 20:45:30 +00003685 => go 40004 Hello World! This is a test.
3686 ## Starting application at 0x00040004 ...
3687 Hello World
3688 argc = 7
3689 argv[0] = "40004"
3690 argv[1] = "Hello"
3691 argv[2] = "World!"
3692 argv[3] = "This"
3693 argv[4] = "is"
3694 argv[5] = "a"
3695 argv[6] = "test."
3696 argv[7] = "<NULL>"
3697 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003698
wdenk6c59edc2004-05-03 20:45:30 +00003699 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003700
wdenk6c59edc2004-05-03 20:45:30 +00003701Another example, which demonstrates how to register a CPM interrupt
3702handler with the U-Boot code, can be found in 'examples/timer.c'.
3703Here, a CPM timer is set up to generate an interrupt every second.
3704The interrupt service routine is trivial, just printing a '.'
3705character, but this is just a demo program. The application can be
3706controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003707
wdenk6c59edc2004-05-03 20:45:30 +00003708 ? - print current values og the CPM Timer registers
3709 b - enable interrupts and start timer
3710 e - stop timer and disable interrupts
3711 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk6c59edc2004-05-03 20:45:30 +00003713 => loads
3714 ## Ready for S-Record download ...
3715 ~>examples/timer.srec
3716 1 2 3 4 5 6 7 8 9 10 11 ...
3717 [file transfer complete]
3718 [connected]
3719 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003720
wdenk6c59edc2004-05-03 20:45:30 +00003721 => go 40004
3722 ## Starting application at 0x00040004 ...
3723 TIMERS=0xfff00980
3724 Using timer 1
3725 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003726
wdenk6c59edc2004-05-03 20:45:30 +00003727Hit 'b':
3728 [q, b, e, ?] Set interval 1000000 us
3729 Enabling timer
3730Hit '?':
3731 [q, b, e, ?] ........
3732 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3733Hit '?':
3734 [q, b, e, ?] .
3735 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3736Hit '?':
3737 [q, b, e, ?] .
3738 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3739Hit '?':
3740 [q, b, e, ?] .
3741 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3742Hit 'e':
3743 [q, b, e, ?] ...Stopping timer
3744Hit 'q':
3745 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003746
wdenkc6097192002-11-03 00:24:07 +00003747
wdenk6c59edc2004-05-03 20:45:30 +00003748Minicom warning:
3749================
wdenkc6097192002-11-03 00:24:07 +00003750
wdenk6c59edc2004-05-03 20:45:30 +00003751Over time, many people have reported problems when trying to use the
3752"minicom" terminal emulation program for serial download. I (wd)
3753consider minicom to be broken, and recommend not to use it. Under
3754Unix, I recommend to use C-Kermit for general purpose use (and
3755especially for kermit binary protocol download ("loadb" command), and
3756use "cu" for S-Record download ("loads" command).
wdenkc6097192002-11-03 00:24:07 +00003757
wdenk6c59edc2004-05-03 20:45:30 +00003758Nevertheless, if you absolutely want to use it try adding this
3759configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00003760
wdenk6c59edc2004-05-03 20:45:30 +00003761 Name Program Name U/D FullScr IO-Red. Multi
3762 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3763 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00003764
wdenk8dba0502003-03-31 16:34:49 +00003765
wdenk6c59edc2004-05-03 20:45:30 +00003766NetBSD Notes:
3767=============
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk6c59edc2004-05-03 20:45:30 +00003769Starting at version 0.9.2, U-Boot supports NetBSD both as host
3770(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00003771
wdenk6c59edc2004-05-03 20:45:30 +00003772Building requires a cross environment; it is known to work on
3773NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3774need gmake since the Makefiles are not compatible with BSD make).
3775Note that the cross-powerpc package does not install include files;
3776attempting to build U-Boot will fail because <machine/ansi.h> is
3777missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00003778
wdenk6c59edc2004-05-03 20:45:30 +00003779 # cd /usr/pkg/cross/powerpc-netbsd/include
3780 # mkdir powerpc
3781 # ln -s powerpc machine
3782 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3783 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00003784
wdenk6c59edc2004-05-03 20:45:30 +00003785Native builds *don't* work due to incompatibilities between native
3786and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003787
wdenk6c59edc2004-05-03 20:45:30 +00003788Booting assumes that (the first part of) the image booted is a
3789stage-2 loader which in turn loads and then invokes the kernel
3790proper. Loader sources will eventually appear in the NetBSD source
3791tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00003792meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003793
wdenkc6097192002-11-03 00:24:07 +00003794
wdenk6c59edc2004-05-03 20:45:30 +00003795Implementation Internals:
3796=========================
wdenkc6097192002-11-03 00:24:07 +00003797
wdenk6c59edc2004-05-03 20:45:30 +00003798The following is not intended to be a complete description of every
3799implementation detail. However, it should help to understand the
3800inner workings of U-Boot and make it easier to port it to custom
3801hardware.
wdenkc6097192002-11-03 00:24:07 +00003802
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk6c59edc2004-05-03 20:45:30 +00003804Initial Stack, Global Data:
3805---------------------------
wdenkc6097192002-11-03 00:24:07 +00003806
wdenk6c59edc2004-05-03 20:45:30 +00003807The implementation of U-Boot is complicated by the fact that U-Boot
3808starts running out of ROM (flash memory), usually without access to
3809system RAM (because the memory controller is not initialized yet).
3810This means that we don't have writable Data or BSS segments, and BSS
3811is not initialized as zero. To be able to get a C environment working
3812at all, we have to allocate at least a minimal stack. Implementation
3813options for this are defined and restricted by the CPU used: Some CPU
3814models provide on-chip memory (like the IMMR area on MPC8xx and
3815MPC826x processors), on others (parts of) the data cache can be
3816locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003817
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003818 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003819 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk6c59edc2004-05-03 20:45:30 +00003821 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3822 From: "Chris Hallinan" <clh@net1plus.com>
3823 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3824 ...
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk6c59edc2004-05-03 20:45:30 +00003826 Correct me if I'm wrong, folks, but the way I understand it
3827 is this: Using DCACHE as initial RAM for Stack, etc, does not
3828 require any physical RAM backing up the cache. The cleverness
3829 is that the cache is being used as a temporary supply of
3830 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003831 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00003832 can see how this works by studying the cache architecture and
3833 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00003834
wdenk6c59edc2004-05-03 20:45:30 +00003835 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3836 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003837 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00003838 option should work for you. Using CS 4 should be fine if your
3839 board designers haven't used it for something that would
3840 cause you grief during the initial boot! It is frequently not
3841 used.
wdenkc6097192002-11-03 00:24:07 +00003842
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003843 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00003844 with your processor/board/system design. The default value
3845 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02003846 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00003847 than your SDRAM module. If you have a 64MB SDRAM module, set
3848 it above 400_0000. Just make sure your board has no resources
3849 that are supposed to respond to that address! That code in
3850 start.S has been around a while and should work as is when
3851 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00003852
wdenk6c59edc2004-05-03 20:45:30 +00003853 -Chris Hallinan
3854 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00003855
wdenk6c59edc2004-05-03 20:45:30 +00003856It is essential to remember this, since it has some impact on the C
3857code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00003858
wdenk6c59edc2004-05-03 20:45:30 +00003859* Initialized global data (data segment) is read-only. Do not attempt
3860 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00003861
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003862* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00003863 as zero data - BSS segment) at all - this is undefined, initiali-
3864 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00003865
wdenk6c59edc2004-05-03 20:45:30 +00003866* Stack space is very limited. Avoid big data buffers or things like
3867 that.
wdenk4a5c8a72003-03-06 00:02:04 +00003868
wdenk6c59edc2004-05-03 20:45:30 +00003869Having only the stack as writable memory limits means we cannot use
3870normal global data to share information beween the code. But it
3871turned out that the implementation of U-Boot can be greatly
3872simplified by making a global data structure (gd_t) available to all
3873functions. We could pass a pointer to this data as argument to _all_
3874functions, but this would bloat the code. Instead we use a feature of
3875the GCC compiler (Global Register Variables) to share the data: we
3876place a pointer (gd) to the global data into a register which we
3877reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003878
wdenk6c59edc2004-05-03 20:45:30 +00003879When choosing a register for such a purpose we are restricted by the
3880relevant (E)ABI specifications for the current architecture, and by
3881GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk6c59edc2004-05-03 20:45:30 +00003883For PowerPC, the following registers have specific use:
3884 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01003885 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00003886 R3-R4: parameter passing and return values
3887 R5-R10: parameter passing
3888 R13: small data area pointer
3889 R30: GOT pointer
3890 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk6c59edc2004-05-03 20:45:30 +00003892 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003893
Wolfgang Denk69c09642008-02-14 22:43:22 +01003894 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk6c59edc2004-05-03 20:45:30 +00003896 Note: on PPC, we could use a static initializer (since the
3897 address of the global data structure is known at compile time),
3898 but it turned out that reserving a register results in somewhat
3899 smaller code - although the code savings are not that big (on
3900 average for all boards 752 bytes for the whole U-Boot image,
3901 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003902
Mike Frysinger60f09302008-02-04 19:26:54 -05003903On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3904 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3905
3906 ==> U-Boot will use P5 to hold a pointer to the global data
3907
wdenk6c59edc2004-05-03 20:45:30 +00003908On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003909
wdenk6c59edc2004-05-03 20:45:30 +00003910 R0: function argument word/integer result
3911 R1-R3: function argument word
3912 R9: GOT pointer
3913 R10: stack limit (used only if stack checking if enabled)
3914 R11: argument (frame) pointer
3915 R12: temporary workspace
3916 R13: stack pointer
3917 R14: link register
3918 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk6c59edc2004-05-03 20:45:30 +00003920 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003921
Wolfgang Denk6405a152006-03-31 18:32:53 +02003922NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3923or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003924
wdenk6c59edc2004-05-03 20:45:30 +00003925Memory Management:
3926------------------
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk6c59edc2004-05-03 20:45:30 +00003928U-Boot runs in system state and uses physical addresses, i.e. the
3929MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk6c59edc2004-05-03 20:45:30 +00003931The available memory is mapped to fixed addresses using the memory
3932controller. In this process, a contiguous block is formed for each
3933memory type (Flash, SDRAM, SRAM), even when it consists of several
3934physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003935
wdenk6c59edc2004-05-03 20:45:30 +00003936U-Boot is installed in the first 128 kB of the first Flash bank (on
3937TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3938booting and sizing and initializing DRAM, the code relocates itself
3939to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003940memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00003941configuration setting]. Below that, a structure with global Board
3942Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk6c59edc2004-05-03 20:45:30 +00003944Additionally, some exception handler code is copied to the low 8 kB
3945of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk6c59edc2004-05-03 20:45:30 +00003947So a typical memory configuration with 16 MB of DRAM could look like
3948this:
wdenkc6097192002-11-03 00:24:07 +00003949
wdenk6c59edc2004-05-03 20:45:30 +00003950 0x0000 0000 Exception Vector code
3951 :
3952 0x0000 1FFF
3953 0x0000 2000 Free for Application Use
3954 :
3955 :
wdenkc6097192002-11-03 00:24:07 +00003956
wdenk6c59edc2004-05-03 20:45:30 +00003957 :
3958 :
3959 0x00FB FF20 Monitor Stack (Growing downward)
3960 0x00FB FFAC Board Info Data and permanent copy of global data
3961 0x00FC 0000 Malloc Arena
3962 :
3963 0x00FD FFFF
3964 0x00FE 0000 RAM Copy of Monitor Code
3965 ... eventually: LCD or video framebuffer
3966 ... eventually: pRAM (Protected RAM - unchanged by reset)
3967 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003968
wdenkc6097192002-11-03 00:24:07 +00003969
wdenk6c59edc2004-05-03 20:45:30 +00003970System Initialization:
3971----------------------
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk6c59edc2004-05-03 20:45:30 +00003973In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003974(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00003975configuration for CS0# this is a mirror of the onboard Flash memory.
3976To be able to re-map memory U-Boot then jumps to its link address.
3977To be able to implement the initialization code in C, a (small!)
3978initial stack is set up in the internal Dual Ported RAM (in case CPUs
3979which provide such a feature like MPC8xx or MPC8260), or in a locked
3980part of the data cache. After that, U-Boot initializes the CPU core,
3981the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003982
wdenk6c59edc2004-05-03 20:45:30 +00003983Next, all (potentially) available memory banks are mapped using a
3984preliminary mapping. For example, we put them on 512 MB boundaries
3985(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3986on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3987programmed for SDRAM access. Using the temporary configuration, a
3988simple memory test is run that determines the size of the SDRAM
3989banks.
wdenkc6097192002-11-03 00:24:07 +00003990
wdenk6c59edc2004-05-03 20:45:30 +00003991When there is more than one SDRAM bank, and the banks are of
3992different size, the largest is mapped first. For equal size, the first
3993bank (CS2#) is mapped first. The first mapping is always for address
39940x00000000, with any additional banks following immediately to create
3995contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003996
wdenk6c59edc2004-05-03 20:45:30 +00003997Then, the monitor installs itself at the upper end of the SDRAM area
3998and allocates memory for use by malloc() and for the global Board
3999Info data; also, the exception vector code is copied to the low RAM
4000pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004001
wdenk6c59edc2004-05-03 20:45:30 +00004002Only after this relocation will you have a "normal" C environment;
4003until that you are restricted in several ways, mostly because you are
4004running from ROM, and because the code will have to be relocated to a
4005new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004006
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk6c59edc2004-05-03 20:45:30 +00004008U-Boot Porting Guide:
4009----------------------
wdenkc6097192002-11-03 00:24:07 +00004010
wdenk6c59edc2004-05-03 20:45:30 +00004011[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4012list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004013
wdenkc6097192002-11-03 00:24:07 +00004014
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004015int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00004016{
4017 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004018
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004019 signal(SIGALRM, no_more_time);
4020 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk6c59edc2004-05-03 20:45:30 +00004022 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004023 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00004024 return 0;
4025 }
wdenkc6097192002-11-03 00:24:07 +00004026
wdenk6c59edc2004-05-03 20:45:30 +00004027 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00004028
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004029 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00004030
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004031 if (clueless)
4032 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk6c59edc2004-05-03 20:45:30 +00004034 while (learning) {
4035 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004036 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4037 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00004038 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004039 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00004040 }
wdenkc6097192002-11-03 00:24:07 +00004041
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004042 if (available_money > toLocalCurrency ($2500))
4043 Buy a BDI3000;
4044 else
wdenk6c59edc2004-05-03 20:45:30 +00004045 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00004046
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004047 if (a similar board exists) { /* hopefully... */
4048 cp -a board/<similar> board/<myboard>
4049 cp include/configs/<similar>.h include/configs/<myboard>.h
4050 } else {
4051 Create your own board support subdirectory;
4052 Create your own board include/configs/<myboard>.h file;
4053 }
4054 Edit new board/<myboard> files
4055 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004056
Jerry Van Barenba0687c2009-07-15 20:42:59 -04004057 while (!accepted) {
4058 while (!running) {
4059 do {
4060 Add / modify source code;
4061 } until (compiles);
4062 Debug;
4063 if (clueless)
4064 email("Hi, I am having problems...");
4065 }
4066 Send patch file to the U-Boot email list;
4067 if (reasonable critiques)
4068 Incorporate improvements from email list code review;
4069 else
4070 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00004071 }
wdenkc6097192002-11-03 00:24:07 +00004072
wdenk6c59edc2004-05-03 20:45:30 +00004073 return 0;
4074}
wdenkc6097192002-11-03 00:24:07 +00004075
wdenk6c59edc2004-05-03 20:45:30 +00004076void no_more_time (int sig)
4077{
4078 hire_a_guru();
4079}
wdenkc6097192002-11-03 00:24:07 +00004080
wdenkc6097192002-11-03 00:24:07 +00004081
wdenk6c59edc2004-05-03 20:45:30 +00004082Coding Standards:
4083-----------------
wdenkc6097192002-11-03 00:24:07 +00004084
wdenk6c59edc2004-05-03 20:45:30 +00004085All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02004086coding style; see the file "Documentation/CodingStyle" and the script
4087"scripts/Lindent" in your Linux kernel source directory. In sources
4088originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4089spaces before parameters to function calls) is actually used.
4090
4091Source files originating from a different project (for example the
4092MTD subsystem) are generally exempt from these guidelines and are not
4093reformated to ease subsequent migration to newer versions of those
4094sources.
wdenkc6097192002-11-03 00:24:07 +00004095
Detlev Zundelaa63d482006-09-01 15:39:02 +02004096Please note that U-Boot is implemented in C (and to some small parts in
4097Assembler); no C++ is used, so please do not use C++ style comments (//)
4098in your code.
wdenkad276f22004-01-04 16:28:35 +00004099
wdenk6c59edc2004-05-03 20:45:30 +00004100Please also stick to the following formatting rules:
4101- remove any trailing white space
4102- use TAB characters for indentation, not spaces
4103- make sure NOT to use DOS '\r\n' line feeds
4104- do not add more than 2 empty lines to source files
4105- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004106
wdenk6c59edc2004-05-03 20:45:30 +00004107Submissions which do not conform to the standards may be returned
4108with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004109
wdenkc6097192002-11-03 00:24:07 +00004110
wdenk6c59edc2004-05-03 20:45:30 +00004111Submitting Patches:
4112-------------------
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk6c59edc2004-05-03 20:45:30 +00004114Since the number of patches for U-Boot is growing, we need to
4115establish some rules. Submissions which do not conform to these rules
4116may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004117
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004118Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004119
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004120Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4121see http://lists.denx.de/mailman/listinfo/u-boot
4122
wdenk6c59edc2004-05-03 20:45:30 +00004123When you send a patch, please include the following information with
4124it:
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk6c59edc2004-05-03 20:45:30 +00004126* For bug fixes: a description of the bug and how your patch fixes
4127 this bug. Please try to include a way of demonstrating that the
4128 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk6c59edc2004-05-03 20:45:30 +00004130* For new features: a description of the feature and your
4131 implementation.
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk6c59edc2004-05-03 20:45:30 +00004133* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00004134
wdenk6c59edc2004-05-03 20:45:30 +00004135* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk6c59edc2004-05-03 20:45:30 +00004137* When you add support for a new board, don't forget to add this
4138 board to the MAKEALL script, too.
wdenkc6097192002-11-03 00:24:07 +00004139
wdenk6c59edc2004-05-03 20:45:30 +00004140* If your patch adds new configuration options, don't forget to
4141 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004142
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004143* The patch itself. If you are using git (which is *strongly*
4144 recommended) you can easily generate the patch using the
4145 "git-format-patch". If you then use "git-send-email" to send it to
4146 the U-Boot mailing list, you will avoid most of the common problems
4147 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004148
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004149 If you cannot use git, use "diff -purN OLD NEW". If your version of
4150 diff does not support these options, then get the latest version of
4151 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004152
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004153 The current directory when running this command shall be the parent
4154 directory of the U-Boot source tree (i. e. please make sure that
4155 your patch includes sufficient directory information for the
4156 affected files).
4157
4158 We prefer patches as plain text. MIME attachments are discouraged,
4159 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004160
wdenk6c59edc2004-05-03 20:45:30 +00004161* If one logical set of modifications affects or creates several
4162 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004163
wdenk6c59edc2004-05-03 20:45:30 +00004164* Changesets that contain different, unrelated modifications shall be
4165 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004166
wdenkc6097192002-11-03 00:24:07 +00004167
wdenk6c59edc2004-05-03 20:45:30 +00004168Notes:
wdenkc6097192002-11-03 00:24:07 +00004169
wdenk6c59edc2004-05-03 20:45:30 +00004170* Before sending the patch, run the MAKEALL script on your patched
4171 source tree and make sure that no errors or warnings are reported
4172 for any of the boards.
4173
4174* Keep your modifications to the necessary minimum: A patch
4175 containing several unrelated changes or arbitrary reformats will be
4176 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004177
wdenk6c59edc2004-05-03 20:45:30 +00004178* If you modify existing code, make sure that your new code does not
4179 add to the memory footprint of the code ;-) Small is beautiful!
4180 When adding new features, these should compile conditionally only
4181 (using #ifdef), and the resulting code with the new feature
4182 disabled must not need more memory than the old code without your
4183 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004184
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004185* Remember that there is a size limit of 100 kB per message on the
4186 u-boot mailing list. Bigger patches will be moderated. If they are
4187 reasonable and not too big, they will be acknowledged. But patches
4188 bigger than the size limit should be avoided.