blob: fcadf3f0c65ad17246fbb428e1802cad5e707b0d [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
TsiChungLiewfc3ca3b2007-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
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100321- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200322 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100323
324 Defines the Monahans run mode to oscillator
325 ratio. Valid values are 8, 16, 24, 31. The core
326 frequency is this value multiplied by 13 MHz.
327
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200328 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200329
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100330 Defines the Monahans turbo mode to oscillator
331 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200332 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100333 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200334
wdenk9b7f3842003-10-09 20:09:04 +0000335- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000336 CONFIG_CLOCKS_IN_MHZ
337
338 U-Boot stores all clock information in Hz
339 internally. For binary compatibility with older Linux
340 kernels (which expect the clocks passed in the
341 bd_info data to be in MHz) the environment variable
342 "clocks_in_mhz" can be defined so that U-Boot
343 converts clock data to MHZ before passing it to the
344 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000345 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100346 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000347 default environment.
348
wdenk9b7f3842003-10-09 20:09:04 +0000349 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
350
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200351 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000352 expect it to be in bytes, others in MB.
353 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
354
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400355 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200356
357 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400358 passed using flattened device trees (based on open firmware
359 concepts).
360
361 CONFIG_OF_LIBFDT
362 * New libfdt-based support
363 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500364 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400365
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200366 OF_CPU - The proper name of the cpus node.
Kumar Galae40c2b52006-01-11 13:59:02 -0600367 OF_SOC - The proper name of the soc node.
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200368 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600369 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200370
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200371 boards with QUICC Engines require OF_QE to set UCC MAC
372 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500373
Kumar Gala1e26aa52006-01-11 13:54:17 -0600374 CONFIG_OF_BOARD_SETUP
375
376 Board code has addition modification that it wants to make
377 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000378
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500379 CONFIG_OF_BOOT_CPU
380
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200381 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500382 param header, the default value is zero if undefined.
383
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100384- vxWorks boot parameters:
385
386 bootvx constructs a valid bootline using the following
387 environments variables: bootfile, ipaddr, serverip, hostname.
388 It loads the vxWorks image pointed bootfile.
389
390 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
391 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
392 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
393 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
394
395 CONFIG_SYS_VXWORKS_ADD_PARAMS
396
397 Add it at the end of the bootline. E.g "u=username pw=secret"
398
399 Note: If a "bootargs" environment is defined, it will overwride
400 the defaults discussed just above.
401
wdenkda04a8b2004-08-02 23:22:59 +0000402- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200403 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000404
405 Define this if you want support for Amba PrimeCell PL010 UARTs.
406
Andreas Engel0813b122008-09-08 14:30:53 +0200407 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000408
409 Define this if you want support for Amba PrimeCell PL011 UARTs.
410
411 CONFIG_PL011_CLOCK
412
413 If you have Amba PrimeCell PL011 UARTs, set this variable to
414 the clock speed of the UARTs.
415
416 CONFIG_PL01x_PORTS
417
418 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
419 define this to a list of base addresses for each (supported)
420 port. See e.g. include/configs/versatile.h
421
422
wdenkc6097192002-11-03 00:24:07 +0000423- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000424 Depending on board, define exactly one serial port
425 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
426 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
427 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000428
429 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
430 port routines must be defined elsewhere
431 (i.e. serial_init(), serial_getc(), ...)
432
433 CONFIG_CFB_CONSOLE
434 Enables console device for a color framebuffer. Needs following
435 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
436 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
437 (default big endian)
438 VIDEO_HW_RECTFILL graphic chip supports
439 rectangle fill
440 (cf. smiLynxEM)
441 VIDEO_HW_BITBLT graphic chip supports
442 bit-blit (cf. smiLynxEM)
443 VIDEO_VISIBLE_COLS visible pixel columns
444 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000445 VIDEO_VISIBLE_ROWS visible pixel rows
446 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000447 VIDEO_DATA_FORMAT graphic data format
448 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000449 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000450 VIDEO_KBD_INIT_FCT keyboard int fct
451 (i.e. i8042_kbd_init())
452 VIDEO_TSTC_FCT test char fct
453 (i.e. i8042_tstc)
454 VIDEO_GETC_FCT get char fct
455 (i.e. i8042_getc)
456 CONFIG_CONSOLE_CURSOR cursor drawing on/off
457 (requires blink timer
458 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200459 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000460 CONFIG_CONSOLE_TIME display time/date info in
461 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500462 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000463 CONFIG_VIDEO_LOGO display Linux logo in
464 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000465 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
466 linux_logo.h for logo.
467 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000468 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200469 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000470 the logo
471
wdenk4a5c8a72003-03-06 00:02:04 +0000472 When CONFIG_CFB_CONSOLE is defined, video console is
473 default i/o. Serial console can be forced with
474 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000475
wdenk1ebf41e2004-01-02 14:00:00 +0000476 When CONFIG_SILENT_CONSOLE is defined, all console
477 messages (by U-Boot and Linux!) can be silenced with
478 the "silent" environment variable. See
479 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000480
wdenkc6097192002-11-03 00:24:07 +0000481- Console Baudrate:
482 CONFIG_BAUDRATE - in bps
483 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200484 CONFIG_SYS_BAUDRATE_TABLE, see below.
485 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000486
Heiko Schocher327480a2009-01-30 12:55:38 +0100487- Console Rx buffer length
488 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
489 the maximum receive buffer length for the SMC.
490 This option is actual only for 82xx possible.
491 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
492 must be defined, to setup the maximum idle timeout for
493 the SMC.
494
wdenkc6097192002-11-03 00:24:07 +0000495- Interrupt driven serial port input:
496 CONFIG_SERIAL_SOFTWARE_FIFO
497
498 PPC405GP only.
499 Use an interrupt handler for receiving data on the
500 serial port. It also enables using hardware handshake
501 (RTS/CTS) and UART's built-in FIFO. Set the number of
502 bytes the interrupt driven input buffer should have.
503
wdenkf16b5162004-03-23 21:43:07 +0000504 Leave undefined to disable this feature, including
505 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000506
stroese3d24d6e2003-05-23 11:39:05 +0000507- Console UART Number:
508 CONFIG_UART1_CONSOLE
509
Wolfgang Denk0ee70772005-09-23 11:05:55 +0200510 AMCC PPC4xx only.
stroese3d24d6e2003-05-23 11:39:05 +0000511 If defined internal UART1 (and not UART0) is used
512 as default U-Boot console.
513
wdenkc6097192002-11-03 00:24:07 +0000514- Boot Delay: CONFIG_BOOTDELAY - in seconds
515 Delay before automatically booting the default image;
516 set to -1 to disable autoboot.
517
518 See doc/README.autoboot for these options that
519 work with CONFIG_BOOTDELAY. None are required.
520 CONFIG_BOOT_RETRY_TIME
521 CONFIG_BOOT_RETRY_MIN
522 CONFIG_AUTOBOOT_KEYED
523 CONFIG_AUTOBOOT_PROMPT
524 CONFIG_AUTOBOOT_DELAY_STR
525 CONFIG_AUTOBOOT_STOP_STR
526 CONFIG_AUTOBOOT_DELAY_STR2
527 CONFIG_AUTOBOOT_STOP_STR2
528 CONFIG_ZERO_BOOTDELAY_CHECK
529 CONFIG_RESET_TO_RETRY
530
531- Autoboot Command:
532 CONFIG_BOOTCOMMAND
533 Only needed when CONFIG_BOOTDELAY is enabled;
534 define a command string that is automatically executed
535 when no character is read on the console interface
536 within "Boot Delay" after reset.
537
538 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000539 This can be used to pass arguments to the bootm
540 command. The value of CONFIG_BOOTARGS goes into the
541 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000542
543 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000544 The value of these goes into the environment as
545 "ramboot" and "nfsboot" respectively, and can be used
546 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200547 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000548
549- Pre-Boot Commands:
550 CONFIG_PREBOOT
551
552 When this option is #defined, the existence of the
553 environment variable "preboot" will be checked
554 immediately before starting the CONFIG_BOOTDELAY
555 countdown and/or running the auto-boot command resp.
556 entering interactive mode.
557
558 This feature is especially useful when "preboot" is
559 automatically generated or modified. For an example
560 see the LWMON board specific code: here "preboot" is
561 modified when the user holds down a certain
562 combination of keys on the (special) keyboard when
563 booting the systems
564
565- Serial Download Echo Mode:
566 CONFIG_LOADS_ECHO
567 If defined to 1, all characters received during a
568 serial download (using the "loads" command) are
569 echoed back. This might be needed by some terminal
570 emulations (like "cu"), but may as well just take
571 time on others. This setting #define's the initial
572 value of the "loads_echo" environment variable.
573
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500574- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000575 CONFIG_KGDB_BAUDRATE
576 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200577 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000578
579- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500580 Monitor commands can be included or excluded
581 from the build by using the #include files
582 "config_cmd_all.h" and #undef'ing unwanted
583 commands, or using "config_cmd_default.h"
584 and augmenting with additional #define's
585 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000586
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500587 The default command configuration includes all commands
588 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000589
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500590 CONFIG_CMD_ASKENV * ask for env variable
591 CONFIG_CMD_AUTOSCRIPT Autoscript Support
592 CONFIG_CMD_BDI bdinfo
593 CONFIG_CMD_BEDBUG * Include BedBug Debugger
594 CONFIG_CMD_BMP * BMP support
595 CONFIG_CMD_BSP * Board specific commands
596 CONFIG_CMD_BOOTD bootd
597 CONFIG_CMD_CACHE * icache, dcache
598 CONFIG_CMD_CONSOLE coninfo
599 CONFIG_CMD_DATE * support for RTC, date/time...
600 CONFIG_CMD_DHCP * DHCP support
601 CONFIG_CMD_DIAG * Diagnostics
602 CONFIG_CMD_DOC * Disk-On-Chip Support
Peter Tyser15258042008-12-17 16:36:22 -0600603 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
604 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
605 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
606 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500607 CONFIG_CMD_DTT * Digital Therm and Thermostat
608 CONFIG_CMD_ECHO echo arguments
609 CONFIG_CMD_EEPROM * EEPROM read/write support
610 CONFIG_CMD_ELF * bootelf, bootvx
611 CONFIG_CMD_ENV saveenv
612 CONFIG_CMD_FDC * Floppy Disk Support
613 CONFIG_CMD_FAT * FAT partition support
614 CONFIG_CMD_FDOS * Dos diskette Support
615 CONFIG_CMD_FLASH flinfo, erase, protect
616 CONFIG_CMD_FPGA FPGA device initialization support
617 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
618 CONFIG_CMD_I2C * I2C serial bus support
619 CONFIG_CMD_IDE * IDE harddisk support
620 CONFIG_CMD_IMI iminfo
621 CONFIG_CMD_IMLS List all found images
622 CONFIG_CMD_IMMAP * IMMR dump support
623 CONFIG_CMD_IRQ * irqinfo
624 CONFIG_CMD_ITEST Integer/string test of 2 values
625 CONFIG_CMD_JFFS2 * JFFS2 Support
626 CONFIG_CMD_KGDB * kgdb
627 CONFIG_CMD_LOADB loadb
628 CONFIG_CMD_LOADS loads
629 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
630 loop, loopw, mtest
631 CONFIG_CMD_MISC Misc functions like sleep etc
632 CONFIG_CMD_MMC * MMC memory mapped support
633 CONFIG_CMD_MII * MII utility commands
634 CONFIG_CMD_NAND * NAND support
635 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600636 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
637 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500638 CONFIG_CMD_PCI * pciinfo
639 CONFIG_CMD_PCMCIA * PCMCIA support
640 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
641 host
642 CONFIG_CMD_PORTIO * Port I/O
643 CONFIG_CMD_REGINFO * Register dump
644 CONFIG_CMD_RUN run command in env variable
645 CONFIG_CMD_SAVES * save S record dump
646 CONFIG_CMD_SCSI * SCSI Support
647 CONFIG_CMD_SDRAM * print SDRAM configuration information
648 (requires CONFIG_CMD_I2C)
649 CONFIG_CMD_SETGETDCR Support for DCR Register access
650 (4xx only)
651 CONFIG_CMD_SPI * SPI serial bus support
652 CONFIG_CMD_USB * USB support
653 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500654 CONFIG_CMD_CDP * Cisco Discover Protocol support
655 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000656
wdenkc6097192002-11-03 00:24:07 +0000657
658 EXAMPLE: If you want all functions except of network
659 support you can write:
660
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500661 #include "config_cmd_all.h"
662 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000663
Gerald Van Barend6abef42007-03-31 12:23:51 -0400664 Other Commands:
665 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000666
667 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500668 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000669 what you (and your U-Boot users) are doing. Data
670 cache cannot be enabled on systems like the 8xx or
671 8260 (where accesses to the IMMR region must be
672 uncached), and it cannot be disabled on all other
673 systems where we (mis-) use the data cache to hold an
674 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000675
676
677 XXX - this list needs to get updated!
678
679- Watchdog:
680 CONFIG_WATCHDOG
681 If this variable is defined, it enables watchdog
wdenkeb20ad32003-09-05 23:19:14 +0000682 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000683 code for a watchdog. For the 8xx and 8260 CPUs, the
684 SIU Watchdog feature is enabled in the SYPCR
685 register.
686
stroeseb9c17c52003-04-04 15:53:41 +0000687- U-Boot Version:
688 CONFIG_VERSION_VARIABLE
689 If this variable is defined, an environment variable
690 named "ver" is created by U-Boot showing the U-Boot
691 version as printed by the "version" command.
692 This variable is readonly.
693
wdenkc6097192002-11-03 00:24:07 +0000694- Real-Time Clock:
695
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500696 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000697 has to be selected, too. Define exactly one of the
698 following options:
699
700 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
701 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetskid4387492008-04-15 14:15:30 +0200702 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000703 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000704 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000705 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000706 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000707 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100708 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000709 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200710 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000711
wdenkb9bbd242003-06-30 16:24:52 +0000712 Note that if the RTC uses I2C, then the I2C interface
713 must also be configured. See I2C Support, below.
714
Peter Tyser9902e422008-12-17 16:36:21 -0600715- GPIO Support:
716 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
717 CONFIG_PCA953X_INFO - enable pca953x info command
718
719 Note that if the GPIO device uses I2C, then the I2C interface
720 must also be configured. See I2C Support, below.
721
wdenkc6097192002-11-03 00:24:07 +0000722- Timestamp Support:
723
wdenk4a5c8a72003-03-06 00:02:04 +0000724 When CONFIG_TIMESTAMP is selected, the timestamp
725 (date and time) of an image is printed by image
726 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500727 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000728
729- Partition Support:
730 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubune6745592008-09-26 11:13:22 -0400731 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000732
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100733 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
734 CONFIG_CMD_SCSI) you must configure support for at
735 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000736
737- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000738 CONFIG_IDE_RESET_ROUTINE - this is defined in several
739 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000740
wdenk369d43d2004-03-14 14:09:05 +0000741 CONFIG_IDE_RESET - is this is defined, IDE Reset will
742 be performed by calling the function
743 ide_set_reset(int reset)
744 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000745
746- ATAPI Support:
747 CONFIG_ATAPI
748
749 Set this to enable ATAPI support.
750
wdenkf602aa02004-03-13 23:29:43 +0000751- LBA48 Support
752 CONFIG_LBA48
753
754 Set this to enable support for disks larger than 137GB
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200755 Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
wdenkf602aa02004-03-13 23:29:43 +0000756 Whithout these , LBA48 support uses 32bit variables and will 'only'
757 support disks up to 2.1TB.
758
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200759 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000760 When enabled, makes the IDE subsystem use 64bit sector addresses.
761 Default is 32bit.
762
wdenkc6097192002-11-03 00:24:07 +0000763- SCSI Support:
764 At the moment only there is only support for the
765 SYM53C8XX SCSI controller; define
766 CONFIG_SCSI_SYM53C8XX to enable it.
767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200768 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
769 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
770 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000771 maximum numbers of LUNs, SCSI ID's and target
772 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200773 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000774
775- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000776 CONFIG_E1000
777 Support for Intel 8254x gigabit chips.
stroese94ef1cf2003-06-05 15:39:44 +0000778
Andre Schwarz68c2a302008-03-06 16:45:44 +0100779 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200780 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +0100781
wdenkc6097192002-11-03 00:24:07 +0000782 CONFIG_EEPRO100
783 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200784 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000785 write routine for first time initialisation.
786
787 CONFIG_TULIP
788 Support for Digital 2114x chips.
789 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
790 modem chip initialisation (KS8761/QS6611).
791
792 CONFIG_NATSEMI
793 Support for National dp83815 chips.
794
795 CONFIG_NS8382X
796 Support for National dp8382[01] gigabit chips.
797
wdenkaa603362003-05-12 21:50:16 +0000798- NETWORK Support (other):
799
800 CONFIG_DRIVER_LAN91C96
801 Support for SMSC's LAN91C96 chips.
802
803 CONFIG_LAN91C96_BASE
804 Define this to hold the physical address
805 of the LAN91C96's I/O space
806
807 CONFIG_LAN91C96_USE_32_BIT
808 Define this to enable 32 bit addressing
809
wdenk3c711762004-06-09 13:37:52 +0000810 CONFIG_DRIVER_SMC91111
811 Support for SMSC's LAN91C111 chip
812
813 CONFIG_SMC91111_BASE
814 Define this to hold the physical address
815 of the device (I/O space)
816
817 CONFIG_SMC_USE_32_BIT
818 Define this if data bus is 32 bits
819
820 CONFIG_SMC_USE_IOFUNCS
821 Define this to use i/o functions instead of macros
822 (some hardware wont work with macros)
823
Jens Gehrlein1dd48252008-05-05 14:06:11 +0200824 CONFIG_DRIVER_SMC911X
825 Support for SMSC's LAN911x and LAN921x chips
826
827 CONFIG_DRIVER_SMC911X_BASE
828 Define this to hold the physical address
829 of the device (I/O space)
830
831 CONFIG_DRIVER_SMC911X_32_BIT
832 Define this if data bus is 32 bits
833
834 CONFIG_DRIVER_SMC911X_16_BIT
835 Define this if data bus is 16 bits. If your processor
836 automatically converts one 32 bit word to two 16 bit
837 words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
838
wdenkc6097192002-11-03 00:24:07 +0000839- USB Support:
840 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +0000841 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000842 CONFIG_USB_UHCI to enable it.
843 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +0000844 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000845 storage devices.
846 Note:
847 Supported are USB Keyboards and USB Floppy drives
848 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +0000849 MPC5200 USB requires additional defines:
850 CONFIG_USB_CLOCK
851 for 528 MHz Clock: 0x0001bbbb
852 CONFIG_USB_CONFIG
853 for differential drivers: 0x00001000
854 for single ended drivers: 0x00005000
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200855 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +0200856 May be defined to allow interrupt polling
857 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +0000858
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200859- USB Device:
860 Define the below if you wish to use the USB console.
861 Once firmware is rebuilt from a serial console issue the
862 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200863 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200864 it has found a new device. The environment variable usbtty
865 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +0200866 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200867 Common Device Class Abstract Control Model serial device.
868 If you select usbtty = gserial you should be able to enumerate
869 a Linux host by
870 # modprobe usbserial vendor=0xVendorID product=0xProductID
871 else if using cdc_acm, simply setting the environment
872 variable usbtty to be cdc_acm should suffice. The following
873 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200874
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200875 CONFIG_USB_DEVICE
876 Define this to build a UDC device
877
878 CONFIG_USB_TTY
879 Define this to have a tty type of device available to
880 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +0200881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200882 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200883 Define this if you want stdin, stdout &/or stderr to
884 be set to usbtty.
885
886 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200887 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200888 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200889 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +0200890
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200891 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200892 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200893 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200894
Wolfgang Denke2601822006-06-14 18:14:56 +0200895 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200896 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200897 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200898 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
899 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
900 should pretend to be a Linux device to it's target host.
901
902 CONFIG_USBD_MANUFACTURER
903 Define this string as the name of your company for
904 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +0200905
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200906 CONFIG_USBD_PRODUCT_NAME
907 Define this string as the name of your product
908 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +0000909
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200910 CONFIG_USBD_VENDORID
911 Define this as your assigned Vendor ID from the USB
912 Implementors Forum. This *must* be a genuine Vendor ID
913 to avoid polluting the USB namespace.
914 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200915
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200916 CONFIG_USBD_PRODUCTID
917 Define this as the unique Product ID
918 for your device
919 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200920
wdenkc6097192002-11-03 00:24:07 +0000921
wdenk7a428cc2003-06-15 22:40:42 +0000922- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +0000923 The MMC controller on the Intel PXA is supported. To
924 enable this define CONFIG_MMC. The MMC can be
925 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +0000926 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500927 enabled with CONFIG_CMD_MMC. The MMC driver also works with
928 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +0000929
wdenkda04a8b2004-08-02 23:22:59 +0000930- Journaling Flash filesystem support:
931 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
932 CONFIG_JFFS2_NAND_DEV
933 Define these for a default partition on a NAND device
934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200935 CONFIG_SYS_JFFS2_FIRST_SECTOR,
936 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +0000937 Define these for a default partition on a NOR device
938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200939 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +0000940 Define this to create an own partition. You have to provide a
941 function struct part_info* jffs2_part_info(int part_num)
942
943 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200944 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +0000945 to disable the command chpart. This is the default when you
946 have not defined a custom partition
947
wdenkc6097192002-11-03 00:24:07 +0000948- Keyboard Support:
949 CONFIG_ISA_KEYBOARD
950
951 Define this to enable standard (PC-Style) keyboard
952 support
953
954 CONFIG_I8042_KBD
955 Standard PC keyboard driver with US (is default) and
956 GERMAN key layout (switch via environment 'keymap=de') support.
957 Export function i8042_kbd_init, i8042_tstc and i8042_getc
958 for cfb_console. Supports cursor blinking.
959
960- Video support:
961 CONFIG_VIDEO
962
963 Define this to enable video support (for output to
964 video).
965
966 CONFIG_VIDEO_CT69000
967
968 Enable Chips & Technologies 69000 Video chip
969
970 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +0000971 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +0000972 video output is selected via environment 'videoout'
973 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
974 assumed.
wdenkc6097192002-11-03 00:24:07 +0000975
wdenkd3602132004-03-25 15:14:43 +0000976 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200977 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +0000978 are possible:
979 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +0000980 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +0000981
982 Colors 640x480 800x600 1024x768 1152x864 1280x1024
983 -------------+---------------------------------------------
984 8 bits | 0x301* 0x303 0x305 0x161 0x307
985 15 bits | 0x310 0x313 0x316 0x162 0x319
986 16 bits | 0x311 0x314 0x317 0x163 0x31A
987 24 bits | 0x312 0x315 0x318 ? 0x31B
988 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000989 (i.e. setenv videomode 317; saveenv; reset;)
990
wdenkd3602132004-03-25 15:14:43 +0000991 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +0100992 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +0000993
994
stroeseb9c17c52003-04-04 15:53:41 +0000995 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +0000996 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +0000997 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
998 or CONFIG_VIDEO_SED13806_16BPP
999
wdenk4e112c12003-06-03 23:54:09 +00001000- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001001 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001002
wdenk57b2d802003-06-27 21:31:46 +00001003 Define this to enable a custom keyboard support.
1004 This simply calls drv_keyboard_init() which must be
1005 defined in your board-specific files.
1006 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001007
wdenkc6097192002-11-03 00:24:07 +00001008- LCD Support: CONFIG_LCD
1009
1010 Define this to enable LCD support (for output to LCD
1011 display); also select one of the supported displays
1012 by defining one of these:
1013
Stelian Popf6f86652008-05-09 21:57:18 +02001014 CONFIG_ATMEL_LCD:
1015
1016 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1017
wdenkc0d54ae2003-11-25 16:55:19 +00001018 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001019
wdenkc0d54ae2003-11-25 16:55:19 +00001020 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001021
wdenkc0d54ae2003-11-25 16:55:19 +00001022 CONFIG_NEC_NL6448BC20
1023
1024 NEC NL6448BC20-08. 6.5", 640x480.
1025 Active, color, single scan.
1026
1027 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001028
wdenkc0d54ae2003-11-25 16:55:19 +00001029 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001030 Active, color, single scan.
1031
1032 CONFIG_SHARP_16x9
1033
1034 Sharp 320x240. Active, color, single scan.
1035 It isn't 16x9, and I am not sure what it is.
1036
1037 CONFIG_SHARP_LQ64D341
1038
1039 Sharp LQ64D341 display, 640x480.
1040 Active, color, single scan.
1041
1042 CONFIG_HLD1045
1043
1044 HLD1045 display, 640x480.
1045 Active, color, single scan.
1046
1047 CONFIG_OPTREX_BW
1048
1049 Optrex CBL50840-2 NF-FW 99 22 M5
1050 or
1051 Hitachi LMG6912RPFC-00T
1052 or
1053 Hitachi SP14Q002
1054
1055 320x240. Black & white.
1056
1057 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001058 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001059
wdenkeb20ad32003-09-05 23:19:14 +00001060- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001061
wdenk57b2d802003-06-27 21:31:46 +00001062 If this option is set, the environment is checked for
1063 a variable "splashimage". If found, the usual display
1064 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001065 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001066 specified in "splashimage" is loaded instead. The
1067 console is redirected to the "nulldev", too. This
1068 allows for a "silent" boot where a splash screen is
1069 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001070
Stefan Roesed9d97742005-09-22 09:04:17 +02001071- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1072
1073 If this option is set, additionally to standard BMP
1074 images, gzipped BMP images can be displayed via the
1075 splashscreen support or the bmp command.
1076
wdenk710e3502003-08-29 20:57:53 +00001077- Compression support:
1078 CONFIG_BZIP2
1079
1080 If this option is set, support for bzip2 compressed
1081 images is included. If not, only uncompressed and gzip
1082 compressed images are supported.
1083
wdenk9c53f402003-10-15 23:53:47 +00001084 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001085 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001086 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001087
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001088 CONFIG_LZMA
1089
1090 If this option is set, support for lzma compressed
1091 images is included.
1092
1093 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1094 requires an amount of dynamic memory that is given by the
1095 formula:
1096
1097 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1098
1099 Where lc and lp stand for, respectively, Literal context bits
1100 and Literal pos bits.
1101
1102 This value is upper-bounded by 14MB in the worst case. Anyway,
1103 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1104 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1105 a very small buffer.
1106
1107 Use the lzmainfo tool to determinate the lc and lp values and
1108 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001109 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001110
wdenk0e2bd9c2004-06-06 21:51:03 +00001111- MII/PHY support:
1112 CONFIG_PHY_ADDR
1113
1114 The address of PHY on MII bus.
1115
1116 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1117
1118 The clock frequency of the MII bus
1119
1120 CONFIG_PHY_GIGE
1121
1122 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001123 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001124
1125 CONFIG_PHY_RESET_DELAY
1126
1127 Some PHY like Intel LXT971A need extra delay after
1128 reset before any MII register access is possible.
1129 For such PHY, set this option to the usec delay
1130 required. (minimum 300usec for LXT971A)
1131
1132 CONFIG_PHY_CMD_DELAY (ppc4xx)
1133
1134 Some PHY like Intel LXT971A need extra delay after
1135 command issued before MII status register can be read
1136
wdenkc6097192002-11-03 00:24:07 +00001137- Ethernet address:
1138 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001139 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001140 CONFIG_ETH2ADDR
1141 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001142 CONFIG_ETH4ADDR
1143 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001144
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001145 Define a default value for Ethernet address to use
1146 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001147 is not determined automatically.
1148
1149- IP address:
1150 CONFIG_IPADDR
1151
1152 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001153 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001154 determined through e.g. bootp.
1155
1156- Server IP address:
1157 CONFIG_SERVERIP
1158
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001159 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001160 server to contact when using the "tftboot" command.
1161
David Updegraff7280da72007-06-11 10:41:07 -05001162- Multicast TFTP Mode:
1163 CONFIG_MCAST_TFTP
1164
1165 Defines whether you want to support multicast TFTP as per
1166 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001167 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001168 driver in use must provide a function: mcast() to join/leave a
1169 multicast group.
1170
1171 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001172- BOOTP Recovery Mode:
1173 CONFIG_BOOTP_RANDOM_DELAY
1174
1175 If you have many targets in a network that try to
1176 boot using BOOTP, you may want to avoid that all
1177 systems send out BOOTP requests at precisely the same
1178 moment (which would happen for instance at recovery
1179 from a power failure, when all systems will try to
1180 boot, thus flooding the BOOTP server. Defining
1181 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1182 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001183 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001184
1185 1st BOOTP request: delay 0 ... 1 sec
1186 2nd BOOTP request: delay 0 ... 2 sec
1187 3rd BOOTP request: delay 0 ... 4 sec
1188 4th and following
1189 BOOTP requests: delay 0 ... 8 sec
1190
stroesee0aadfb2003-08-28 14:17:32 +00001191- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001192 You can fine tune the DHCP functionality by defining
1193 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001194
Jon Loeliger5336a762007-07-09 22:08:34 -05001195 CONFIG_BOOTP_SUBNETMASK
1196 CONFIG_BOOTP_GATEWAY
1197 CONFIG_BOOTP_HOSTNAME
1198 CONFIG_BOOTP_NISDOMAIN
1199 CONFIG_BOOTP_BOOTPATH
1200 CONFIG_BOOTP_BOOTFILESIZE
1201 CONFIG_BOOTP_DNS
1202 CONFIG_BOOTP_DNS2
1203 CONFIG_BOOTP_SEND_HOSTNAME
1204 CONFIG_BOOTP_NTPSERVER
1205 CONFIG_BOOTP_TIMEOFFSET
1206 CONFIG_BOOTP_VENDOREX
stroesee0aadfb2003-08-28 14:17:32 +00001207
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001208 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1209 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001210
1211 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1212 serverip from a DHCP server, it is possible that more
1213 than one DNS serverip is offered to the client.
1214 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1215 serverip will be stored in the additional environment
1216 variable "dnsip2". The first DNS serverip is always
1217 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001218 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001219
1220 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1221 to do a dynamic update of a DNS server. To do this, they
1222 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001223 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001224 of the "hostname" environment variable is passed as
1225 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001226
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001227 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1228
1229 A 32bit value in microseconds for a delay between
1230 receiving a "DHCP Offer" and sending the "DHCP Request".
1231 This fixes a problem with certain DHCP servers that don't
1232 respond 100% of the time to a "DHCP request". E.g. On an
1233 AT91RM9200 processor running at 180MHz, this delay needed
1234 to be *at least* 15,000 usec before a Windows Server 2003
1235 DHCP server would reply 100% of the time. I recommend at
1236 least 50,000 usec to be safe. The alternative is to hope
1237 that one of the retries will be successful but note that
1238 the DHCP timeout and retry process takes a longer than
1239 this delay.
1240
wdenk145d2c12004-04-15 21:48:45 +00001241 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001242 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001243
1244 The device id used in CDP trigger frames.
1245
1246 CONFIG_CDP_DEVICE_ID_PREFIX
1247
1248 A two character string which is prefixed to the MAC address
1249 of the device.
1250
1251 CONFIG_CDP_PORT_ID
1252
1253 A printf format string which contains the ascii name of
1254 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001255 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001256
1257 CONFIG_CDP_CAPABILITIES
1258
1259 A 32bit integer which indicates the device capabilities;
1260 0x00000010 for a normal host which does not forwards.
1261
1262 CONFIG_CDP_VERSION
1263
1264 An ascii string containing the version of the software.
1265
1266 CONFIG_CDP_PLATFORM
1267
1268 An ascii string containing the name of the platform.
1269
1270 CONFIG_CDP_TRIGGER
1271
1272 A 32bit integer sent on the trigger.
1273
1274 CONFIG_CDP_POWER_CONSUMPTION
1275
1276 A 16bit integer containing the power consumption of the
1277 device in .1 of milliwatts.
1278
1279 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1280
1281 A byte containing the id of the VLAN.
1282
wdenkc6097192002-11-03 00:24:07 +00001283- Status LED: CONFIG_STATUS_LED
1284
1285 Several configurations allow to display the current
1286 status using a LED. For instance, the LED will blink
1287 fast while running U-Boot code, stop blinking as
1288 soon as a reply to a BOOTP request was received, and
1289 start blinking slow once the Linux kernel is running
1290 (supported by a status LED driver in the Linux
1291 kernel). Defining CONFIG_STATUS_LED enables this
1292 feature in U-Boot.
1293
1294- CAN Support: CONFIG_CAN_DRIVER
1295
1296 Defining CONFIG_CAN_DRIVER enables CAN driver support
1297 on those systems that support this (optional)
1298 feature, like the TQM8xxL modules.
1299
1300- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1301
wdenkb9bbd242003-06-30 16:24:52 +00001302 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001303 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001304 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001305
wdenk21136db2003-07-16 21:53:01 +00001306 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001307 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001308 CONFIG_COMMANDS) and communicate with i2c based realtime
1309 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001310 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001311
Ben Warren45657152006-09-07 16:50:54 -04001312 CONFIG_I2C_CMD_TREE is a recommended option that places
1313 all I2C commands under a single 'i2c' root command. The
1314 older 'imm', 'imd', 'iprobe' etc. commands are considered
1315 deprecated and may disappear in the future.
1316
1317 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001318
wdenk21136db2003-07-16 21:53:01 +00001319 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001320 bit-banging) driver instead of CPM or similar hardware
1321 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001322
wdenk21136db2003-07-16 21:53:01 +00001323 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001324 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001325
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001326 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001327 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001328 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001329 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001330
wdenkb9bbd242003-06-30 16:24:52 +00001331 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001332 sets the CPU up as a master node and so its address should
wdenkb9bbd242003-06-30 16:24:52 +00001333 therefore be cleared to 0 (See, eg, MPC823e User's Manual
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001334 p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001335
wdenk21136db2003-07-16 21:53:01 +00001336 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001337
wdenkb9bbd242003-06-30 16:24:52 +00001338 If you use the software i2c interface (CONFIG_SOFT_I2C)
1339 then the following macros need to be defined (examples are
1340 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001341
1342 I2C_INIT
1343
wdenkb9bbd242003-06-30 16:24:52 +00001344 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001345 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001346
wdenk544e9732004-02-06 23:19:44 +00001347 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001348
wdenkc6097192002-11-03 00:24:07 +00001349 I2C_PORT
1350
wdenk4a5c8a72003-03-06 00:02:04 +00001351 (Only for MPC8260 CPU). The I/O port to use (the code
1352 assumes both bits are on the same port). Valid values
1353 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001354
1355 I2C_ACTIVE
1356
1357 The code necessary to make the I2C data line active
1358 (driven). If the data line is open collector, this
1359 define can be null.
1360
wdenkb9bbd242003-06-30 16:24:52 +00001361 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1362
wdenkc6097192002-11-03 00:24:07 +00001363 I2C_TRISTATE
1364
1365 The code necessary to make the I2C data line tri-stated
1366 (inactive). If the data line is open collector, this
1367 define can be null.
1368
wdenkb9bbd242003-06-30 16:24:52 +00001369 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1370
wdenkc6097192002-11-03 00:24:07 +00001371 I2C_READ
1372
1373 Code that returns TRUE if the I2C data line is high,
1374 FALSE if it is low.
1375
wdenkb9bbd242003-06-30 16:24:52 +00001376 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1377
wdenkc6097192002-11-03 00:24:07 +00001378 I2C_SDA(bit)
1379
1380 If <bit> is TRUE, sets the I2C data line high. If it
1381 is FALSE, it clears it (low).
1382
wdenkb9bbd242003-06-30 16:24:52 +00001383 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001384 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001385 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001386
wdenkc6097192002-11-03 00:24:07 +00001387 I2C_SCL(bit)
1388
1389 If <bit> is TRUE, sets the I2C clock line high. If it
1390 is FALSE, it clears it (low).
1391
wdenkb9bbd242003-06-30 16:24:52 +00001392 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001393 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001394 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001395
wdenkc6097192002-11-03 00:24:07 +00001396 I2C_DELAY
1397
1398 This delay is invoked four times per clock cycle so this
1399 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001400 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001401 like:
1402
wdenkb9bbd242003-06-30 16:24:52 +00001403 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001404
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001405 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001406
wdenk57b2d802003-06-27 21:31:46 +00001407 When a board is reset during an i2c bus transfer
1408 chips might think that the current transfer is still
1409 in progress. On some boards it is possible to access
1410 the i2c SCLK line directly, either by using the
1411 processor pin as a GPIO or by having a second pin
1412 connected to the bus. If this option is defined a
1413 custom i2c_init_board() routine in boards/xxx/board.c
1414 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001415
wdenk0e2bd9c2004-06-06 21:51:03 +00001416 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1417
1418 This option enables configuration of bi_iic_fast[] flags
1419 in u-boot bd_info structure based on u-boot environment
1420 variable "i2cfast". (see also i2cfast)
1421
Ben Warren45657152006-09-07 16:50:54 -04001422 CONFIG_I2C_MULTI_BUS
1423
1424 This option allows the use of multiple I2C buses, each of which
1425 must have a controller. At any point in time, only one bus is
1426 active. To switch to a different bus, use the 'i2c dev' command.
1427 Note that bus numbering is zero-based.
1428
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001429 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001430
1431 This option specifies a list of I2C devices that will be skipped
1432 when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1433 command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001434 pairs. Otherwise, specify a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001435
1436 e.g.
1437 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001438 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001439
1440 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1441
1442 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001443 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001444
1445 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1446
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001447 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001448
1449 If defined, then this indicates the I2C bus number for DDR SPD.
1450 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1451
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001452 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001453
1454 If defined, then this indicates the I2C bus number for the RTC.
1455 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1456
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001457 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001458
1459 If defined, then this indicates the I2C bus number for the DTT.
1460 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1461
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001462 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07001463
1464 If defined, specifies the I2C address of the DTT device.
1465 If not defined, then U-Boot uses predefined value for
1466 specified DTT device.
1467
Timur Tabiab347542006-11-03 19:15:00 -06001468 CONFIG_FSL_I2C
1469
1470 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01001471 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06001472
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001473 CONFIG_I2C_MUX
1474
1475 Define this option if you have I2C devices reached over 1 .. n
1476 I2C Muxes like the pca9544a. This option addes a new I2C
1477 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1478 new I2C Bus to the existing I2C Busses. If you select the
1479 new Bus with "i2c dev", u-bbot sends first the commandos for
1480 the muxes to activate this new "bus".
1481
1482 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1483 feature!
1484
1485 Example:
1486 Adding a new I2C Bus reached over 2 pca9544a muxes
1487 The First mux with address 70 and channel 6
1488 The Second mux with address 71 and channel 4
1489
1490 => i2c bus pca9544a:70:6:pca9544a:71:4
1491
1492 Use the "i2c bus" command without parameter, to get a list
1493 of I2C Busses with muxes:
1494
1495 => i2c bus
1496 Busses reached over muxes:
1497 Bus ID: 2
1498 reached over Mux(es):
1499 pca9544a@70 ch: 4
1500 Bus ID: 3
1501 reached over Mux(es):
1502 pca9544a@70 ch: 6
1503 pca9544a@71 ch: 4
1504 =>
1505
1506 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1507 u-boot sends First the Commando to the mux@70 to enable
1508 channel 6, and then the Commando to the mux@71 to enable
1509 the channel 4.
1510
1511 After that, you can use the "normal" i2c commands as
1512 usual, to communicate with your I2C devices behind
1513 the 2 muxes.
1514
1515 This option is actually implemented for the bitbanging
1516 algorithm in common/soft_i2c.c and for the Hardware I2C
1517 Bus on the MPC8260. But it should be not so difficult
1518 to add this option to other architectures.
1519
Andrew Dyer58c41f92008-12-29 17:36:01 -06001520 CONFIG_SOFT_I2C_READ_REPEATED_START
1521
1522 defining this will force the i2c_read() function in
1523 the soft_i2c driver to perform an I2C repeated start
1524 between writing the address pointer and reading the
1525 data. If this define is omitted the default behaviour
1526 of doing a stop-start sequence will be used. Most I2C
1527 devices can use either method, but some require one or
1528 the other.
Timur Tabiab347542006-11-03 19:15:00 -06001529
wdenkc6097192002-11-03 00:24:07 +00001530- SPI Support: CONFIG_SPI
1531
1532 Enables SPI driver (so far only tested with
1533 SPI EEPROM, also an instance works with Crystal A/D and
1534 D/As on the SACSng board)
1535
1536 CONFIG_SPI_X
1537
1538 Enables extended (16-bit) SPI EEPROM addressing.
1539 (symmetrical to CONFIG_I2C_X)
1540
1541 CONFIG_SOFT_SPI
1542
wdenk4a5c8a72003-03-06 00:02:04 +00001543 Enables a software (bit-bang) SPI driver rather than
1544 using hardware support. This is a general purpose
1545 driver that only requires three general I/O port pins
1546 (two outputs, one input) to function. If this is
1547 defined, the board configuration must define several
1548 SPI configuration items (port pins to use, etc). For
1549 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001550
Ben Warren7efe9272008-01-16 22:37:35 -05001551 CONFIG_HARD_SPI
1552
1553 Enables a hardware SPI driver for general-purpose reads
1554 and writes. As with CONFIG_SOFT_SPI, the board configuration
1555 must define a list of chip-select function pointers.
1556 Currently supported on some MPC8xxx processors. For an
1557 example, see include/configs/mpc8349emds.h.
1558
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02001559 CONFIG_MXC_SPI
1560
1561 Enables the driver for the SPI controllers on i.MX and MXC
1562 SoCs. Currently only i.MX31 is supported.
1563
Matthias Fuchsa4400872007-12-27 17:12:34 +01001564- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001565
Matthias Fuchsa4400872007-12-27 17:12:34 +01001566 Enables FPGA subsystem.
1567
1568 CONFIG_FPGA_<vendor>
1569
1570 Enables support for specific chip vendors.
1571 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001572
Matthias Fuchsa4400872007-12-27 17:12:34 +01001573 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001574
Matthias Fuchsa4400872007-12-27 17:12:34 +01001575 Enables support for FPGA family.
1576 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1577
1578 CONFIG_FPGA_COUNT
1579
1580 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001581
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001582 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001583
wdenk57b2d802003-06-27 21:31:46 +00001584 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001585
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001586 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001587
wdenk4a5c8a72003-03-06 00:02:04 +00001588 Enable checks on FPGA configuration interface busy
1589 status by the configuration function. This option
1590 will require a board or device specific function to
1591 be written.
wdenkc6097192002-11-03 00:24:07 +00001592
1593 CONFIG_FPGA_DELAY
1594
1595 If defined, a function that provides delays in the FPGA
1596 configuration driver.
1597
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001598 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001599 Allow Control-C to interrupt FPGA configuration
1600
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001601 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001602
wdenk4a5c8a72003-03-06 00:02:04 +00001603 Check for configuration errors during FPGA bitfile
1604 loading. For example, abort during Virtex II
1605 configuration if the INIT_B line goes low (which
1606 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001607
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001608 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001609
wdenk4a5c8a72003-03-06 00:02:04 +00001610 Maximum time to wait for the INIT_B line to deassert
1611 after PROB_B has been deasserted during a Virtex II
1612 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001613 ms.
wdenkc6097192002-11-03 00:24:07 +00001614
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001615 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001616
wdenk4a5c8a72003-03-06 00:02:04 +00001617 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001618 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001619
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001620 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001621
wdenk4a5c8a72003-03-06 00:02:04 +00001622 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001623 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001624
1625- Configuration Management:
1626 CONFIG_IDENT_STRING
1627
wdenk4a5c8a72003-03-06 00:02:04 +00001628 If defined, this string will be added to the U-Boot
1629 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001630
1631- Vendor Parameter Protection:
1632
wdenk4a5c8a72003-03-06 00:02:04 +00001633 U-Boot considers the values of the environment
1634 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001635 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001636 are set once by the board vendor / manufacturer, and
1637 protects these variables from casual modification by
1638 the user. Once set, these variables are read-only,
1639 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001640 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001641
1642 If CONFIG_ENV_OVERWRITE is #defined in your config
1643 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001644 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001645 these parameters.
1646
1647 Alternatively, if you #define _both_ CONFIG_ETHADDR
1648 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001649 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001650 which can be changed exactly ONCE by the user. [The
1651 serial# is unaffected by this, i. e. it remains
1652 read-only.]
1653
1654- Protected RAM:
1655 CONFIG_PRAM
1656
1657 Define this variable to enable the reservation of
1658 "protected RAM", i. e. RAM which is not overwritten
1659 by U-Boot. Define CONFIG_PRAM to hold the number of
1660 kB you want to reserve for pRAM. You can overwrite
1661 this default value by defining an environment
1662 variable "pram" to the number of kB you want to
1663 reserve. Note that the board info structure will
1664 still show the full amount of RAM. If pRAM is
1665 reserved, a new environment variable "mem" will
1666 automatically be defined to hold the amount of
1667 remaining RAM in a form that can be passed as boot
1668 argument to Linux, for instance like that:
1669
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001670 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001671 saveenv
1672
1673 This way you can tell Linux not to use this memory,
1674 either, which results in a memory region that will
1675 not be affected by reboots.
1676
1677 *WARNING* If your board configuration uses automatic
1678 detection of the RAM size, you must make sure that
1679 this memory test is non-destructive. So far, the
1680 following board configurations are known to be
1681 "pRAM-clean":
1682
1683 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1684 HERMES, IP860, RPXlite, LWMON, LANTEC,
1685 PCU_E, FLAGADM, TQM8260
1686
1687- Error Recovery:
1688 CONFIG_PANIC_HANG
1689
1690 Define this variable to stop the system in case of a
1691 fatal error, so that you have to reset it manually.
1692 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001693 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001694 automatically as fast as possible, but it may be
1695 useful during development since you can try to debug
1696 the conditions that lead to the situation.
1697
1698 CONFIG_NET_RETRY_COUNT
1699
wdenk4a5c8a72003-03-06 00:02:04 +00001700 This variable defines the number of retries for
1701 network operations like ARP, RARP, TFTP, or BOOTP
1702 before giving up the operation. If not defined, a
1703 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001704
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02001705 CONFIG_ARP_TIMEOUT
1706
1707 Timeout waiting for an ARP reply in milliseconds.
1708
wdenkc6097192002-11-03 00:24:07 +00001709- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001710 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00001711
1712 Enable auto completion of commands using TAB.
1713
Wolfgang Denk018147d2006-11-27 15:32:42 +01001714 Note that this feature has NOT been implemented yet
1715 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001716
1717
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001718 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001719
1720 Define this variable to enable the "hush" shell (from
1721 Busybox) as command line interpreter, thus enabling
1722 powerful command line syntax like
1723 if...then...else...fi conditionals or `&&' and '||'
1724 constructs ("shell scripts").
1725
1726 If undefined, you get the old, much simpler behaviour
1727 with a somewhat smaller memory footprint.
1728
1729
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001730 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001731
1732 This defines the secondary prompt string, which is
1733 printed when the command interpreter needs more input
1734 to complete a command. Usually "> ".
1735
1736 Note:
1737
wdenk57b2d802003-06-27 21:31:46 +00001738 In the current implementation, the local variables
1739 space and global environment variables space are
1740 separated. Local variables are those you define by
1741 simply typing `name=value'. To access a local
1742 variable later on, you have write `$name' or
1743 `${name}'; to execute the contents of a variable
1744 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001745
wdenk4a5c8a72003-03-06 00:02:04 +00001746 Global environment variables are those you use
1747 setenv/printenv to work with. To run a command stored
1748 in such a variable, you need to use the run command,
1749 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001750
1751 To store commands and special characters in a
1752 variable, please use double quotation marks
1753 surrounding the whole text of the variable, instead
1754 of the backslashes before semicolons and special
1755 symbols.
1756
Wolfgang Denk2039a072006-07-21 11:35:21 +02001757- Commandline Editing and History:
1758 CONFIG_CMDLINE_EDITING
1759
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001760 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02001761 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02001762
wdenkc0aa5c52003-12-06 19:49:23 +00001763- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001764 CONFIG_EXTRA_ENV_SETTINGS
1765
wdenk4a5c8a72003-03-06 00:02:04 +00001766 Define this to contain any number of null terminated
1767 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00001768 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00001769
wdenk4a5c8a72003-03-06 00:02:04 +00001770 For example, place something like this in your
1771 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001772
1773 #define CONFIG_EXTRA_ENV_SETTINGS \
1774 "myvar1=value1\0" \
1775 "myvar2=value2\0"
1776
wdenk4a5c8a72003-03-06 00:02:04 +00001777 Warning: This method is based on knowledge about the
1778 internal format how the environment is stored by the
1779 U-Boot code. This is NOT an official, exported
1780 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00001781 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001782 You better know what you are doing here.
1783
wdenk4a5c8a72003-03-06 00:02:04 +00001784 Note: overly (ab)use of the default environment is
1785 discouraged. Make sure to check other ways to preset
1786 the environment like the autoscript function or the
1787 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001788
wdenkc0aa5c52003-12-06 19:49:23 +00001789- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00001790 CONFIG_HAS_DATAFLASH
1791
wdenk57b2d802003-06-27 21:31:46 +00001792 Defining this option enables DataFlash features and
1793 allows to read/write in Dataflash via the standard
1794 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00001795
wdenkef893942004-02-23 16:11:30 +00001796- SystemACE Support:
1797 CONFIG_SYSTEMACE
1798
1799 Adding this option adds support for Xilinx SystemACE
1800 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001801 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001802 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00001803
1804 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001805 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00001806
1807 When SystemACE support is added, the "ace" device type
1808 becomes available to the fat commands, i.e. fatls.
1809
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001810- TFTP Fixed UDP Port:
1811 CONFIG_TFTP_PORT
1812
Wolfgang Denk227b5192005-09-24 23:25:46 +02001813 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001814 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02001815 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001816 number generator is used.
1817
Wolfgang Denk227b5192005-09-24 23:25:46 +02001818 Also, the environment variable tftpdstp is used to supply
1819 the TFTP UDP destination port value. If tftpdstp isn't
1820 defined, the normal port 69 is used.
1821
1822 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001823 blindly start the TFTP transfer using the pre-configured
1824 target IP address and UDP port. This has the effect of
1825 "punching through" the (Windows XP) firewall, allowing
1826 the remainder of the TFTP transfer to proceed normally.
1827 A better solution is to properly configure the firewall,
1828 but sometimes that is not allowed.
1829
wdenkc0aa5c52003-12-06 19:49:23 +00001830- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001831 CONFIG_SHOW_BOOT_PROGRESS
1832
wdenk4a5c8a72003-03-06 00:02:04 +00001833 Defining this option allows to add some board-
1834 specific code (calling a user-provided function
1835 "show_boot_progress(int)") that enables you to show
1836 the system's boot progress on some display (for
1837 example, some LED's) on your board. At the moment,
1838 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001839
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02001840- Automatic software updates via TFTP server
1841 CONFIG_UPDATE_TFTP
1842 CONFIG_UPDATE_TFTP_CNT_MAX
1843 CONFIG_UPDATE_TFTP_MSEC_MAX
1844
1845 These options enable and control the auto-update feature;
1846 for a more detailed description refer to doc/README.update.
1847
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001848Legacy uImage format:
1849
wdenkc6097192002-11-03 00:24:07 +00001850 Arg Where When
1851 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00001852 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001853 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00001854 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001855 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00001856 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001857 4 common/cmd_bootm.c Image data has correct checksum
1858 -4 common/cmd_bootm.c Image is for unsupported architecture
1859 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001860 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001861 6 common/cmd_bootm.c Image Type check OK
1862 -6 common/cmd_bootm.c gunzip uncompression error
1863 -7 common/cmd_bootm.c Unimplemented compression type
1864 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001865 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001866 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001867
1868 9 common/image.c Start initial ramdisk verification
1869 -10 common/image.c Ramdisk header has bad magic number
1870 -11 common/image.c Ramdisk header has bad checksum
1871 10 common/image.c Ramdisk header is OK
1872 -12 common/image.c Ramdisk data has bad checksum
1873 11 common/image.c Ramdisk data has correct checksum
1874 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001875 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001876 13 common/image.c Start multifile image verification
1877 14 common/image.c No initial ramdisk, no multifile, continue.
1878
1879 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001880
wdenkd729d302004-02-27 00:07:27 +00001881 -30 lib_ppc/board.c Fatal error, hang the system
1882 -31 post/post.c POST test failed, detected by post_output_backlog()
1883 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00001884
Heiko Schocher633e03a2007-06-22 19:11:54 +02001885 34 common/cmd_doc.c before loading a Image from a DOC device
1886 -35 common/cmd_doc.c Bad usage of "doc" command
1887 35 common/cmd_doc.c correct usage of "doc" command
1888 -36 common/cmd_doc.c No boot device
1889 36 common/cmd_doc.c correct boot device
1890 -37 common/cmd_doc.c Unknown Chip ID on boot device
1891 37 common/cmd_doc.c correct chip ID found, device available
1892 -38 common/cmd_doc.c Read Error on boot device
1893 38 common/cmd_doc.c reading Image header from DOC device OK
1894 -39 common/cmd_doc.c Image header has bad magic number
1895 39 common/cmd_doc.c Image header has correct magic number
1896 -40 common/cmd_doc.c Error reading Image from DOC device
1897 40 common/cmd_doc.c Image header has correct magic number
1898 41 common/cmd_ide.c before loading a Image from a IDE device
1899 -42 common/cmd_ide.c Bad usage of "ide" command
1900 42 common/cmd_ide.c correct usage of "ide" command
1901 -43 common/cmd_ide.c No boot device
1902 43 common/cmd_ide.c boot device found
1903 -44 common/cmd_ide.c Device not available
1904 44 common/cmd_ide.c Device available
1905 -45 common/cmd_ide.c wrong partition selected
1906 45 common/cmd_ide.c partition selected
1907 -46 common/cmd_ide.c Unknown partition table
1908 46 common/cmd_ide.c valid partition table found
1909 -47 common/cmd_ide.c Invalid partition type
1910 47 common/cmd_ide.c correct partition type
1911 -48 common/cmd_ide.c Error reading Image Header on boot device
1912 48 common/cmd_ide.c reading Image Header from IDE device OK
1913 -49 common/cmd_ide.c Image header has bad magic number
1914 49 common/cmd_ide.c Image header has correct magic number
1915 -50 common/cmd_ide.c Image header has bad checksum
1916 50 common/cmd_ide.c Image header has correct checksum
1917 -51 common/cmd_ide.c Error reading Image from IDE device
1918 51 common/cmd_ide.c reading Image from IDE device OK
1919 52 common/cmd_nand.c before loading a Image from a NAND device
1920 -53 common/cmd_nand.c Bad usage of "nand" command
1921 53 common/cmd_nand.c correct usage of "nand" command
1922 -54 common/cmd_nand.c No boot device
1923 54 common/cmd_nand.c boot device found
1924 -55 common/cmd_nand.c Unknown Chip ID on boot device
1925 55 common/cmd_nand.c correct chip ID found, device available
1926 -56 common/cmd_nand.c Error reading Image Header on boot device
1927 56 common/cmd_nand.c reading Image Header from NAND device OK
1928 -57 common/cmd_nand.c Image header has bad magic number
1929 57 common/cmd_nand.c Image header has correct magic number
1930 -58 common/cmd_nand.c Error reading Image from NAND device
1931 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00001932
Heiko Schocher633e03a2007-06-22 19:11:54 +02001933 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001934
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001935 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02001936 -64 net/eth.c no Ethernet found.
1937 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00001938
Heiko Schocher633e03a2007-06-22 19:11:54 +02001939 -80 common/cmd_net.c usage wrong
1940 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001941 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02001942 81 common/cmd_net.c NetLoop() back without error
1943 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1944 82 common/cmd_net.c trying automatic boot
1945 83 common/cmd_net.c running autoscript
1946 -83 common/cmd_net.c some error in automatic boot or autoscript
1947 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00001948
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001949FIT uImage format:
1950
1951 Arg Where When
1952 100 common/cmd_bootm.c Kernel FIT Image has correct format
1953 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1954 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1955 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1956 102 common/cmd_bootm.c Kernel unit name specified
1957 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01001958 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001959 104 common/cmd_bootm.c Got kernel subimage node offset
1960 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1961 105 common/cmd_bootm.c Kernel subimage hash verification OK
1962 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1963 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001964 -106 common/cmd_bootm.c Kernel subimage has wrong type
1965 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001966 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1967 108 common/cmd_bootm.c Got kernel subimage data/size
1968 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1969 -109 common/cmd_bootm.c Can't get kernel subimage type
1970 -110 common/cmd_bootm.c Can't get kernel subimage comp
1971 -111 common/cmd_bootm.c Can't get kernel subimage os
1972 -112 common/cmd_bootm.c Can't get kernel subimage load address
1973 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1974
1975 120 common/image.c Start initial ramdisk verification
1976 -120 common/image.c Ramdisk FIT image has incorrect format
1977 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001978 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001979 -122 common/image.c Can't get configuration for ramdisk subimage
1980 123 common/image.c Ramdisk unit name specified
1981 -124 common/image.c Can't get ramdisk subimage node offset
1982 125 common/image.c Got ramdisk subimage node offset
1983 -125 common/image.c Ramdisk subimage hash verification failed
1984 126 common/image.c Ramdisk subimage hash verification OK
1985 -126 common/image.c Ramdisk subimage for unsupported architecture
1986 127 common/image.c Architecture check OK
1987 -127 common/image.c Can't get ramdisk subimage data/size
1988 128 common/image.c Got ramdisk subimage data/size
1989 129 common/image.c Can't get ramdisk load address
1990 -129 common/image.c Got ramdisk load address
1991
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001992 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001993 131 common/cmd_doc.c FIT image format OK
1994
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001995 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001996 141 common/cmd_ide.c FIT image format OK
1997
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001998 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001999 151 common/cmd_nand.c FIT image format OK
2000
2001
wdenkc6097192002-11-03 00:24:07 +00002002Modem Support:
2003--------------
2004
wdenk8dba0502003-03-31 16:34:49 +00002005[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002006
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002007- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002008 CONFIG_MODEM_SUPPORT
2009
2010- RTS/CTS Flow control enable:
2011 CONFIG_HWFLOW
2012
2013- Modem debug support:
2014 CONFIG_MODEM_SUPPORT_DEBUG
2015
wdenk4a5c8a72003-03-06 00:02:04 +00002016 Enables debugging stuff (char screen[1024], dbg())
2017 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002018
wdenkc0aa5c52003-12-06 19:49:23 +00002019- Interrupt support (PPC):
2020
wdenk1ebf41e2004-01-02 14:00:00 +00002021 There are common interrupt_init() and timer_interrupt()
2022 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002023 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00002024 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002025 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00002026 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002027 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00002028 specific handling. If board has watchdog / status_led
2029 / other_activity_monitor it works automatically from
2030 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002031
wdenkc6097192002-11-03 00:24:07 +00002032- General:
2033
wdenk4a5c8a72003-03-06 00:02:04 +00002034 In the target system modem support is enabled when a
2035 specific key (key combination) is pressed during
2036 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002037 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00002038 board_init(). Currently key_pressed() is a dummy
2039 function, returning 1 and thus enabling modem
2040 initialization.
wdenkc6097192002-11-03 00:24:07 +00002041
wdenk4a5c8a72003-03-06 00:02:04 +00002042 If there are no modem init strings in the
2043 environment, U-Boot proceed to autoboot; the
2044 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002045 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002046
2047 See also: doc/README.Modem
2048
2049
wdenkc6097192002-11-03 00:24:07 +00002050Configuration Settings:
2051-----------------------
2052
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002053- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002054 undefine this when you're short of memory.
2055
Peter Tyserdfb72b82009-01-27 18:03:12 -06002056- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2057 width of the commands listed in the 'help' command output.
2058
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002059- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002060 prompt for user input.
2061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002062- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002063
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002064- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002065
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002066- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002067
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002068- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002069 the application (usually a Linux kernel) when it is
2070 booted
2071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002072- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002073 List of legal baudrate settings for this board.
2074
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002075- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00002076 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002078- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00002079 If the board specific function
2080 extern int overwrite_console (void);
2081 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002082 serial port, else the settings in the environment are used.
2083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002084- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00002085 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002086
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002087- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002088 Enable overwrite of previous console environment settings.
2089
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002090- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002091 Begin and End addresses of the area used by the
2092 simple memory test.
2093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002094- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002095 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002097- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002098 Scratch address used by the alternate memory test
2099 You only need to set this if address zero isn't writeable
2100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002101- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2102 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002103 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002104 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002105 fixing up gd->ram_size the Linux kernel should gets passed
2106 the now "corrected" memory size and won't touch it either.
2107 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002108 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002109 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002110 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002111
2112 This option can be used as a workaround for the 440EPx/GRx
2113 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2114 be touched.
2115
2116 WARNING: Please make sure that this value is a multiple of
2117 the Linux page size (normally 4k). If this is not the case,
2118 then the end address of the Linux memory will be located at a
2119 non page size aligned address and this could cause major
2120 problems.
2121
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002122- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002123 Default load address for network file downloads
2124
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002125- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002126 Enable temporary baudrate change while serial download
2127
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002128- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002129 Physical start address of SDRAM. _Must_ be 0 here.
2130
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002131- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002132 Physical start address of Motherboard I/O (if using a
2133 Cogent motherboard)
2134
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002135- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002136 Physical start address of Flash memory.
2137
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002138- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002139 Physical start address of boot monitor code (set by
2140 make config files to be same as the text base address
2141 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002142 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002143
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002144- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002145 Size of memory reserved for monitor code, used to
2146 determine _at_compile_time_ (!) if the environment is
2147 embedded within the U-Boot image, or in a separate
2148 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002149
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002150- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002151 Size of DRAM reserved for malloc() use.
2152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002153- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002154 Normally compressed uImages are limited to an
2155 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002156 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002157 to adjust this setting to your needs.
2158
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002159- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002160 Maximum size of memory mapped by the startup code of
2161 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002162 the Linux kernel (bd_info, boot arguments, FDT blob if
2163 used) must be put below this limit, unless "bootm_low"
2164 enviroment variable is defined and non-zero. In such case
2165 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002166 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002167
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002168- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002169 Max number of Flash memory banks
2170
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002171- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002172 Max number of sectors on a Flash chip
2173
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002174- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002175 Timeout for Flash erase operations (in ms)
2176
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002177- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002178 Timeout for Flash write operations (in ms)
2179
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002180- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002181 Timeout for Flash set sector lock bit operation (in ms)
2182
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002183- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002184 Timeout for Flash clear lock bits operation (in ms)
2185
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002186- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002187 If defined, hardware flash sectors protection is used
2188 instead of U-Boot software protection.
2189
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002190- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002191
2192 Enable TFTP transfers directly to flash memory;
2193 without this option such a download has to be
2194 performed in two steps: (1) download to RAM, and (2)
2195 copy from RAM to flash.
2196
2197 The two-step approach is usually more reliable, since
2198 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002199 the flash, but in some situations (when system RAM is
2200 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002201 downloaded image) this option may be very useful.
2202
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002203- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002204 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002205 common flash structure for storing flash geometry.
2206
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002207- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002208 This option also enables the building of the cfi_flash driver
2209 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002210
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002211- CONFIG_FLASH_CFI_MTD
2212 This option enables the building of the cfi_mtd driver
2213 in the drivers directory. The driver exports CFI flash
2214 to the MTD layer.
2215
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002216- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002217 Use buffered writes to flash.
2218
2219- CONFIG_FLASH_SPANSION_S29WS_N
2220 s29ws-n MirrorBit flash has non-standard addresses for buffered
2221 write commands.
2222
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002223- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002224 If this option is defined, the common CFI flash doesn't
2225 print it's warning upon not recognized FLASH banks. This
2226 is useful, if some of the configured banks are only
2227 optionally available.
2228
Jerry Van Barenaae73572008-03-08 13:48:01 -05002229- CONFIG_FLASH_SHOW_PROGRESS
2230 If defined (must be an integer), print out countdown
2231 digits and dots. Recommended value: 45 (9..1) for 80
2232 column displays, 15 (3..1) for 40 column displays.
2233
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002234- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002235 Defines the number of Ethernet receive buffers. On some
2236 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002237 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2238 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002239 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002240 Defaults to 4 if not defined.
2241
wdenkc6097192002-11-03 00:24:07 +00002242The following definitions that deal with the placement and management
2243of environment data (variable area); in general, we support the
2244following configurations:
2245
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002246- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002247
2248 Define this if the environment is in flash memory.
2249
2250 a) The environment occupies one whole flash sector, which is
2251 "embedded" in the text segment with the U-Boot code. This
2252 happens usually with "bottom boot sector" or "top boot
2253 sector" type flash chips, which have several smaller
2254 sectors at the start or the end. For instance, such a
2255 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2256 such a case you would place the environment in one of the
2257 4 kB sectors - with U-Boot code before and after it. With
2258 "top boot sector" type flash chips, you would put the
2259 environment in one of the last sectors, leaving a gap
2260 between U-Boot and the environment.
2261
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002262 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002263
2264 Offset of environment data (variable area) to the
2265 beginning of flash memory; for instance, with bottom boot
2266 type flash chips the second sector can be used: the offset
2267 for this sector is given here.
2268
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002269 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002270
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002271 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002272
2273 This is just another way to specify the start address of
2274 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002275 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002276
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002277 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002278
2279 Size of the sector containing the environment.
2280
2281
2282 b) Sometimes flash chips have few, equal sized, BIG sectors.
2283 In such a case you don't want to spend a whole sector for
2284 the environment.
2285
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002286 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002287
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002288 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002289 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002290 of this flash sector for the environment. This saves
2291 memory for the RAM copy of the environment.
2292
2293 It may also save flash memory if you decide to use this
2294 when your environment is "embedded" within U-Boot code,
2295 since then the remainder of the flash sector could be used
2296 for U-Boot code. It should be pointed out that this is
2297 STRONGLY DISCOURAGED from a robustness point of view:
2298 updating the environment in flash makes it always
2299 necessary to erase the WHOLE sector. If something goes
2300 wrong before the contents has been restored from a copy in
2301 RAM, your target system will be dead.
2302
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002303 - CONFIG_ENV_ADDR_REDUND
2304 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002305
wdenk4a5c8a72003-03-06 00:02:04 +00002306 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002307 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00002308 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00002309 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002310
2311BE CAREFUL! Any changes to the flash layout, and some changes to the
2312source code will make it necessary to adapt <board>/u-boot.lds*
2313accordingly!
2314
2315
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02002316- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002317
2318 Define this if you have some non-volatile memory device
2319 (NVRAM, battery buffered SRAM) which you want to use for the
2320 environment.
2321
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002322 - CONFIG_ENV_ADDR:
2323 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002324
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002325 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002326 want to use for environment. It is assumed that this memory
2327 can just be read and written to, without any special
2328 provision.
2329
2330BE CAREFUL! The first access to the environment happens quite early
2331in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002332console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002333U-Boot will hang.
2334
2335Please note that even with NVRAM we still use a copy of the
2336environment in RAM: we could work on NVRAM directly, but we want to
2337keep settings there always unmodified except somebody uses "saveenv"
2338to save the current settings.
2339
2340
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02002341- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002342
2343 Use this if you have an EEPROM or similar serial access
2344 device and a driver for it.
2345
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002346 - CONFIG_ENV_OFFSET:
2347 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002348
2349 These two #defines specify the offset and size of the
2350 environment area within the total memory of your EEPROM.
2351
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002352 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002353 If defined, specified the chip address of the EEPROM device.
2354 The default address is zero.
2355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002356 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002357 If defined, the number of bits used to address bytes in a
2358 single page in the EEPROM device. A 64 byte page, for example
2359 would require six bits.
2360
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002361 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002362 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00002363 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002364
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002365 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002366 The length in bytes of the EEPROM memory array address. Note
2367 that this is NOT the chip address length!
2368
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002369 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00002370 EEPROM chips that implement "address overflow" are ones
2371 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2372 address and the extra bits end up in the "chip address" bit
2373 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2374 byte chips.
2375
2376 Note that we consider the length of the address field to
2377 still be one byte because the extra address bits are hidden
2378 in the chip address.
2379
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002380 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002381 The size in bytes of the EEPROM device.
2382
wdenkc6097192002-11-03 00:24:07 +00002383
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02002384- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00002385
wdenk1ebf41e2004-01-02 14:00:00 +00002386 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00002387 want to use for the environment.
2388
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002389 - CONFIG_ENV_OFFSET:
2390 - CONFIG_ENV_ADDR:
2391 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00002392
2393 These three #defines specify the offset and size of the
2394 environment area within the total memory of your DataFlash placed
2395 at the specified address.
2396
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02002397- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00002398
2399 Define this if you have a NAND device which you want to use
2400 for the environment.
2401
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002402 - CONFIG_ENV_OFFSET:
2403 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00002404
2405 These two #defines specify the offset and size of the environment
2406 area within the first NAND device.
wdenk86765902003-12-06 23:55:10 +00002407
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002408 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002409
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002410 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002411 size used to hold a redundant copy of the environment data,
2412 so that there is a valid backup copy in case there is a
2413 power failure during a "saveenv" operation.
2414
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002415 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2416 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002417 the NAND devices block size.
2418
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002419- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002420
2421 Defines offset to the initial SPI buffer area in DPRAM. The
2422 area is used at an early stage (ROM part) if the environment
2423 is configured to reside in the SPI EEPROM: We need a 520 byte
2424 scratch DPRAM area. It is used between the two initialization
2425 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2426 to be a good choice since it makes it far enough from the
2427 start of the data area as well as from the stack pointer.
2428
Bruce Adleredecc942007-11-02 13:15:42 -07002429Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002430has been relocated to RAM and a RAM copy of the environment has been
2431created; also, when using EEPROM you will have to use getenv_r()
2432until then to read environment variables.
2433
wdenk8dba0502003-03-31 16:34:49 +00002434The environment is protected by a CRC32 checksum. Before the monitor
2435is relocated into RAM, as a result of a bad CRC you will be working
2436with the compiled-in default environment - *silently*!!! [This is
2437necessary, because the first environment variable we need is the
2438"baudrate" setting for the console - if we have a bad CRC, we don't
2439have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002440
2441Note: once the monitor has been relocated, then it will complain if
2442the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002443use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002444
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002445- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002446 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002447
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002448 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002449 also needs to be defined.
2450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002451- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002452 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002453
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002454- CONFIG_SYS_64BIT_VSPRINTF:
wdenkf602aa02004-03-13 23:29:43 +00002455 Makes vsprintf (and all *printf functions) support printing
2456 of 64bit values by using the L quantifier
2457
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002458- CONFIG_SYS_64BIT_STRTOUL:
wdenkf602aa02004-03-13 23:29:43 +00002459 Adds simple_strtoull that returns a 64bit value
2460
wdenkc6097192002-11-03 00:24:07 +00002461Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002462---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002463
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002464- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002465 Cache Line Size of the CPU.
2466
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002467- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002468 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00002469
wdenk9c53f402003-10-15 23:53:47 +00002470 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2471 and RPXsuper) to be able to adjust the position of
2472 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002473
wdenk1272e232002-11-10 22:06:23 +00002474- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002475 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00002476
2477 the default drive number (default value 0)
2478
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002479 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00002480
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002481 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00002482 (default value 1)
2483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002484 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00002485
wdenk4a5c8a72003-03-06 00:02:04 +00002486 defines the offset of register from address. It
2487 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002488 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00002489
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002490 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2491 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00002492 default value.
wdenk1272e232002-11-10 22:06:23 +00002493
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002494 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00002495 fdc_hw_init() is called at the beginning of the FDC
2496 setup. fdc_hw_init() must be provided by the board
2497 source code. It is used to make hardware dependant
2498 initializations.
wdenk1272e232002-11-10 22:06:23 +00002499
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002500- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002501 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00002502 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002503
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002504- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002505
wdenkeb20ad32003-09-05 23:19:14 +00002506 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002507 initial data and stack; please note that this must be
2508 writable memory that is working WITHOUT special
2509 initialization, i. e. you CANNOT use normal RAM which
2510 will become available only after programming the
2511 memory controller and running certain initialization
2512 sequences.
2513
2514 U-Boot uses the following memory types:
2515 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2516 - MPC824X: data cache
2517 - PPC4xx: data cache
2518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002519- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002520
2521 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002522 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2523 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002524 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002525 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2526 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2527 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2528 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002529
2530 Note:
2531 On the MPC824X (or other systems that use the data
2532 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002533 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002534 point to an otherwise UNUSED address space between
2535 the top of RAM and the start of the PCI space.
2536
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002537- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002538
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002539- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002541- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002542
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002543- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002544
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002545- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002546
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002547- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002548
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002549- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002550 SDRAM timing
2551
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002552- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002553 periodic timer for refresh
2554
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002555- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002556
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002557- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2558 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2559 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2560 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002561 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2562
2563- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002564 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2565 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002566 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2567
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002568- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2569 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002570 Machine Mode Register and Memory Periodic Timer
2571 Prescaler definitions (SDRAM timing)
2572
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002573- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002574 enable I2C microcode relocation patch (MPC8xx);
2575 define relocation offset in DPRAM [DSP2]
2576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002577- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01002578 enable SMC microcode relocation patch (MPC8xx);
2579 define relocation offset in DPRAM [SMC1]
2580
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002581- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002582 enable SPI microcode relocation patch (MPC8xx);
2583 define relocation offset in DPRAM [SCC4]
2584
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002585- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002586 Use OSCM clock mode on MBX8xx board. Be careful,
2587 wrong setting might damage your board. Read
2588 doc/README.MBX before setting this variable!
2589
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002590- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00002591 Offset of the bootmode word in DPRAM used by post
2592 (Power On Self Tests). This definition overrides
2593 #define'd default value in commproc.h resp.
2594 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00002595
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002596- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2597 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2598 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2599 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2600 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2601 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2602 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2603 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
wdenkbf2f8c92003-05-22 22:52:13 +00002604 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2605
Ben Warren45657152006-09-07 16:50:54 -04002606- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002607 Get DDR timing information from an I2C EEPROM. Common
2608 with pluggable memory modules such as SODIMMs
2609
Ben Warren45657152006-09-07 16:50:54 -04002610 SPD_EEPROM_ADDRESS
2611 I2C address of the SPD EEPROM
2612
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002613- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002614 If SPD EEPROM is on an I2C bus other than the first
2615 one, specify here. Note that the value must resolve
2616 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002617
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002618- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002619 Only for 83xx systems. If specified, then DDR should
2620 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002621
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002622- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002623 Only for 83xx systems. If specified, then DDR should
2624 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002625
wdenk6203e402004-04-18 10:13:26 +00002626- CONFIG_ETHER_ON_FEC[12]
2627 Define to enable FEC[12] on a 8xx series processor.
2628
2629- CONFIG_FEC[12]_PHY
2630 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00002631 to the given FEC; i. e.
2632 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00002633 means that the PHY with address 4 is connected to FEC1
2634
2635 When set to -1, means to probe for first available.
2636
2637- CONFIG_FEC[12]_PHY_NORXERR
2638 The PHY does not have a RXERR line (RMII only).
2639 (so program the FEC to ignore it).
2640
2641- CONFIG_RMII
2642 Enable RMII mode for all FECs.
2643 Note that this is a global option, we can't
2644 have one FEC in standard MII mode and another in RMII mode.
2645
wdenk20c98a62004-04-23 20:32:05 +00002646- CONFIG_CRC32_VERIFY
2647 Add a verify option to the crc32 command.
2648 The syntax is:
2649
2650 => crc32 -v <address> <count> <crc32>
2651
2652 Where address/count indicate a memory area
2653 and crc32 is the correct crc32 which the
2654 area should have.
2655
wdenk64519362004-07-11 17:40:54 +00002656- CONFIG_LOOPW
2657 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002658 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00002659
stroesecc3af832004-12-16 18:46:55 +00002660- CONFIG_MX_CYCLIC
2661 Add the "mdc" and "mwc" memory commands. These are cyclic
2662 "md/mw" commands.
2663 Examples:
2664
wdenk07d7e6b2004-12-16 21:44:03 +00002665 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002666 This command will print 4 bytes (10,11,12,13) each 500 ms.
2667
wdenk07d7e6b2004-12-16 21:44:03 +00002668 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002669 This command will write 12345678 to address 100 all 10 ms.
2670
wdenk07d7e6b2004-12-16 21:44:03 +00002671 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002672 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00002673
wdenk3d3d99f2005-04-04 12:44:11 +00002674- CONFIG_SKIP_LOWLEVEL_INIT
2675- CONFIG_SKIP_RELOCATE_UBOOT
2676
wdenke085e5b2005-04-05 23:32:21 +00002677 [ARM only] If these variables are defined, then
2678 certain low level initializations (like setting up
2679 the memory controller) are omitted and/or U-Boot does
2680 not relocate itself into RAM.
2681 Normally these variables MUST NOT be defined. The
2682 only exception is when U-Boot is loaded (to RAM) by
2683 some other boot loader or by a debugger which
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002684 performs these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00002685
wdenk336b2bc2005-04-02 23:52:25 +00002686
wdenkc6097192002-11-03 00:24:07 +00002687Building the Software:
2688======================
2689
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002690Building U-Boot has been tested in several native build environments
2691and in many different cross environments. Of course we cannot support
2692all possibly existing versions of cross development tools in all
2693(potentially obsolete) versions. In case of tool chain problems we
2694recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2695which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002696
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002697If you are not using a native environment, it is assumed that you
2698have GNU cross compiling tools available in your path. In this case,
2699you must set the environment variable CROSS_COMPILE in your shell.
2700Note that no changes to the Makefile or any other source files are
2701necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002702
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002703 $ CROSS_COMPILE=ppc_4xx-
2704 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002705
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002706U-Boot is intended to be simple to build. After installing the
2707sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002708is done by typing:
2709
2710 make NAME_config
2711
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002712where "NAME_config" is the name of one of the existing configu-
2713rations; see the main Makefile for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00002714
wdenk6c59edc2004-05-03 20:45:30 +00002715Note: for some board special configuration names may exist; check if
2716 additional information is available from the board vendor; for
2717 instance, the TQM823L systems are available without (standard)
2718 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002719 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002720
wdenk6c59edc2004-05-03 20:45:30 +00002721 make TQM823L_config
2722 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002723
wdenk6c59edc2004-05-03 20:45:30 +00002724 make TQM823L_LCD_config
2725 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002726
wdenk6c59edc2004-05-03 20:45:30 +00002727 etc.
wdenkc6097192002-11-03 00:24:07 +00002728
wdenkc6097192002-11-03 00:24:07 +00002729
wdenk6c59edc2004-05-03 20:45:30 +00002730Finally, type "make all", and you should get some working U-Boot
2731images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002732
wdenk6c59edc2004-05-03 20:45:30 +00002733- "u-boot.bin" is a raw binary image
2734- "u-boot" is an image in ELF binary format
2735- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002736
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002737By default the build is performed locally and the objects are saved
2738in the source directory. One of the two methods can be used to change
2739this behavior and build U-Boot to some external directory:
2740
27411. Add O= to the make command line invocations:
2742
2743 make O=/tmp/build distclean
2744 make O=/tmp/build NAME_config
2745 make O=/tmp/build all
2746
27472. Set environment variable BUILD_DIR to point to the desired location:
2748
2749 export BUILD_DIR=/tmp/build
2750 make distclean
2751 make NAME_config
2752 make all
2753
2754Note that the command line "O=" setting overrides the BUILD_DIR environment
2755variable.
2756
wdenkc6097192002-11-03 00:24:07 +00002757
wdenk6c59edc2004-05-03 20:45:30 +00002758Please be aware that the Makefiles assume you are using GNU make, so
2759for instance on NetBSD you might need to use "gmake" instead of
2760native "make".
wdenkc6097192002-11-03 00:24:07 +00002761
wdenkc6097192002-11-03 00:24:07 +00002762
wdenk6c59edc2004-05-03 20:45:30 +00002763If the system board that you have is not listed, then you will need
2764to port U-Boot to your hardware platform. To do this, follow these
2765steps:
wdenkc6097192002-11-03 00:24:07 +00002766
wdenk6c59edc2004-05-03 20:45:30 +000027671. Add a new configuration option for your board to the toplevel
2768 "Makefile" and to the "MAKEALL" script, using the existing
2769 entries as examples. Note that here and at many other places
2770 boards and other names are listed in alphabetical sort order. Please
2771 keep this order.
27722. Create a new directory to hold your board specific code. Add any
2773 files you need. In your board directory, you will need at least
2774 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
27753. Create a new configuration file "include/configs/<board>.h" for
2776 your board
27773. If you're porting U-Boot to a new CPU, then also create a new
2778 directory to hold your CPU specific code. Add any files you need.
27794. Run "make <board>_config" with your new name.
27805. Type "make", and you should get a working "u-boot.srec" file
2781 to be installed on your target system.
27826. Debug and solve any problems that might arise.
2783 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002784
wdenkc6097192002-11-03 00:24:07 +00002785
wdenk6c59edc2004-05-03 20:45:30 +00002786Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2787==============================================================
wdenkc6097192002-11-03 00:24:07 +00002788
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002789If you have modified U-Boot sources (for instance added a new board
2790or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00002791provide feedback to the other developers. The feedback normally takes
2792the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002793official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002794
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002795But before you submit such a patch, please verify that your modifi-
2796cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00002797the supported boards compile WITHOUT ANY compiler warnings. To do so,
2798just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002799for ALL supported system. Be warned, this will take a while. You can
2800select which (cross) compiler to use by passing a `CROSS_COMPILE'
2801environment variable to the script, i. e. to use the ELDK cross tools
2802you can type
wdenkc6097192002-11-03 00:24:07 +00002803
wdenk6c59edc2004-05-03 20:45:30 +00002804 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002805
wdenk6c59edc2004-05-03 20:45:30 +00002806or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002807
wdenk6c59edc2004-05-03 20:45:30 +00002808 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002809
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002810When using the MAKEALL script, the default behaviour is to build
2811U-Boot in the source directory. This location can be changed by
2812setting the BUILD_DIR environment variable. Also, for each target
2813built, the MAKEALL script saves two log files (<target>.ERR and
2814<target>.MAKEALL) in the <source dir>/LOG directory. This default
2815location can be changed by setting the MAKEALL_LOGDIR environment
2816variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002817
2818 export BUILD_DIR=/tmp/build
2819 export MAKEALL_LOGDIR=/tmp/log
2820 CROSS_COMPILE=ppc_8xx- MAKEALL
2821
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002822With the above settings build objects are saved in the /tmp/build,
2823log files are saved in the /tmp/log and the source tree remains clean
2824during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002825
2826
wdenk6c59edc2004-05-03 20:45:30 +00002827See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002828
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk6c59edc2004-05-03 20:45:30 +00002830Monitor Commands - Overview:
2831============================
wdenkc6097192002-11-03 00:24:07 +00002832
wdenk6c59edc2004-05-03 20:45:30 +00002833go - start application at address 'addr'
2834run - run commands in an environment variable
2835bootm - boot application image from memory
2836bootp - boot image via network using BootP/TFTP protocol
2837tftpboot- boot image via network using TFTP protocol
2838 and env variables "ipaddr" and "serverip"
2839 (and eventually "gatewayip")
2840rarpboot- boot image via network using RARP/TFTP protocol
2841diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2842loads - load S-Record file over serial line
2843loadb - load binary file over serial line (kermit mode)
2844md - memory display
2845mm - memory modify (auto-incrementing)
2846nm - memory modify (constant address)
2847mw - memory write (fill)
2848cp - memory copy
2849cmp - memory compare
2850crc32 - checksum calculation
2851imd - i2c memory display
2852imm - i2c memory modify (auto-incrementing)
2853inm - i2c memory modify (constant address)
2854imw - i2c memory write (fill)
2855icrc32 - i2c checksum calculation
2856iprobe - probe to discover valid I2C chip addresses
2857iloop - infinite loop on address range
2858isdram - print SDRAM configuration information
2859sspi - SPI utility commands
2860base - print or set address offset
2861printenv- print environment variables
2862setenv - set environment variables
2863saveenv - save environment variables to persistent storage
2864protect - enable or disable FLASH write protection
2865erase - erase FLASH memory
2866flinfo - print FLASH memory information
2867bdinfo - print Board Info structure
2868iminfo - print header information for application image
2869coninfo - print console devices and informations
2870ide - IDE sub-system
2871loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00002872loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00002873mtest - simple RAM test
2874icache - enable or disable instruction cache
2875dcache - enable or disable data cache
2876reset - Perform RESET of the CPU
2877echo - echo args to console
2878version - print monitor version
2879help - print online help
2880? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002881
wdenkc6097192002-11-03 00:24:07 +00002882
wdenk6c59edc2004-05-03 20:45:30 +00002883Monitor Commands - Detailed Description:
2884========================================
wdenkc6097192002-11-03 00:24:07 +00002885
wdenk6c59edc2004-05-03 20:45:30 +00002886TODO.
wdenkc6097192002-11-03 00:24:07 +00002887
wdenk6c59edc2004-05-03 20:45:30 +00002888For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002889
2890
wdenk6c59edc2004-05-03 20:45:30 +00002891Environment Variables:
2892======================
wdenkc6097192002-11-03 00:24:07 +00002893
wdenk6c59edc2004-05-03 20:45:30 +00002894U-Boot supports user configuration using Environment Variables which
2895can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002896
wdenk6c59edc2004-05-03 20:45:30 +00002897Environment Variables are set using "setenv", printed using
2898"printenv", and saved to Flash using "saveenv". Using "setenv"
2899without a value can be used to delete a variable from the
2900environment. As long as you don't save the environment you are
2901working with an in-memory copy. In case the Flash area containing the
2902environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002903
wdenk6c59edc2004-05-03 20:45:30 +00002904Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002905
wdenk6c59edc2004-05-03 20:45:30 +00002906 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002907
wdenk6c59edc2004-05-03 20:45:30 +00002908 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002909
wdenk6c59edc2004-05-03 20:45:30 +00002910 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002911
wdenk6c59edc2004-05-03 20:45:30 +00002912 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002913
wdenk6c59edc2004-05-03 20:45:30 +00002914 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002915
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002916 bootm_low - Memory range available for image processing in the bootm
2917 command can be restricted. This variable is given as
2918 a hexadecimal number and defines lowest address allowed
2919 for use by the bootm command. See also "bootm_size"
2920 environment variable. Address defined by "bootm_low" is
2921 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002922 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002923
2924 bootm_size - Memory range available for image processing in the bootm
2925 command can be restricted. This variable is given as
2926 a hexadecimal number and defines the size of the region
2927 allowed for use by the bootm command. See also "bootm_low"
2928 environment variable.
2929
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02002930 updatefile - Location of the software update file on a TFTP server, used
2931 by the automatic software update feature. Please refer to
2932 documentation in doc/README.update for more details.
2933
wdenk6c59edc2004-05-03 20:45:30 +00002934 autoload - if set to "no" (any string beginning with 'n'),
2935 "bootp" will just load perform a lookup of the
2936 configuration from the BOOTP server, but not try to
2937 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002938
Marian Balakowicz18710b82008-03-12 12:13:13 +01002939 autoscript - if set to "yes" commands like "loadb", "loady",
2940 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
2941 to automatically run script images (by internally
2942 calling "autoscript").
2943
2944 autoscript_uname - if script image is in a format (FIT) this
2945 variable is used to get script subimage unit name.
2946
wdenk6c59edc2004-05-03 20:45:30 +00002947 autostart - if set to "yes", an image loaded using the "bootp",
2948 "rarpboot", "tftpboot" or "diskboot" commands will
2949 be automatically started (by internally calling
2950 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002951
wdenk6c59edc2004-05-03 20:45:30 +00002952 If set to "no", a standalone image passed to the
2953 "bootm" command will be copied to the load address
2954 (and eventually uncompressed), but NOT be started.
2955 This can be used to load and uncompress arbitrary
2956 data.
wdenkc6097192002-11-03 00:24:07 +00002957
wdenk0e2bd9c2004-06-06 21:51:03 +00002958 i2cfast - (PPC405GP|PPC405EP only)
2959 if set to 'y' configures Linux I2C driver for fast
2960 mode (400kHZ). This environment variable is used in
2961 initialization code. So, for changes to be effective
2962 it must be saved and board must be reset.
2963
wdenk6c59edc2004-05-03 20:45:30 +00002964 initrd_high - restrict positioning of initrd images:
2965 If this variable is not set, initrd images will be
2966 copied to the highest possible address in RAM; this
2967 is usually what you want since it allows for
2968 maximum initrd size. If for some reason you want to
2969 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002970 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00002971 variable to a value of "no" or "off" or "0".
2972 Alternatively, you can set it to a maximum upper
2973 address to use (U-Boot will still check that it
2974 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002975
wdenk6c59edc2004-05-03 20:45:30 +00002976 For instance, when you have a system with 16 MB
2977 RAM, and want to reserve 4 MB from use by Linux,
2978 you can do this by adding "mem=12M" to the value of
2979 the "bootargs" variable. However, now you must make
2980 sure that the initrd image is placed in the first
2981 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002982
wdenk6c59edc2004-05-03 20:45:30 +00002983 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002984
wdenk6c59edc2004-05-03 20:45:30 +00002985 If you set initrd_high to 0xFFFFFFFF, this is an
2986 indication to U-Boot that all addresses are legal
2987 for the Linux kernel, including addresses in flash
2988 memory. In this case U-Boot will NOT COPY the
2989 ramdisk at all. This may be useful to reduce the
2990 boot time on your system, but requires that this
2991 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00002992
wdenk6c59edc2004-05-03 20:45:30 +00002993 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002994
wdenk6c59edc2004-05-03 20:45:30 +00002995 loadaddr - Default load address for commands like "bootp",
2996 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002997
wdenk6c59edc2004-05-03 20:45:30 +00002998 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002999
wdenk6c59edc2004-05-03 20:45:30 +00003000 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00003001
wdenk6c59edc2004-05-03 20:45:30 +00003002 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003003
wdenk6c59edc2004-05-03 20:45:30 +00003004 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003005
wdenk6c59edc2004-05-03 20:45:30 +00003006 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003007
wdenk6c59edc2004-05-03 20:45:30 +00003008 ethprime - When CONFIG_NET_MULTI is enabled controls which
3009 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003010
wdenk6c59edc2004-05-03 20:45:30 +00003011 ethact - When CONFIG_NET_MULTI is enabled controls which
3012 interface is currently active. For example you
3013 can do the following
wdenkc6097192002-11-03 00:24:07 +00003014
wdenk6c59edc2004-05-03 20:45:30 +00003015 => setenv ethact FEC ETHERNET
3016 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3017 => setenv ethact SCC ETHERNET
3018 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00003019
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01003020 ethrotate - When set to "no" U-Boot does not go through all
3021 available network interfaces.
3022 It just stays at the currently selected interface.
3023
wdenk6c59edc2004-05-03 20:45:30 +00003024 netretry - When set to "no" each network operation will
3025 either succeed or fail without retrying.
3026 When set to "once" the network operation will
3027 fail when all the available network interfaces
3028 are tried once without success.
3029 Useful on scripts which control the retry operation
3030 themselves.
wdenkc6097192002-11-03 00:24:07 +00003031
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01003032 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003033
Wolfgang Denk227b5192005-09-24 23:25:46 +02003034 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003035 UDP source port.
3036
Wolfgang Denk227b5192005-09-24 23:25:46 +02003037 tftpdstport - If this is set, the value is used for TFTP's UDP
3038 destination port instead of the Well Know Port 69.
3039
wdenk6c59edc2004-05-03 20:45:30 +00003040 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003041 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003042 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003043
wdenk6c59edc2004-05-03 20:45:30 +00003044The following environment variables may be used and automatically
3045updated by the network boot commands ("bootp" and "rarpboot"),
3046depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003047
wdenk6c59edc2004-05-03 20:45:30 +00003048 bootfile - see above
3049 dnsip - IP address of your Domain Name Server
3050 dnsip2 - IP address of your secondary Domain Name Server
3051 gatewayip - IP address of the Gateway (Router) to use
3052 hostname - Target hostname
3053 ipaddr - see above
3054 netmask - Subnet Mask
3055 rootpath - Pathname of the root filesystem on the NFS server
3056 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003057
wdenk145d2c12004-04-15 21:48:45 +00003058
wdenk6c59edc2004-05-03 20:45:30 +00003059There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003060
wdenk6c59edc2004-05-03 20:45:30 +00003061 serial# - contains hardware identification information such
3062 as type string and/or serial number
3063 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003064
wdenk6c59edc2004-05-03 20:45:30 +00003065These variables can be set only once (usually during manufacturing of
3066the board). U-Boot refuses to delete or overwrite these variables
3067once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003068
3069
wdenk6c59edc2004-05-03 20:45:30 +00003070Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk6c59edc2004-05-03 20:45:30 +00003072 ver - Contains the U-Boot version string as printed
3073 with the "version" command. This variable is
3074 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003075
wdenkc6097192002-11-03 00:24:07 +00003076
wdenk6c59edc2004-05-03 20:45:30 +00003077Please note that changes to some configuration parameters may take
3078only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003079
stroeseb9c17c52003-04-04 15:53:41 +00003080
wdenk6c59edc2004-05-03 20:45:30 +00003081Command Line Parsing:
3082=====================
stroeseb9c17c52003-04-04 15:53:41 +00003083
wdenk6c59edc2004-05-03 20:45:30 +00003084There are two different command line parsers available with U-Boot:
3085the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003086
wdenk6c59edc2004-05-03 20:45:30 +00003087Old, simple command line parser:
3088--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003089
wdenk6c59edc2004-05-03 20:45:30 +00003090- supports environment variables (through setenv / saveenv commands)
3091- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003092- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003093- special characters ('$', ';') can be escaped by prefixing with '\',
3094 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003095 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003096- You can also escape text by enclosing in single apostrophes, for example:
3097 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003098
wdenk6c59edc2004-05-03 20:45:30 +00003099Hush shell:
3100-----------
wdenkf4688a22003-05-28 08:06:31 +00003101
wdenk6c59edc2004-05-03 20:45:30 +00003102- similar to Bourne shell, with control structures like
3103 if...then...else...fi, for...do...done; while...do...done,
3104 until...do...done, ...
3105- supports environment ("global") variables (through setenv / saveenv
3106 commands) and local shell variables (through standard shell syntax
3107 "name=value"); only environment variables can be used with "run"
3108 command
wdenkf4688a22003-05-28 08:06:31 +00003109
wdenk6c59edc2004-05-03 20:45:30 +00003110General rules:
3111--------------
wdenkf4688a22003-05-28 08:06:31 +00003112
wdenk6c59edc2004-05-03 20:45:30 +00003113(1) If a command line (or an environment variable executed by a "run"
3114 command) contains several commands separated by semicolon, and
3115 one of these commands fails, then the remaining commands will be
3116 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003117
wdenk6c59edc2004-05-03 20:45:30 +00003118(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003119 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003120 command will cause "run" to terminate, i. e. the remaining
3121 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003122
wdenk6c59edc2004-05-03 20:45:30 +00003123Note for Redundant Ethernet Interfaces:
3124=======================================
wdenkf4688a22003-05-28 08:06:31 +00003125
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003126Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003127such configurations and is capable of automatic selection of a
3128"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003129
wdenk6c59edc2004-05-03 20:45:30 +00003130Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3131MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3132"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003133
wdenk6c59edc2004-05-03 20:45:30 +00003134If the network interface stores some valid MAC address (for instance
3135in SROM), this is used as default address if there is NO correspon-
3136ding setting in the environment; if the corresponding environment
3137variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003138
wdenk6c59edc2004-05-03 20:45:30 +00003139o If the SROM has a valid MAC address, and there is no address in the
3140 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003141
wdenk6c59edc2004-05-03 20:45:30 +00003142o If there is no valid address in the SROM, and a definition in the
3143 environment exists, then the value from the environment variable is
3144 used.
wdenkc6097192002-11-03 00:24:07 +00003145
wdenk6c59edc2004-05-03 20:45:30 +00003146o If both the SROM and the environment contain a MAC address, and
3147 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003148
wdenk6c59edc2004-05-03 20:45:30 +00003149o If both the SROM and the environment contain a MAC address, and the
3150 addresses differ, the value from the environment is used and a
3151 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003152
wdenk6c59edc2004-05-03 20:45:30 +00003153o If neither SROM nor the environment contain a MAC address, an error
3154 is raised.
wdenkc6097192002-11-03 00:24:07 +00003155
wdenkc6097192002-11-03 00:24:07 +00003156
wdenk6c59edc2004-05-03 20:45:30 +00003157Image Formats:
3158==============
wdenkc6097192002-11-03 00:24:07 +00003159
Marian Balakowicz18710b82008-03-12 12:13:13 +01003160U-Boot is capable of booting (and performing other auxiliary operations on)
3161images in two formats:
3162
3163New uImage format (FIT)
3164-----------------------
3165
3166Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3167to Flattened Device Tree). It allows the use of images with multiple
3168components (several kernels, ramdisks, etc.), with contents protected by
3169SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3170
3171
3172Old uImage format
3173-----------------
3174
3175Old image format is based on binary files which can be basically anything,
3176preceded by a special header; see the definitions in include/image.h for
3177details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003178
wdenk6c59edc2004-05-03 20:45:30 +00003179* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3180 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003181 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3182 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3183 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02003184* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk6c59edc2004-05-03 20:45:30 +00003185 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk83c15852006-10-24 14:21:16 +02003186 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003187* Compression Type (uncompressed, gzip, bzip2)
3188* Load Address
3189* Entry Point
3190* Image Name
3191* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003192
wdenk6c59edc2004-05-03 20:45:30 +00003193The header is marked by a special Magic Number, and both the header
3194and the data portions of the image are secured against corruption by
3195CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003196
wdenkc6097192002-11-03 00:24:07 +00003197
wdenk6c59edc2004-05-03 20:45:30 +00003198Linux Support:
3199==============
wdenkc6097192002-11-03 00:24:07 +00003200
wdenk6c59edc2004-05-03 20:45:30 +00003201Although U-Boot should support any OS or standalone application
3202easily, the main focus has always been on Linux during the design of
3203U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003204
wdenk6c59edc2004-05-03 20:45:30 +00003205U-Boot includes many features that so far have been part of some
3206special "boot loader" code within the Linux kernel. Also, any
3207"initrd" images to be used are no longer part of one big Linux image;
3208instead, kernel and "initrd" are separate images. This implementation
3209serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003210
wdenk6c59edc2004-05-03 20:45:30 +00003211- the same features can be used for other OS or standalone
3212 applications (for instance: using compressed images to reduce the
3213 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003214
wdenk6c59edc2004-05-03 20:45:30 +00003215- it becomes much easier to port new Linux kernel versions because
3216 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003217
wdenk6c59edc2004-05-03 20:45:30 +00003218- the same Linux kernel image can now be used with different "initrd"
3219 images; of course this also means that different kernel images can
3220 be run with the same "initrd". This makes testing easier (you don't
3221 have to build a new "zImage.initrd" Linux image when you just
3222 change a file in your "initrd"). Also, a field-upgrade of the
3223 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003224
wdenkc6097192002-11-03 00:24:07 +00003225
wdenk6c59edc2004-05-03 20:45:30 +00003226Linux HOWTO:
3227============
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk6c59edc2004-05-03 20:45:30 +00003229Porting Linux to U-Boot based systems:
3230---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003231
wdenk6c59edc2004-05-03 20:45:30 +00003232U-Boot cannot save you from doing all the necessary modifications to
3233configure the Linux device drivers for use with your target hardware
3234(no, we don't intend to provide a full virtual machine interface to
3235Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003236
wdenk6c59edc2004-05-03 20:45:30 +00003237But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003238
wdenk6c59edc2004-05-03 20:45:30 +00003239Just make sure your machine specific header file (for instance
3240include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003241Information structure as we define in include/asm-<arch>/u-boot.h,
3242and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003243as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003244
wdenkc6097192002-11-03 00:24:07 +00003245
wdenk6c59edc2004-05-03 20:45:30 +00003246Configuring the Linux kernel:
3247-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003248
wdenk6c59edc2004-05-03 20:45:30 +00003249No specific requirements for U-Boot. Make sure you have some root
3250device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003251
wdenkc6097192002-11-03 00:24:07 +00003252
wdenk6c59edc2004-05-03 20:45:30 +00003253Building a Linux Image:
3254-----------------------
wdenkc6097192002-11-03 00:24:07 +00003255
wdenk6c59edc2004-05-03 20:45:30 +00003256With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3257not used. If you use recent kernel source, a new build target
3258"uImage" will exist which automatically builds an image usable by
3259U-Boot. Most older kernels also have support for a "pImage" target,
3260which was introduced for our predecessor project PPCBoot and uses a
3261100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003262
wdenk6c59edc2004-05-03 20:45:30 +00003263Example:
wdenkc6097192002-11-03 00:24:07 +00003264
wdenk6c59edc2004-05-03 20:45:30 +00003265 make TQM850L_config
3266 make oldconfig
3267 make dep
3268 make uImage
wdenkc6097192002-11-03 00:24:07 +00003269
wdenk6c59edc2004-05-03 20:45:30 +00003270The "uImage" build target uses a special tool (in 'tools/mkimage') to
3271encapsulate a compressed Linux kernel image with header information,
3272CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003273
wdenk6c59edc2004-05-03 20:45:30 +00003274* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003275
wdenk6c59edc2004-05-03 20:45:30 +00003276* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003277
wdenk6c59edc2004-05-03 20:45:30 +00003278 ${CROSS_COMPILE}-objcopy -O binary \
3279 -R .note -R .comment \
3280 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003281
wdenk6c59edc2004-05-03 20:45:30 +00003282* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003283
wdenk6c59edc2004-05-03 20:45:30 +00003284 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003285
wdenk6c59edc2004-05-03 20:45:30 +00003286* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003287
wdenk6c59edc2004-05-03 20:45:30 +00003288 mkimage -A ppc -O linux -T kernel -C gzip \
3289 -a 0 -e 0 -n "Linux Kernel Image" \
3290 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003291
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk6c59edc2004-05-03 20:45:30 +00003293The "mkimage" tool can also be used to create ramdisk images for use
3294with U-Boot, either separated from the Linux kernel image, or
3295combined into one file. "mkimage" encapsulates the images with a 64
3296byte header containing information about target architecture,
3297operating system, image type, compression method, entry points, time
3298stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003299
wdenk6c59edc2004-05-03 20:45:30 +00003300"mkimage" can be called in two ways: to verify existing images and
3301print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003302
wdenk6c59edc2004-05-03 20:45:30 +00003303In the first form (with "-l" option) mkimage lists the information
3304contained in the header of an existing U-Boot image; this includes
3305checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003306
wdenk6c59edc2004-05-03 20:45:30 +00003307 tools/mkimage -l image
3308 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003309
wdenk6c59edc2004-05-03 20:45:30 +00003310The second form (with "-d" option) is used to build a U-Boot image
3311from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003312
wdenk6c59edc2004-05-03 20:45:30 +00003313 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3314 -n name -d data_file image
3315 -A ==> set architecture to 'arch'
3316 -O ==> set operating system to 'os'
3317 -T ==> set image type to 'type'
3318 -C ==> set compression type 'comp'
3319 -a ==> set load address to 'addr' (hex)
3320 -e ==> set entry point to 'ep' (hex)
3321 -n ==> set image name to 'name'
3322 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003323
wdenkcd914452004-05-29 16:53:29 +00003324Right now, all Linux kernels for PowerPC systems use the same load
3325address (0x00000000), but the entry point address depends on the
3326kernel version:
wdenkc6097192002-11-03 00:24:07 +00003327
wdenk6c59edc2004-05-03 20:45:30 +00003328- 2.2.x kernels have the entry point at 0x0000000C,
3329- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk6c59edc2004-05-03 20:45:30 +00003331So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk6c59edc2004-05-03 20:45:30 +00003333 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3334 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3335 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3336 > examples/uImage.TQM850L
3337 Image Name: 2.4.4 kernel for TQM850L
3338 Created: Wed Jul 19 02:34:59 2000
3339 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3340 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3341 Load Address: 0x00000000
3342 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003343
wdenk6c59edc2004-05-03 20:45:30 +00003344To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003345
wdenk6c59edc2004-05-03 20:45:30 +00003346 -> tools/mkimage -l examples/uImage.TQM850L
3347 Image Name: 2.4.4 kernel for TQM850L
3348 Created: Wed Jul 19 02:34:59 2000
3349 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3350 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3351 Load Address: 0x00000000
3352 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003353
wdenk6c59edc2004-05-03 20:45:30 +00003354NOTE: for embedded systems where boot time is critical you can trade
3355speed for memory and install an UNCOMPRESSED image instead: this
3356needs more space in Flash, but boots much faster since it does not
3357need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003358
wdenk6c59edc2004-05-03 20:45:30 +00003359 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3360 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3361 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3362 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3363 > examples/uImage.TQM850L-uncompressed
3364 Image Name: 2.4.4 kernel for TQM850L
3365 Created: Wed Jul 19 02:34:59 2000
3366 Image Type: PowerPC Linux Kernel Image (uncompressed)
3367 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3368 Load Address: 0x00000000
3369 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003370
wdenkc6097192002-11-03 00:24:07 +00003371
wdenk6c59edc2004-05-03 20:45:30 +00003372Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3373when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003374
wdenk6c59edc2004-05-03 20:45:30 +00003375 -> tools/mkimage -n 'Simple Ramdisk Image' \
3376 > -A ppc -O linux -T ramdisk -C gzip \
3377 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3378 Image Name: Simple Ramdisk Image
3379 Created: Wed Jan 12 14:01:50 2000
3380 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3381 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3382 Load Address: 0x00000000
3383 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003384
wdenkc6097192002-11-03 00:24:07 +00003385
wdenk6c59edc2004-05-03 20:45:30 +00003386Installing a Linux Image:
3387-------------------------
wdenkc6097192002-11-03 00:24:07 +00003388
wdenk6c59edc2004-05-03 20:45:30 +00003389To downloading a U-Boot image over the serial (console) interface,
3390you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003391
wdenk6c59edc2004-05-03 20:45:30 +00003392 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003393
wdenk6c59edc2004-05-03 20:45:30 +00003394The 'objcopy' does not understand the information in the U-Boot
3395image header, so the resulting S-Record file will be relative to
3396address 0x00000000. To load it to a given address, you need to
3397specify the target address as 'offset' parameter with the 'loads'
3398command.
wdenkc6097192002-11-03 00:24:07 +00003399
wdenk6c59edc2004-05-03 20:45:30 +00003400Example: install the image to address 0x40100000 (which on the
3401TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk6c59edc2004-05-03 20:45:30 +00003403 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003404
wdenk6c59edc2004-05-03 20:45:30 +00003405 .......... done
3406 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk6c59edc2004-05-03 20:45:30 +00003408 => loads 40100000
3409 ## Ready for S-Record download ...
3410 ~>examples/image.srec
3411 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3412 ...
3413 15989 15990 15991 15992
3414 [file transfer complete]
3415 [connected]
3416 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003417
wdenkc6097192002-11-03 00:24:07 +00003418
wdenk6c59edc2004-05-03 20:45:30 +00003419You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003420this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00003421corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003422
wdenk6c59edc2004-05-03 20:45:30 +00003423 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003424
wdenk6c59edc2004-05-03 20:45:30 +00003425 ## Checking Image at 40100000 ...
3426 Image Name: 2.2.13 for initrd on TQM850L
3427 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3428 Data Size: 335725 Bytes = 327 kB = 0 MB
3429 Load Address: 00000000
3430 Entry Point: 0000000c
3431 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003432
3433
wdenk6c59edc2004-05-03 20:45:30 +00003434Boot Linux:
3435-----------
wdenkc6097192002-11-03 00:24:07 +00003436
wdenk6c59edc2004-05-03 20:45:30 +00003437The "bootm" command is used to boot an application that is stored in
3438memory (RAM or Flash). In case of a Linux kernel image, the contents
3439of the "bootargs" environment variable is passed to the kernel as
3440parameters. You can check and modify this variable using the
3441"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003442
wdenkc6097192002-11-03 00:24:07 +00003443
wdenk6c59edc2004-05-03 20:45:30 +00003444 => printenv bootargs
3445 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003446
wdenk6c59edc2004-05-03 20:45:30 +00003447 => 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 +00003448
wdenk6c59edc2004-05-03 20:45:30 +00003449 => printenv bootargs
3450 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 +00003451
wdenk6c59edc2004-05-03 20:45:30 +00003452 => bootm 40020000
3453 ## Booting Linux kernel at 40020000 ...
3454 Image Name: 2.2.13 for NFS on TQM850L
3455 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3456 Data Size: 381681 Bytes = 372 kB = 0 MB
3457 Load Address: 00000000
3458 Entry Point: 0000000c
3459 Verifying Checksum ... OK
3460 Uncompressing Kernel Image ... OK
3461 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
3462 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3463 time_init: decrementer frequency = 187500000/60
3464 Calibrating delay loop... 49.77 BogoMIPS
3465 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3466 ...
wdenkc6097192002-11-03 00:24:07 +00003467
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003468If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00003469the memory addresses of both the kernel and the initrd image (PPBCOOT
3470format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003471
wdenk6c59edc2004-05-03 20:45:30 +00003472 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003473
wdenk6c59edc2004-05-03 20:45:30 +00003474 ## Checking Image at 40100000 ...
3475 Image Name: 2.2.13 for initrd on TQM850L
3476 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3477 Data Size: 335725 Bytes = 327 kB = 0 MB
3478 Load Address: 00000000
3479 Entry Point: 0000000c
3480 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk6c59edc2004-05-03 20:45:30 +00003482 ## Checking Image at 40200000 ...
3483 Image Name: Simple Ramdisk Image
3484 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3485 Data Size: 566530 Bytes = 553 kB = 0 MB
3486 Load Address: 00000000
3487 Entry Point: 00000000
3488 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003489
wdenk6c59edc2004-05-03 20:45:30 +00003490 => bootm 40100000 40200000
3491 ## Booting Linux kernel at 40100000 ...
3492 Image Name: 2.2.13 for initrd on TQM850L
3493 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3494 Data Size: 335725 Bytes = 327 kB = 0 MB
3495 Load Address: 00000000
3496 Entry Point: 0000000c
3497 Verifying Checksum ... OK
3498 Uncompressing Kernel Image ... OK
3499 ## Loading RAMDisk Image at 40200000 ...
3500 Image Name: Simple Ramdisk Image
3501 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3502 Data Size: 566530 Bytes = 553 kB = 0 MB
3503 Load Address: 00000000
3504 Entry Point: 00000000
3505 Verifying Checksum ... OK
3506 Loading Ramdisk ... OK
3507 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
3508 Boot arguments: root=/dev/ram
3509 time_init: decrementer frequency = 187500000/60
3510 Calibrating delay loop... 49.77 BogoMIPS
3511 ...
3512 RAMDISK: Compressed image found at block 0
3513 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003514
wdenk6c59edc2004-05-03 20:45:30 +00003515 bash#
wdenkc6097192002-11-03 00:24:07 +00003516
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003517Boot Linux and pass a flat device tree:
3518-----------
3519
3520First, U-Boot must be compiled with the appropriate defines. See the section
3521titled "Linux Kernel Interface" above for a more in depth explanation. The
3522following is an example of how to start a kernel and pass an updated
3523flat device tree:
3524
3525=> print oftaddr
3526oftaddr=0x300000
3527=> print oft
3528oft=oftrees/mpc8540ads.dtb
3529=> tftp $oftaddr $oft
3530Speed: 1000, full duplex
3531Using TSEC0 device
3532TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3533Filename 'oftrees/mpc8540ads.dtb'.
3534Load address: 0x300000
3535Loading: #
3536done
3537Bytes transferred = 4106 (100a hex)
3538=> tftp $loadaddr $bootfile
3539Speed: 1000, full duplex
3540Using TSEC0 device
3541TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3542Filename 'uImage'.
3543Load address: 0x200000
3544Loading:############
3545done
3546Bytes transferred = 1029407 (fb51f hex)
3547=> print loadaddr
3548loadaddr=200000
3549=> print oftaddr
3550oftaddr=0x300000
3551=> bootm $loadaddr - $oftaddr
3552## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01003553 Image Name: Linux-2.6.17-dirty
3554 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3555 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003556 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01003557 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003558 Verifying Checksum ... OK
3559 Uncompressing Kernel Image ... OK
3560Booting using flat device tree at 0x300000
3561Using MPC85xx ADS machine description
3562Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3563[snip]
3564
3565
wdenk6c59edc2004-05-03 20:45:30 +00003566More About U-Boot Image Types:
3567------------------------------
wdenkc6097192002-11-03 00:24:07 +00003568
wdenk6c59edc2004-05-03 20:45:30 +00003569U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00003570
wdenk6c59edc2004-05-03 20:45:30 +00003571 "Standalone Programs" are directly runnable in the environment
3572 provided by U-Boot; it is expected that (if they behave
3573 well) you can continue to work in U-Boot after return from
3574 the Standalone Program.
3575 "OS Kernel Images" are usually images of some Embedded OS which
3576 will take over control completely. Usually these programs
3577 will install their own set of exception handlers, device
3578 drivers, set up the MMU, etc. - this means, that you cannot
3579 expect to re-enter U-Boot except by resetting the CPU.
3580 "RAMDisk Images" are more or less just data blocks, and their
3581 parameters (address, size) are passed to an OS kernel that is
3582 being started.
3583 "Multi-File Images" contain several images, typically an OS
3584 (Linux) kernel image and one or more data images like
3585 RAMDisks. This construct is useful for instance when you want
3586 to boot over the network using BOOTP etc., where the boot
3587 server provides just a single image file, but you want to get
3588 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00003589
wdenk6c59edc2004-05-03 20:45:30 +00003590 "Multi-File Images" start with a list of image sizes, each
3591 image size (in bytes) specified by an "uint32_t" in network
3592 byte order. This list is terminated by an "(uint32_t)0".
3593 Immediately after the terminating 0 follow the images, one by
3594 one, all aligned on "uint32_t" boundaries (size rounded up to
3595 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00003596
wdenk6c59edc2004-05-03 20:45:30 +00003597 "Firmware Images" are binary images containing firmware (like
3598 U-Boot or FPGA images) which usually will be programmed to
3599 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00003600
wdenk6c59edc2004-05-03 20:45:30 +00003601 "Script files" are command sequences that will be executed by
3602 U-Boot's command interpreter; this feature is especially
3603 useful when you configure U-Boot to use a real shell (hush)
3604 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00003605
stroeseb9c17c52003-04-04 15:53:41 +00003606
wdenk6c59edc2004-05-03 20:45:30 +00003607Standalone HOWTO:
3608=================
stroeseb9c17c52003-04-04 15:53:41 +00003609
wdenk6c59edc2004-05-03 20:45:30 +00003610One of the features of U-Boot is that you can dynamically load and
3611run "standalone" applications, which can use some resources of
3612U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00003613
wdenk6c59edc2004-05-03 20:45:30 +00003614Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00003615
wdenk6c59edc2004-05-03 20:45:30 +00003616"Hello World" Demo:
3617-------------------
wdenkc6097192002-11-03 00:24:07 +00003618
wdenk6c59edc2004-05-03 20:45:30 +00003619'examples/hello_world.c' contains a small "Hello World" Demo
3620application; it is automatically compiled when you build U-Boot.
3621It's configured to run at address 0x00040004, so you can play with it
3622like that:
wdenkc6097192002-11-03 00:24:07 +00003623
wdenk6c59edc2004-05-03 20:45:30 +00003624 => loads
3625 ## Ready for S-Record download ...
3626 ~>examples/hello_world.srec
3627 1 2 3 4 5 6 7 8 9 10 11 ...
3628 [file transfer complete]
3629 [connected]
3630 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003631
wdenk6c59edc2004-05-03 20:45:30 +00003632 => go 40004 Hello World! This is a test.
3633 ## Starting application at 0x00040004 ...
3634 Hello World
3635 argc = 7
3636 argv[0] = "40004"
3637 argv[1] = "Hello"
3638 argv[2] = "World!"
3639 argv[3] = "This"
3640 argv[4] = "is"
3641 argv[5] = "a"
3642 argv[6] = "test."
3643 argv[7] = "<NULL>"
3644 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003645
wdenk6c59edc2004-05-03 20:45:30 +00003646 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003647
wdenk6c59edc2004-05-03 20:45:30 +00003648Another example, which demonstrates how to register a CPM interrupt
3649handler with the U-Boot code, can be found in 'examples/timer.c'.
3650Here, a CPM timer is set up to generate an interrupt every second.
3651The interrupt service routine is trivial, just printing a '.'
3652character, but this is just a demo program. The application can be
3653controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003654
wdenk6c59edc2004-05-03 20:45:30 +00003655 ? - print current values og the CPM Timer registers
3656 b - enable interrupts and start timer
3657 e - stop timer and disable interrupts
3658 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003659
wdenk6c59edc2004-05-03 20:45:30 +00003660 => loads
3661 ## Ready for S-Record download ...
3662 ~>examples/timer.srec
3663 1 2 3 4 5 6 7 8 9 10 11 ...
3664 [file transfer complete]
3665 [connected]
3666 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003667
wdenk6c59edc2004-05-03 20:45:30 +00003668 => go 40004
3669 ## Starting application at 0x00040004 ...
3670 TIMERS=0xfff00980
3671 Using timer 1
3672 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003673
wdenk6c59edc2004-05-03 20:45:30 +00003674Hit 'b':
3675 [q, b, e, ?] Set interval 1000000 us
3676 Enabling timer
3677Hit '?':
3678 [q, b, e, ?] ........
3679 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3680Hit '?':
3681 [q, b, e, ?] .
3682 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3683Hit '?':
3684 [q, b, e, ?] .
3685 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3686Hit '?':
3687 [q, b, e, ?] .
3688 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3689Hit 'e':
3690 [q, b, e, ?] ...Stopping timer
3691Hit 'q':
3692 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003693
wdenkc6097192002-11-03 00:24:07 +00003694
wdenk6c59edc2004-05-03 20:45:30 +00003695Minicom warning:
3696================
wdenkc6097192002-11-03 00:24:07 +00003697
wdenk6c59edc2004-05-03 20:45:30 +00003698Over time, many people have reported problems when trying to use the
3699"minicom" terminal emulation program for serial download. I (wd)
3700consider minicom to be broken, and recommend not to use it. Under
3701Unix, I recommend to use C-Kermit for general purpose use (and
3702especially for kermit binary protocol download ("loadb" command), and
3703use "cu" for S-Record download ("loads" command).
wdenkc6097192002-11-03 00:24:07 +00003704
wdenk6c59edc2004-05-03 20:45:30 +00003705Nevertheless, if you absolutely want to use it try adding this
3706configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00003707
wdenk6c59edc2004-05-03 20:45:30 +00003708 Name Program Name U/D FullScr IO-Red. Multi
3709 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3710 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00003711
wdenk8dba0502003-03-31 16:34:49 +00003712
wdenk6c59edc2004-05-03 20:45:30 +00003713NetBSD Notes:
3714=============
wdenkc6097192002-11-03 00:24:07 +00003715
wdenk6c59edc2004-05-03 20:45:30 +00003716Starting at version 0.9.2, U-Boot supports NetBSD both as host
3717(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00003718
wdenk6c59edc2004-05-03 20:45:30 +00003719Building requires a cross environment; it is known to work on
3720NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3721need gmake since the Makefiles are not compatible with BSD make).
3722Note that the cross-powerpc package does not install include files;
3723attempting to build U-Boot will fail because <machine/ansi.h> is
3724missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00003725
wdenk6c59edc2004-05-03 20:45:30 +00003726 # cd /usr/pkg/cross/powerpc-netbsd/include
3727 # mkdir powerpc
3728 # ln -s powerpc machine
3729 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3730 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00003731
wdenk6c59edc2004-05-03 20:45:30 +00003732Native builds *don't* work due to incompatibilities between native
3733and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003734
wdenk6c59edc2004-05-03 20:45:30 +00003735Booting assumes that (the first part of) the image booted is a
3736stage-2 loader which in turn loads and then invokes the kernel
3737proper. Loader sources will eventually appear in the NetBSD source
3738tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00003739meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003740
wdenkc6097192002-11-03 00:24:07 +00003741
wdenk6c59edc2004-05-03 20:45:30 +00003742Implementation Internals:
3743=========================
wdenkc6097192002-11-03 00:24:07 +00003744
wdenk6c59edc2004-05-03 20:45:30 +00003745The following is not intended to be a complete description of every
3746implementation detail. However, it should help to understand the
3747inner workings of U-Boot and make it easier to port it to custom
3748hardware.
wdenkc6097192002-11-03 00:24:07 +00003749
wdenkc6097192002-11-03 00:24:07 +00003750
wdenk6c59edc2004-05-03 20:45:30 +00003751Initial Stack, Global Data:
3752---------------------------
wdenkc6097192002-11-03 00:24:07 +00003753
wdenk6c59edc2004-05-03 20:45:30 +00003754The implementation of U-Boot is complicated by the fact that U-Boot
3755starts running out of ROM (flash memory), usually without access to
3756system RAM (because the memory controller is not initialized yet).
3757This means that we don't have writable Data or BSS segments, and BSS
3758is not initialized as zero. To be able to get a C environment working
3759at all, we have to allocate at least a minimal stack. Implementation
3760options for this are defined and restricted by the CPU used: Some CPU
3761models provide on-chip memory (like the IMMR area on MPC8xx and
3762MPC826x processors), on others (parts of) the data cache can be
3763locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003764
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003765 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003766 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00003767
wdenk6c59edc2004-05-03 20:45:30 +00003768 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3769 From: "Chris Hallinan" <clh@net1plus.com>
3770 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3771 ...
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk6c59edc2004-05-03 20:45:30 +00003773 Correct me if I'm wrong, folks, but the way I understand it
3774 is this: Using DCACHE as initial RAM for Stack, etc, does not
3775 require any physical RAM backing up the cache. The cleverness
3776 is that the cache is being used as a temporary supply of
3777 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003778 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00003779 can see how this works by studying the cache architecture and
3780 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk6c59edc2004-05-03 20:45:30 +00003782 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3783 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003784 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00003785 option should work for you. Using CS 4 should be fine if your
3786 board designers haven't used it for something that would
3787 cause you grief during the initial boot! It is frequently not
3788 used.
wdenkc6097192002-11-03 00:24:07 +00003789
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003790 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00003791 with your processor/board/system design. The default value
3792 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02003793 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00003794 than your SDRAM module. If you have a 64MB SDRAM module, set
3795 it above 400_0000. Just make sure your board has no resources
3796 that are supposed to respond to that address! That code in
3797 start.S has been around a while and should work as is when
3798 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00003799
wdenk6c59edc2004-05-03 20:45:30 +00003800 -Chris Hallinan
3801 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00003802
wdenk6c59edc2004-05-03 20:45:30 +00003803It is essential to remember this, since it has some impact on the C
3804code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00003805
wdenk6c59edc2004-05-03 20:45:30 +00003806* Initialized global data (data segment) is read-only. Do not attempt
3807 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00003808
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003809* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00003810 as zero data - BSS segment) at all - this is undefined, initiali-
3811 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00003812
wdenk6c59edc2004-05-03 20:45:30 +00003813* Stack space is very limited. Avoid big data buffers or things like
3814 that.
wdenk4a5c8a72003-03-06 00:02:04 +00003815
wdenk6c59edc2004-05-03 20:45:30 +00003816Having only the stack as writable memory limits means we cannot use
3817normal global data to share information beween the code. But it
3818turned out that the implementation of U-Boot can be greatly
3819simplified by making a global data structure (gd_t) available to all
3820functions. We could pass a pointer to this data as argument to _all_
3821functions, but this would bloat the code. Instead we use a feature of
3822the GCC compiler (Global Register Variables) to share the data: we
3823place a pointer (gd) to the global data into a register which we
3824reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk6c59edc2004-05-03 20:45:30 +00003826When choosing a register for such a purpose we are restricted by the
3827relevant (E)ABI specifications for the current architecture, and by
3828GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003829
wdenk6c59edc2004-05-03 20:45:30 +00003830For PowerPC, the following registers have specific use:
3831 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01003832 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00003833 R3-R4: parameter passing and return values
3834 R5-R10: parameter passing
3835 R13: small data area pointer
3836 R30: GOT pointer
3837 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003838
wdenk6c59edc2004-05-03 20:45:30 +00003839 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003840
Wolfgang Denk69c09642008-02-14 22:43:22 +01003841 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk6c59edc2004-05-03 20:45:30 +00003843 Note: on PPC, we could use a static initializer (since the
3844 address of the global data structure is known at compile time),
3845 but it turned out that reserving a register results in somewhat
3846 smaller code - although the code savings are not that big (on
3847 average for all boards 752 bytes for the whole U-Boot image,
3848 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003849
Mike Frysinger60f09302008-02-04 19:26:54 -05003850On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3851 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3852
3853 ==> U-Boot will use P5 to hold a pointer to the global data
3854
wdenk6c59edc2004-05-03 20:45:30 +00003855On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003856
wdenk6c59edc2004-05-03 20:45:30 +00003857 R0: function argument word/integer result
3858 R1-R3: function argument word
3859 R9: GOT pointer
3860 R10: stack limit (used only if stack checking if enabled)
3861 R11: argument (frame) pointer
3862 R12: temporary workspace
3863 R13: stack pointer
3864 R14: link register
3865 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003866
wdenk6c59edc2004-05-03 20:45:30 +00003867 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003868
Wolfgang Denk6405a152006-03-31 18:32:53 +02003869NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3870or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk6c59edc2004-05-03 20:45:30 +00003872Memory Management:
3873------------------
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk6c59edc2004-05-03 20:45:30 +00003875U-Boot runs in system state and uses physical addresses, i.e. the
3876MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003877
wdenk6c59edc2004-05-03 20:45:30 +00003878The available memory is mapped to fixed addresses using the memory
3879controller. In this process, a contiguous block is formed for each
3880memory type (Flash, SDRAM, SRAM), even when it consists of several
3881physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk6c59edc2004-05-03 20:45:30 +00003883U-Boot is installed in the first 128 kB of the first Flash bank (on
3884TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3885booting and sizing and initializing DRAM, the code relocates itself
3886to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003887memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00003888configuration setting]. Below that, a structure with global Board
3889Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003890
wdenk6c59edc2004-05-03 20:45:30 +00003891Additionally, some exception handler code is copied to the low 8 kB
3892of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003893
wdenk6c59edc2004-05-03 20:45:30 +00003894So a typical memory configuration with 16 MB of DRAM could look like
3895this:
wdenkc6097192002-11-03 00:24:07 +00003896
wdenk6c59edc2004-05-03 20:45:30 +00003897 0x0000 0000 Exception Vector code
3898 :
3899 0x0000 1FFF
3900 0x0000 2000 Free for Application Use
3901 :
3902 :
wdenkc6097192002-11-03 00:24:07 +00003903
wdenk6c59edc2004-05-03 20:45:30 +00003904 :
3905 :
3906 0x00FB FF20 Monitor Stack (Growing downward)
3907 0x00FB FFAC Board Info Data and permanent copy of global data
3908 0x00FC 0000 Malloc Arena
3909 :
3910 0x00FD FFFF
3911 0x00FE 0000 RAM Copy of Monitor Code
3912 ... eventually: LCD or video framebuffer
3913 ... eventually: pRAM (Protected RAM - unchanged by reset)
3914 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003915
wdenkc6097192002-11-03 00:24:07 +00003916
wdenk6c59edc2004-05-03 20:45:30 +00003917System Initialization:
3918----------------------
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk6c59edc2004-05-03 20:45:30 +00003920In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003921(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00003922configuration for CS0# this is a mirror of the onboard Flash memory.
3923To be able to re-map memory U-Boot then jumps to its link address.
3924To be able to implement the initialization code in C, a (small!)
3925initial stack is set up in the internal Dual Ported RAM (in case CPUs
3926which provide such a feature like MPC8xx or MPC8260), or in a locked
3927part of the data cache. After that, U-Boot initializes the CPU core,
3928the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003929
wdenk6c59edc2004-05-03 20:45:30 +00003930Next, all (potentially) available memory banks are mapped using a
3931preliminary mapping. For example, we put them on 512 MB boundaries
3932(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3933on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3934programmed for SDRAM access. Using the temporary configuration, a
3935simple memory test is run that determines the size of the SDRAM
3936banks.
wdenkc6097192002-11-03 00:24:07 +00003937
wdenk6c59edc2004-05-03 20:45:30 +00003938When there is more than one SDRAM bank, and the banks are of
3939different size, the largest is mapped first. For equal size, the first
3940bank (CS2#) is mapped first. The first mapping is always for address
39410x00000000, with any additional banks following immediately to create
3942contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk6c59edc2004-05-03 20:45:30 +00003944Then, the monitor installs itself at the upper end of the SDRAM area
3945and allocates memory for use by malloc() and for the global Board
3946Info data; also, the exception vector code is copied to the low RAM
3947pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003948
wdenk6c59edc2004-05-03 20:45:30 +00003949Only after this relocation will you have a "normal" C environment;
3950until that you are restricted in several ways, mostly because you are
3951running from ROM, and because the code will have to be relocated to a
3952new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003953
wdenkc6097192002-11-03 00:24:07 +00003954
wdenk6c59edc2004-05-03 20:45:30 +00003955U-Boot Porting Guide:
3956----------------------
wdenkc6097192002-11-03 00:24:07 +00003957
wdenk6c59edc2004-05-03 20:45:30 +00003958[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3959list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003960
wdenkc6097192002-11-03 00:24:07 +00003961
wdenk6c59edc2004-05-03 20:45:30 +00003962int main (int argc, char *argv[])
3963{
3964 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003965
wdenk6c59edc2004-05-03 20:45:30 +00003966 signal (SIGALRM, no_more_time);
3967 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003968
wdenk6c59edc2004-05-03 20:45:30 +00003969 if (available_money > available_manpower) {
3970 pay consultant to port U-Boot;
3971 return 0;
3972 }
wdenkc6097192002-11-03 00:24:07 +00003973
wdenk6c59edc2004-05-03 20:45:30 +00003974 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00003975
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01003976 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00003977
wdenk6c59edc2004-05-03 20:45:30 +00003978 if (clueless) {
3979 email ("Hi, I am new to U-Boot, how do I get started?");
3980 }
wdenkc6097192002-11-03 00:24:07 +00003981
wdenk6c59edc2004-05-03 20:45:30 +00003982 while (learning) {
3983 Read the README file in the top level directory;
3984 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3985 Read the source, Luke;
3986 }
wdenkc6097192002-11-03 00:24:07 +00003987
wdenk6c59edc2004-05-03 20:45:30 +00003988 if (available_money > toLocalCurrency ($2500)) {
3989 Buy a BDI2000;
3990 } else {
3991 Add a lot of aggravation and time;
3992 }
wdenkc6097192002-11-03 00:24:07 +00003993
wdenk6c59edc2004-05-03 20:45:30 +00003994 Create your own board support subdirectory;
wdenk34b613e2002-12-17 01:51:00 +00003995
wdenk6c59edc2004-05-03 20:45:30 +00003996 Create your own board config file;
wdenkc6097192002-11-03 00:24:07 +00003997
wdenk6c59edc2004-05-03 20:45:30 +00003998 while (!running) {
3999 do {
4000 Add / modify source code;
4001 } until (compiles);
4002 Debug;
4003 if (clueless)
4004 email ("Hi, I am having problems...");
wdenk634d2f72004-04-15 23:14:49 +00004005 }
wdenk6c59edc2004-05-03 20:45:30 +00004006 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk6c59edc2004-05-03 20:45:30 +00004008 return 0;
4009}
wdenkc6097192002-11-03 00:24:07 +00004010
wdenk6c59edc2004-05-03 20:45:30 +00004011void no_more_time (int sig)
4012{
4013 hire_a_guru();
4014}
wdenkc6097192002-11-03 00:24:07 +00004015
wdenkc6097192002-11-03 00:24:07 +00004016
wdenk6c59edc2004-05-03 20:45:30 +00004017Coding Standards:
4018-----------------
wdenkc6097192002-11-03 00:24:07 +00004019
wdenk6c59edc2004-05-03 20:45:30 +00004020All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02004021coding style; see the file "Documentation/CodingStyle" and the script
4022"scripts/Lindent" in your Linux kernel source directory. In sources
4023originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4024spaces before parameters to function calls) is actually used.
4025
4026Source files originating from a different project (for example the
4027MTD subsystem) are generally exempt from these guidelines and are not
4028reformated to ease subsequent migration to newer versions of those
4029sources.
wdenkc6097192002-11-03 00:24:07 +00004030
Detlev Zundelaa63d482006-09-01 15:39:02 +02004031Please note that U-Boot is implemented in C (and to some small parts in
4032Assembler); no C++ is used, so please do not use C++ style comments (//)
4033in your code.
wdenkad276f22004-01-04 16:28:35 +00004034
wdenk6c59edc2004-05-03 20:45:30 +00004035Please also stick to the following formatting rules:
4036- remove any trailing white space
4037- use TAB characters for indentation, not spaces
4038- make sure NOT to use DOS '\r\n' line feeds
4039- do not add more than 2 empty lines to source files
4040- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004041
wdenk6c59edc2004-05-03 20:45:30 +00004042Submissions which do not conform to the standards may be returned
4043with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004044
wdenkc6097192002-11-03 00:24:07 +00004045
wdenk6c59edc2004-05-03 20:45:30 +00004046Submitting Patches:
4047-------------------
wdenkc6097192002-11-03 00:24:07 +00004048
wdenk6c59edc2004-05-03 20:45:30 +00004049Since the number of patches for U-Boot is growing, we need to
4050establish some rules. Submissions which do not conform to these rules
4051may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004052
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004053Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004054
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004055Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4056see http://lists.denx.de/mailman/listinfo/u-boot
4057
wdenk6c59edc2004-05-03 20:45:30 +00004058When you send a patch, please include the following information with
4059it:
wdenkc6097192002-11-03 00:24:07 +00004060
wdenk6c59edc2004-05-03 20:45:30 +00004061* For bug fixes: a description of the bug and how your patch fixes
4062 this bug. Please try to include a way of demonstrating that the
4063 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004064
wdenk6c59edc2004-05-03 20:45:30 +00004065* For new features: a description of the feature and your
4066 implementation.
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk6c59edc2004-05-03 20:45:30 +00004068* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00004069
wdenk6c59edc2004-05-03 20:45:30 +00004070* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00004071
wdenk6c59edc2004-05-03 20:45:30 +00004072* When you add support for a new board, don't forget to add this
4073 board to the MAKEALL script, too.
wdenkc6097192002-11-03 00:24:07 +00004074
wdenk6c59edc2004-05-03 20:45:30 +00004075* If your patch adds new configuration options, don't forget to
4076 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004077
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004078* The patch itself. If you are using git (which is *strongly*
4079 recommended) you can easily generate the patch using the
4080 "git-format-patch". If you then use "git-send-email" to send it to
4081 the U-Boot mailing list, you will avoid most of the common problems
4082 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004083
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004084 If you cannot use git, use "diff -purN OLD NEW". If your version of
4085 diff does not support these options, then get the latest version of
4086 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004087
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004088 The current directory when running this command shall be the parent
4089 directory of the U-Boot source tree (i. e. please make sure that
4090 your patch includes sufficient directory information for the
4091 affected files).
4092
4093 We prefer patches as plain text. MIME attachments are discouraged,
4094 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004095
wdenk6c59edc2004-05-03 20:45:30 +00004096* If one logical set of modifications affects or creates several
4097 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004098
wdenk6c59edc2004-05-03 20:45:30 +00004099* Changesets that contain different, unrelated modifications shall be
4100 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004101
wdenkc6097192002-11-03 00:24:07 +00004102
wdenk6c59edc2004-05-03 20:45:30 +00004103Notes:
wdenkc6097192002-11-03 00:24:07 +00004104
wdenk6c59edc2004-05-03 20:45:30 +00004105* Before sending the patch, run the MAKEALL script on your patched
4106 source tree and make sure that no errors or warnings are reported
4107 for any of the boards.
4108
4109* Keep your modifications to the necessary minimum: A patch
4110 containing several unrelated changes or arbitrary reformats will be
4111 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004112
wdenk6c59edc2004-05-03 20:45:30 +00004113* If you modify existing code, make sure that your new code does not
4114 add to the memory footprint of the code ;-) Small is beautiful!
4115 When adding new features, these should compile conditionally only
4116 (using #ifdef), and the resulting code with the new feature
4117 disabled must not need more memory than the old code without your
4118 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004119
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01004120* Remember that there is a size limit of 100 kB per message on the
4121 u-boot mailing list. Bigger patches will be moderated. If they are
4122 reasonable and not too big, they will be acknowledged. But patches
4123 bigger than the size limit should be avoided.