blob: 2a553c274c372b014075cf67387dea964bd0722d [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002# (C) Copyright 2000 - 2008
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denkb240aef2008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschin08337f32008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000121
wdenk24ee89b2002-11-03 17:56:27 +0000122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
124
wdenkc6097192002-11-03 00:24:07 +0000125
wdenk7474aca2002-12-17 17:55:09 +0000126Versioning:
127===========
128
129U-Boot uses a 3 level version number containing a version, a
130sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
131sub-version "34", and patchlevel "4".
132
133The patchlevel is used to indicate certain stages of development
134between released versions, i. e. officially released versions of
135U-Boot will always have a patchlevel of "0".
136
137
wdenkc6097192002-11-03 00:24:07 +0000138Directory Hierarchy:
139====================
140
wdenkeb20ad32003-09-05 23:19:14 +0000141- board Board dependent files
142- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000143- cpu CPU specific files
wdenk337f5652004-10-28 00:09:35 +0000144 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenkd729d302004-02-27 00:07:27 +0000145 - arm720t Files specific to ARM 720 CPUs
146 - arm920t Files specific to ARM 920 CPUs
wdenk91fcc952005-04-06 13:52:31 +0000147 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk337f5652004-10-28 00:09:35 +0000148 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenkf8e9a232004-10-09 22:21:29 +0000149 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenkd729d302004-02-27 00:07:27 +0000150 - arm925t Files specific to ARM 925 CPUs
151 - arm926ejs Files specific to ARM 926 CPUs
wdenkf8062712005-01-09 23:16:25 +0000152 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk64702552006-10-24 14:27:35 +0200153 - at32ap Files specific to Atmel AVR32 AP CPUs
Mike Frysinger5d018ca2008-08-07 17:50:26 -0400154 - blackfin Files specific to Analog Devices Blackfin CPUs
wdenkd729d302004-02-27 00:07:27 +0000155 - i386 Files specific to i386 CPUs
156 - ixp Files specific to Intel XScale IXP CPUs
Daniel Hellstrom207e6952008-03-28 10:00:33 +0100157 - leon2 Files specific to Gaisler LEON2 SPARC CPU
Daniel Hellstromb552dbe2008-03-26 22:51:29 +0100158 - leon3 Files specific to Gaisler LEON3 SPARC CPU
wdenk337f5652004-10-28 00:09:35 +0000159 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
TsiChungLiew99b037a2008-01-14 17:43:33 -0600160 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
TsiChung Liewf6afe722007-06-18 13:50:13 -0500161 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
TsiChungLiewfc3ca3b62007-08-16 15:05:11 -0500162 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
TsiChungLiew8cb946d2008-01-15 14:15:46 -0600163 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
wdenkd729d302004-02-27 00:07:27 +0000164 - mips Files specific to MIPS CPUs
wdenk337f5652004-10-28 00:09:35 +0000165 - mpc5xx Files specific to Freescale MPC5xx CPUs
166 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
167 - mpc8xx Files specific to Freescale MPC8xx CPUs
168 - mpc8220 Files specific to Freescale MPC8220 CPUs
169 - mpc824x Files specific to Freescale MPC824x CPUs
170 - mpc8260 Files specific to Freescale MPC8260 CPUs
171 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenkd729d302004-02-27 00:07:27 +0000172 - nios Files specific to Altera NIOS CPUs
wdenkef3386f2004-10-10 21:27:30 +0000173 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0ee70772005-09-23 11:05:55 +0200174 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenkd729d302004-02-27 00:07:27 +0000175 - pxa Files specific to Intel XScale PXA CPUs
176 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
177 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000178- disk Code for disk drive partition handling
179- doc Documentation (don't expect too much)
wdenkeb20ad32003-09-05 23:19:14 +0000180- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000181- dtt Digital Thermometer and Thermostat drivers
182- examples Example code for standalone applications, etc.
183- include Header Files
wdenkd729d302004-02-27 00:07:27 +0000184- lib_arm Files generic to ARM architecture
Wolfgang Denk83c15852006-10-24 14:21:16 +0200185- lib_avr32 Files generic to AVR32 architecture
Mike Frysinger5d018ca2008-08-07 17:50:26 -0400186- lib_blackfin Files generic to Blackfin architecture
wdenkd729d302004-02-27 00:07:27 +0000187- lib_generic Files generic to all architectures
188- lib_i386 Files generic to i386 architecture
189- lib_m68k Files generic to m68k architecture
190- lib_mips Files generic to MIPS architecture
191- lib_nios Files generic to NIOS architecture
192- lib_ppc Files generic to PowerPC architecture
Daniel Hellstrom9d7c6b22008-03-28 09:47:00 +0100193- lib_sparc Files generic to SPARC architecture
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100194- libfdt Library files to support flattened device trees
wdenkc6097192002-11-03 00:24:07 +0000195- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000196- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000197- rtc Real Time Clock drivers
198- tools Tools to build S-Record or U-Boot images, etc.
199
wdenkc6097192002-11-03 00:24:07 +0000200Software Configuration:
201=======================
202
203Configuration is usually done using C preprocessor defines; the
204rationale behind that is to avoid dead code whenever possible.
205
206There are two classes of configuration variables:
207
208* Configuration _OPTIONS_:
209 These are selectable by the user and have names beginning with
210 "CONFIG_".
211
212* Configuration _SETTINGS_:
213 These depend on the hardware etc. and should not be meddled with if
214 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200215 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000216
217Later we will add a configuration tool - probably similar to or even
218identical to what's used for the Linux kernel. Right now, we have to
219do the configuration by hand, which means creating some symbolic
220links and editing some configuration files. We use the TQM8xxL boards
221as an example here.
222
223
224Selection of Processor Architecture and Board Type:
225---------------------------------------------------
226
227For all supported boards there are ready-to-use default
228configurations available; just type "make <board_name>_config".
229
230Example: For a TQM823L module type:
231
232 cd u-boot
233 make TQM823L_config
234
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200235For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000236e.g. "make cogent_mpc8xx_config". And also configure the cogent
237directory according to the instructions in cogent/README.
238
239
240Configuration Options:
241----------------------
242
243Configuration depends on the combination of board and CPU type; all
244such information is kept in a configuration file
245"include/configs/<board_name>.h".
246
247Example: For a TQM823L module, all configuration settings are in
248"include/configs/TQM823L.h".
249
250
wdenk1272e232002-11-10 22:06:23 +0000251Many of the options are named exactly as the corresponding Linux
252kernel configuration options. The intention is to make it easier to
253build a config tool - later.
254
255
wdenkc6097192002-11-03 00:24:07 +0000256The following options need to be configured:
257
Kim Phillips203fee32007-08-10 13:28:25 -0500258- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000259
Kim Phillips203fee32007-08-10 13:28:25 -0500260- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200261
262- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100263 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000264
265- CPU Module Type: (if CONFIG_COGENT is defined)
266 Define exactly one of
267 CONFIG_CMA286_60_OLD
268--- FIXME --- not tested yet:
269 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
270 CONFIG_CMA287_23, CONFIG_CMA287_50
271
272- Motherboard Type: (if CONFIG_COGENT is defined)
273 Define exactly one of
274 CONFIG_CMA101, CONFIG_CMA102
275
276- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
277 Define one or more of
278 CONFIG_CMA302
279
280- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
281 Define one or more of
282 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200283 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000284 a "rotator" |\-/|\-/
285
wdenk2bb11052003-07-17 23:16:40 +0000286- Board flavour: (if CONFIG_MPC8260ADS is defined)
287 CONFIG_ADSTYPE
288 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200289 CONFIG_SYS_8260ADS - original MPC8260ADS
290 CONFIG_SYS_8266ADS - MPC8266ADS
291 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
292 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2bb11052003-07-17 23:16:40 +0000293
wdenkc6097192002-11-03 00:24:07 +0000294- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000295 Define exactly one of
296 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000297
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200298- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000299 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
300 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000301 e.g. if there is no 32KHz
302 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000303 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
304 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000305
wdenk20bddb32004-09-28 17:59:53 +0000306- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200307 CONFIG_SYS_8xx_CPUCLK_MIN
308 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000309 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000310 See doc/README.MPC866
311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200312 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000313
wdenk544e9732004-02-06 23:19:44 +0000314 Define this to measure the actual CPU clock instead
315 of relying on the correctness of the configured
316 values. Mostly useful for board bringup to make sure
317 the PLL is locked at the intended frequency. Note
318 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200319 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000320
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
487- Interrupt driven serial port input:
488 CONFIG_SERIAL_SOFTWARE_FIFO
489
490 PPC405GP only.
491 Use an interrupt handler for receiving data on the
492 serial port. It also enables using hardware handshake
493 (RTS/CTS) and UART's built-in FIFO. Set the number of
494 bytes the interrupt driven input buffer should have.
495
wdenkf16b5162004-03-23 21:43:07 +0000496 Leave undefined to disable this feature, including
497 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000498
stroese3d24d6e2003-05-23 11:39:05 +0000499- Console UART Number:
500 CONFIG_UART1_CONSOLE
501
Wolfgang Denk0ee70772005-09-23 11:05:55 +0200502 AMCC PPC4xx only.
stroese3d24d6e2003-05-23 11:39:05 +0000503 If defined internal UART1 (and not UART0) is used
504 as default U-Boot console.
505
wdenkc6097192002-11-03 00:24:07 +0000506- Boot Delay: CONFIG_BOOTDELAY - in seconds
507 Delay before automatically booting the default image;
508 set to -1 to disable autoboot.
509
510 See doc/README.autoboot for these options that
511 work with CONFIG_BOOTDELAY. None are required.
512 CONFIG_BOOT_RETRY_TIME
513 CONFIG_BOOT_RETRY_MIN
514 CONFIG_AUTOBOOT_KEYED
515 CONFIG_AUTOBOOT_PROMPT
516 CONFIG_AUTOBOOT_DELAY_STR
517 CONFIG_AUTOBOOT_STOP_STR
518 CONFIG_AUTOBOOT_DELAY_STR2
519 CONFIG_AUTOBOOT_STOP_STR2
520 CONFIG_ZERO_BOOTDELAY_CHECK
521 CONFIG_RESET_TO_RETRY
522
523- Autoboot Command:
524 CONFIG_BOOTCOMMAND
525 Only needed when CONFIG_BOOTDELAY is enabled;
526 define a command string that is automatically executed
527 when no character is read on the console interface
528 within "Boot Delay" after reset.
529
530 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000531 This can be used to pass arguments to the bootm
532 command. The value of CONFIG_BOOTARGS goes into the
533 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000534
535 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000536 The value of these goes into the environment as
537 "ramboot" and "nfsboot" respectively, and can be used
538 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200539 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000540
541- Pre-Boot Commands:
542 CONFIG_PREBOOT
543
544 When this option is #defined, the existence of the
545 environment variable "preboot" will be checked
546 immediately before starting the CONFIG_BOOTDELAY
547 countdown and/or running the auto-boot command resp.
548 entering interactive mode.
549
550 This feature is especially useful when "preboot" is
551 automatically generated or modified. For an example
552 see the LWMON board specific code: here "preboot" is
553 modified when the user holds down a certain
554 combination of keys on the (special) keyboard when
555 booting the systems
556
557- Serial Download Echo Mode:
558 CONFIG_LOADS_ECHO
559 If defined to 1, all characters received during a
560 serial download (using the "loads" command) are
561 echoed back. This might be needed by some terminal
562 emulations (like "cu"), but may as well just take
563 time on others. This setting #define's the initial
564 value of the "loads_echo" environment variable.
565
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500566- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000567 CONFIG_KGDB_BAUDRATE
568 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200569 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000570
571- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500572 Monitor commands can be included or excluded
573 from the build by using the #include files
574 "config_cmd_all.h" and #undef'ing unwanted
575 commands, or using "config_cmd_default.h"
576 and augmenting with additional #define's
577 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000578
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500579 The default command configuration includes all commands
580 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000581
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500582 CONFIG_CMD_ASKENV * ask for env variable
583 CONFIG_CMD_AUTOSCRIPT Autoscript Support
584 CONFIG_CMD_BDI bdinfo
585 CONFIG_CMD_BEDBUG * Include BedBug Debugger
586 CONFIG_CMD_BMP * BMP support
587 CONFIG_CMD_BSP * Board specific commands
588 CONFIG_CMD_BOOTD bootd
589 CONFIG_CMD_CACHE * icache, dcache
590 CONFIG_CMD_CONSOLE coninfo
591 CONFIG_CMD_DATE * support for RTC, date/time...
592 CONFIG_CMD_DHCP * DHCP support
593 CONFIG_CMD_DIAG * Diagnostics
594 CONFIG_CMD_DOC * Disk-On-Chip Support
595 CONFIG_CMD_DTT * Digital Therm and Thermostat
596 CONFIG_CMD_ECHO echo arguments
597 CONFIG_CMD_EEPROM * EEPROM read/write support
598 CONFIG_CMD_ELF * bootelf, bootvx
599 CONFIG_CMD_ENV saveenv
600 CONFIG_CMD_FDC * Floppy Disk Support
601 CONFIG_CMD_FAT * FAT partition support
602 CONFIG_CMD_FDOS * Dos diskette Support
603 CONFIG_CMD_FLASH flinfo, erase, protect
604 CONFIG_CMD_FPGA FPGA device initialization support
605 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
606 CONFIG_CMD_I2C * I2C serial bus support
607 CONFIG_CMD_IDE * IDE harddisk support
608 CONFIG_CMD_IMI iminfo
609 CONFIG_CMD_IMLS List all found images
610 CONFIG_CMD_IMMAP * IMMR dump support
611 CONFIG_CMD_IRQ * irqinfo
612 CONFIG_CMD_ITEST Integer/string test of 2 values
613 CONFIG_CMD_JFFS2 * JFFS2 Support
614 CONFIG_CMD_KGDB * kgdb
615 CONFIG_CMD_LOADB loadb
616 CONFIG_CMD_LOADS loads
617 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
618 loop, loopw, mtest
619 CONFIG_CMD_MISC Misc functions like sleep etc
620 CONFIG_CMD_MMC * MMC memory mapped support
621 CONFIG_CMD_MII * MII utility commands
622 CONFIG_CMD_NAND * NAND support
623 CONFIG_CMD_NET bootp, tftpboot, rarpboot
624 CONFIG_CMD_PCI * pciinfo
625 CONFIG_CMD_PCMCIA * PCMCIA support
626 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
627 host
628 CONFIG_CMD_PORTIO * Port I/O
629 CONFIG_CMD_REGINFO * Register dump
630 CONFIG_CMD_RUN run command in env variable
631 CONFIG_CMD_SAVES * save S record dump
632 CONFIG_CMD_SCSI * SCSI Support
633 CONFIG_CMD_SDRAM * print SDRAM configuration information
634 (requires CONFIG_CMD_I2C)
635 CONFIG_CMD_SETGETDCR Support for DCR Register access
636 (4xx only)
637 CONFIG_CMD_SPI * SPI serial bus support
638 CONFIG_CMD_USB * USB support
639 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500640 CONFIG_CMD_CDP * Cisco Discover Protocol support
641 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000642
wdenkc6097192002-11-03 00:24:07 +0000643
644 EXAMPLE: If you want all functions except of network
645 support you can write:
646
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500647 #include "config_cmd_all.h"
648 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000649
Gerald Van Barend6abef42007-03-31 12:23:51 -0400650 Other Commands:
651 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000652
653 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500654 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000655 what you (and your U-Boot users) are doing. Data
656 cache cannot be enabled on systems like the 8xx or
657 8260 (where accesses to the IMMR region must be
658 uncached), and it cannot be disabled on all other
659 systems where we (mis-) use the data cache to hold an
660 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000661
662
663 XXX - this list needs to get updated!
664
665- Watchdog:
666 CONFIG_WATCHDOG
667 If this variable is defined, it enables watchdog
wdenkeb20ad32003-09-05 23:19:14 +0000668 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000669 code for a watchdog. For the 8xx and 8260 CPUs, the
670 SIU Watchdog feature is enabled in the SYPCR
671 register.
672
stroeseb9c17c52003-04-04 15:53:41 +0000673- U-Boot Version:
674 CONFIG_VERSION_VARIABLE
675 If this variable is defined, an environment variable
676 named "ver" is created by U-Boot showing the U-Boot
677 version as printed by the "version" command.
678 This variable is readonly.
679
wdenkc6097192002-11-03 00:24:07 +0000680- Real-Time Clock:
681
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500682 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000683 has to be selected, too. Define exactly one of the
684 following options:
685
686 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
687 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetskid4387492008-04-15 14:15:30 +0200688 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000689 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000690 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000691 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000692 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000693 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +0100694 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +0000695 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200696 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000697
wdenkb9bbd242003-06-30 16:24:52 +0000698 Note that if the RTC uses I2C, then the I2C interface
699 must also be configured. See I2C Support, below.
700
wdenkc6097192002-11-03 00:24:07 +0000701- Timestamp Support:
702
wdenk4a5c8a72003-03-06 00:02:04 +0000703 When CONFIG_TIMESTAMP is selected, the timestamp
704 (date and time) of an image is printed by image
705 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500706 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000707
708- Partition Support:
709 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubune6745592008-09-26 11:13:22 -0400710 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000711
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100712 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
713 CONFIG_CMD_SCSI) you must configure support for at
714 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000715
716- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000717 CONFIG_IDE_RESET_ROUTINE - this is defined in several
718 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000719
wdenk369d43d2004-03-14 14:09:05 +0000720 CONFIG_IDE_RESET - is this is defined, IDE Reset will
721 be performed by calling the function
722 ide_set_reset(int reset)
723 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000724
725- ATAPI Support:
726 CONFIG_ATAPI
727
728 Set this to enable ATAPI support.
729
wdenkf602aa02004-03-13 23:29:43 +0000730- LBA48 Support
731 CONFIG_LBA48
732
733 Set this to enable support for disks larger than 137GB
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200734 Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
wdenkf602aa02004-03-13 23:29:43 +0000735 Whithout these , LBA48 support uses 32bit variables and will 'only'
736 support disks up to 2.1TB.
737
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200738 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +0000739 When enabled, makes the IDE subsystem use 64bit sector addresses.
740 Default is 32bit.
741
wdenkc6097192002-11-03 00:24:07 +0000742- SCSI Support:
743 At the moment only there is only support for the
744 SYM53C8XX SCSI controller; define
745 CONFIG_SCSI_SYM53C8XX to enable it.
746
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200747 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
748 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
749 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000750 maximum numbers of LUNs, SCSI ID's and target
751 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200752 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000753
754- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000755 CONFIG_E1000
756 Support for Intel 8254x gigabit chips.
stroese94ef1cf2003-06-05 15:39:44 +0000757
Andre Schwarz68c2a302008-03-06 16:45:44 +0100758 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200759 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +0100760
wdenkc6097192002-11-03 00:24:07 +0000761 CONFIG_EEPRO100
762 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200763 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000764 write routine for first time initialisation.
765
766 CONFIG_TULIP
767 Support for Digital 2114x chips.
768 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
769 modem chip initialisation (KS8761/QS6611).
770
771 CONFIG_NATSEMI
772 Support for National dp83815 chips.
773
774 CONFIG_NS8382X
775 Support for National dp8382[01] gigabit chips.
776
wdenkaa603362003-05-12 21:50:16 +0000777- NETWORK Support (other):
778
779 CONFIG_DRIVER_LAN91C96
780 Support for SMSC's LAN91C96 chips.
781
782 CONFIG_LAN91C96_BASE
783 Define this to hold the physical address
784 of the LAN91C96's I/O space
785
786 CONFIG_LAN91C96_USE_32_BIT
787 Define this to enable 32 bit addressing
788
wdenk3c711762004-06-09 13:37:52 +0000789 CONFIG_DRIVER_SMC91111
790 Support for SMSC's LAN91C111 chip
791
792 CONFIG_SMC91111_BASE
793 Define this to hold the physical address
794 of the device (I/O space)
795
796 CONFIG_SMC_USE_32_BIT
797 Define this if data bus is 32 bits
798
799 CONFIG_SMC_USE_IOFUNCS
800 Define this to use i/o functions instead of macros
801 (some hardware wont work with macros)
802
Jens Gehrlein1dd48252008-05-05 14:06:11 +0200803 CONFIG_DRIVER_SMC911X
804 Support for SMSC's LAN911x and LAN921x chips
805
806 CONFIG_DRIVER_SMC911X_BASE
807 Define this to hold the physical address
808 of the device (I/O space)
809
810 CONFIG_DRIVER_SMC911X_32_BIT
811 Define this if data bus is 32 bits
812
813 CONFIG_DRIVER_SMC911X_16_BIT
814 Define this if data bus is 16 bits. If your processor
815 automatically converts one 32 bit word to two 16 bit
816 words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
817
wdenkc6097192002-11-03 00:24:07 +0000818- USB Support:
819 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +0000820 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000821 CONFIG_USB_UHCI to enable it.
822 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +0000823 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000824 storage devices.
825 Note:
826 Supported are USB Keyboards and USB Floppy drives
827 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +0000828 MPC5200 USB requires additional defines:
829 CONFIG_USB_CLOCK
830 for 528 MHz Clock: 0x0001bbbb
831 CONFIG_USB_CONFIG
832 for differential drivers: 0x00001000
833 for single ended drivers: 0x00005000
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200834 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +0200835 May be defined to allow interrupt polling
836 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +0000837
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200838- USB Device:
839 Define the below if you wish to use the USB console.
840 Once firmware is rebuilt from a serial console issue the
841 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200842 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200843 it has found a new device. The environment variable usbtty
844 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +0200845 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200846 Common Device Class Abstract Control Model serial device.
847 If you select usbtty = gserial you should be able to enumerate
848 a Linux host by
849 # modprobe usbserial vendor=0xVendorID product=0xProductID
850 else if using cdc_acm, simply setting the environment
851 variable usbtty to be cdc_acm should suffice. The following
852 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200853
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200854 CONFIG_USB_DEVICE
855 Define this to build a UDC device
856
857 CONFIG_USB_TTY
858 Define this to have a tty type of device available to
859 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +0200860
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200861 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200862 Define this if you want stdin, stdout &/or stderr to
863 be set to usbtty.
864
865 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200866 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200867 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200868 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +0200869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200870 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200871 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200872 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200873
Wolfgang Denke2601822006-06-14 18:14:56 +0200874 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200875 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200876 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200877 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
878 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
879 should pretend to be a Linux device to it's target host.
880
881 CONFIG_USBD_MANUFACTURER
882 Define this string as the name of your company for
883 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +0200884
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200885 CONFIG_USBD_PRODUCT_NAME
886 Define this string as the name of your product
887 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +0000888
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200889 CONFIG_USBD_VENDORID
890 Define this as your assigned Vendor ID from the USB
891 Implementors Forum. This *must* be a genuine Vendor ID
892 to avoid polluting the USB namespace.
893 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200894
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200895 CONFIG_USBD_PRODUCTID
896 Define this as the unique Product ID
897 for your device
898 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200899
wdenkc6097192002-11-03 00:24:07 +0000900
wdenk7a428cc2003-06-15 22:40:42 +0000901- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +0000902 The MMC controller on the Intel PXA is supported. To
903 enable this define CONFIG_MMC. The MMC can be
904 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +0000905 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500906 enabled with CONFIG_CMD_MMC. The MMC driver also works with
907 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +0000908
wdenkda04a8b2004-08-02 23:22:59 +0000909- Journaling Flash filesystem support:
910 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
911 CONFIG_JFFS2_NAND_DEV
912 Define these for a default partition on a NAND device
913
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200914 CONFIG_SYS_JFFS2_FIRST_SECTOR,
915 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +0000916 Define these for a default partition on a NOR device
917
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200918 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +0000919 Define this to create an own partition. You have to provide a
920 function struct part_info* jffs2_part_info(int part_num)
921
922 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200923 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +0000924 to disable the command chpart. This is the default when you
925 have not defined a custom partition
926
wdenkc6097192002-11-03 00:24:07 +0000927- Keyboard Support:
928 CONFIG_ISA_KEYBOARD
929
930 Define this to enable standard (PC-Style) keyboard
931 support
932
933 CONFIG_I8042_KBD
934 Standard PC keyboard driver with US (is default) and
935 GERMAN key layout (switch via environment 'keymap=de') support.
936 Export function i8042_kbd_init, i8042_tstc and i8042_getc
937 for cfb_console. Supports cursor blinking.
938
939- Video support:
940 CONFIG_VIDEO
941
942 Define this to enable video support (for output to
943 video).
944
945 CONFIG_VIDEO_CT69000
946
947 Enable Chips & Technologies 69000 Video chip
948
949 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +0000950 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +0000951 video output is selected via environment 'videoout'
952 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
953 assumed.
wdenkc6097192002-11-03 00:24:07 +0000954
wdenkd3602132004-03-25 15:14:43 +0000955 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200956 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +0000957 are possible:
958 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +0000959 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +0000960
961 Colors 640x480 800x600 1024x768 1152x864 1280x1024
962 -------------+---------------------------------------------
963 8 bits | 0x301* 0x303 0x305 0x161 0x307
964 15 bits | 0x310 0x313 0x316 0x162 0x319
965 16 bits | 0x311 0x314 0x317 0x163 0x31A
966 24 bits | 0x312 0x315 0x318 ? 0x31B
967 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000968 (i.e. setenv videomode 317; saveenv; reset;)
969
wdenkd3602132004-03-25 15:14:43 +0000970 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +0100971 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +0000972
973
stroeseb9c17c52003-04-04 15:53:41 +0000974 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +0000975 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +0000976 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
977 or CONFIG_VIDEO_SED13806_16BPP
978
wdenk4e112c12003-06-03 23:54:09 +0000979- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +0000980 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +0000981
wdenk57b2d802003-06-27 21:31:46 +0000982 Define this to enable a custom keyboard support.
983 This simply calls drv_keyboard_init() which must be
984 defined in your board-specific files.
985 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +0000986
wdenkc6097192002-11-03 00:24:07 +0000987- LCD Support: CONFIG_LCD
988
989 Define this to enable LCD support (for output to LCD
990 display); also select one of the supported displays
991 by defining one of these:
992
Stelian Popf6f86652008-05-09 21:57:18 +0200993 CONFIG_ATMEL_LCD:
994
995 HITACHI TX09D70VM1CCA, 3.5", 240x320.
996
wdenkc0d54ae2003-11-25 16:55:19 +0000997 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000998
wdenkc0d54ae2003-11-25 16:55:19 +0000999 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001000
wdenkc0d54ae2003-11-25 16:55:19 +00001001 CONFIG_NEC_NL6448BC20
1002
1003 NEC NL6448BC20-08. 6.5", 640x480.
1004 Active, color, single scan.
1005
1006 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001007
wdenkc0d54ae2003-11-25 16:55:19 +00001008 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001009 Active, color, single scan.
1010
1011 CONFIG_SHARP_16x9
1012
1013 Sharp 320x240. Active, color, single scan.
1014 It isn't 16x9, and I am not sure what it is.
1015
1016 CONFIG_SHARP_LQ64D341
1017
1018 Sharp LQ64D341 display, 640x480.
1019 Active, color, single scan.
1020
1021 CONFIG_HLD1045
1022
1023 HLD1045 display, 640x480.
1024 Active, color, single scan.
1025
1026 CONFIG_OPTREX_BW
1027
1028 Optrex CBL50840-2 NF-FW 99 22 M5
1029 or
1030 Hitachi LMG6912RPFC-00T
1031 or
1032 Hitachi SP14Q002
1033
1034 320x240. Black & white.
1035
1036 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001037 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001038
wdenkeb20ad32003-09-05 23:19:14 +00001039- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001040
wdenk57b2d802003-06-27 21:31:46 +00001041 If this option is set, the environment is checked for
1042 a variable "splashimage". If found, the usual display
1043 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001044 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001045 specified in "splashimage" is loaded instead. The
1046 console is redirected to the "nulldev", too. This
1047 allows for a "silent" boot where a splash screen is
1048 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001049
Stefan Roesed9d97742005-09-22 09:04:17 +02001050- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1051
1052 If this option is set, additionally to standard BMP
1053 images, gzipped BMP images can be displayed via the
1054 splashscreen support or the bmp command.
1055
wdenk710e3502003-08-29 20:57:53 +00001056- Compression support:
1057 CONFIG_BZIP2
1058
1059 If this option is set, support for bzip2 compressed
1060 images is included. If not, only uncompressed and gzip
1061 compressed images are supported.
1062
wdenk9c53f402003-10-15 23:53:47 +00001063 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001064 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001065 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001066
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001067 CONFIG_LZMA
1068
1069 If this option is set, support for lzma compressed
1070 images is included.
1071
1072 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1073 requires an amount of dynamic memory that is given by the
1074 formula:
1075
1076 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1077
1078 Where lc and lp stand for, respectively, Literal context bits
1079 and Literal pos bits.
1080
1081 This value is upper-bounded by 14MB in the worst case. Anyway,
1082 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1083 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1084 a very small buffer.
1085
1086 Use the lzmainfo tool to determinate the lc and lp values and
1087 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001088 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001089
wdenk0e2bd9c2004-06-06 21:51:03 +00001090- MII/PHY support:
1091 CONFIG_PHY_ADDR
1092
1093 The address of PHY on MII bus.
1094
1095 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1096
1097 The clock frequency of the MII bus
1098
1099 CONFIG_PHY_GIGE
1100
1101 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001102 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001103
1104 CONFIG_PHY_RESET_DELAY
1105
1106 Some PHY like Intel LXT971A need extra delay after
1107 reset before any MII register access is possible.
1108 For such PHY, set this option to the usec delay
1109 required. (minimum 300usec for LXT971A)
1110
1111 CONFIG_PHY_CMD_DELAY (ppc4xx)
1112
1113 Some PHY like Intel LXT971A need extra delay after
1114 command issued before MII status register can be read
1115
wdenkc6097192002-11-03 00:24:07 +00001116- Ethernet address:
1117 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001118 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001119 CONFIG_ETH2ADDR
1120 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001121 CONFIG_ETH4ADDR
1122 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001123
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001124 Define a default value for Ethernet address to use
1125 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001126 is not determined automatically.
1127
1128- IP address:
1129 CONFIG_IPADDR
1130
1131 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001132 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001133 determined through e.g. bootp.
1134
1135- Server IP address:
1136 CONFIG_SERVERIP
1137
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001138 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001139 server to contact when using the "tftboot" command.
1140
David Updegraff7280da72007-06-11 10:41:07 -05001141- Multicast TFTP Mode:
1142 CONFIG_MCAST_TFTP
1143
1144 Defines whether you want to support multicast TFTP as per
1145 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001146 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001147 driver in use must provide a function: mcast() to join/leave a
1148 multicast group.
1149
1150 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001151- BOOTP Recovery Mode:
1152 CONFIG_BOOTP_RANDOM_DELAY
1153
1154 If you have many targets in a network that try to
1155 boot using BOOTP, you may want to avoid that all
1156 systems send out BOOTP requests at precisely the same
1157 moment (which would happen for instance at recovery
1158 from a power failure, when all systems will try to
1159 boot, thus flooding the BOOTP server. Defining
1160 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1161 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001162 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001163
1164 1st BOOTP request: delay 0 ... 1 sec
1165 2nd BOOTP request: delay 0 ... 2 sec
1166 3rd BOOTP request: delay 0 ... 4 sec
1167 4th and following
1168 BOOTP requests: delay 0 ... 8 sec
1169
stroesee0aadfb2003-08-28 14:17:32 +00001170- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001171 You can fine tune the DHCP functionality by defining
1172 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001173
Jon Loeliger5336a762007-07-09 22:08:34 -05001174 CONFIG_BOOTP_SUBNETMASK
1175 CONFIG_BOOTP_GATEWAY
1176 CONFIG_BOOTP_HOSTNAME
1177 CONFIG_BOOTP_NISDOMAIN
1178 CONFIG_BOOTP_BOOTPATH
1179 CONFIG_BOOTP_BOOTFILESIZE
1180 CONFIG_BOOTP_DNS
1181 CONFIG_BOOTP_DNS2
1182 CONFIG_BOOTP_SEND_HOSTNAME
1183 CONFIG_BOOTP_NTPSERVER
1184 CONFIG_BOOTP_TIMEOFFSET
1185 CONFIG_BOOTP_VENDOREX
stroesee0aadfb2003-08-28 14:17:32 +00001186
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001187 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1188 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001189
1190 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1191 serverip from a DHCP server, it is possible that more
1192 than one DNS serverip is offered to the client.
1193 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1194 serverip will be stored in the additional environment
1195 variable "dnsip2". The first DNS serverip is always
1196 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001197 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001198
1199 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1200 to do a dynamic update of a DNS server. To do this, they
1201 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001202 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001203 of the "hostname" environment variable is passed as
1204 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001205
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001206 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1207
1208 A 32bit value in microseconds for a delay between
1209 receiving a "DHCP Offer" and sending the "DHCP Request".
1210 This fixes a problem with certain DHCP servers that don't
1211 respond 100% of the time to a "DHCP request". E.g. On an
1212 AT91RM9200 processor running at 180MHz, this delay needed
1213 to be *at least* 15,000 usec before a Windows Server 2003
1214 DHCP server would reply 100% of the time. I recommend at
1215 least 50,000 usec to be safe. The alternative is to hope
1216 that one of the retries will be successful but note that
1217 the DHCP timeout and retry process takes a longer than
1218 this delay.
1219
wdenk145d2c12004-04-15 21:48:45 +00001220 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001221 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001222
1223 The device id used in CDP trigger frames.
1224
1225 CONFIG_CDP_DEVICE_ID_PREFIX
1226
1227 A two character string which is prefixed to the MAC address
1228 of the device.
1229
1230 CONFIG_CDP_PORT_ID
1231
1232 A printf format string which contains the ascii name of
1233 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001234 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001235
1236 CONFIG_CDP_CAPABILITIES
1237
1238 A 32bit integer which indicates the device capabilities;
1239 0x00000010 for a normal host which does not forwards.
1240
1241 CONFIG_CDP_VERSION
1242
1243 An ascii string containing the version of the software.
1244
1245 CONFIG_CDP_PLATFORM
1246
1247 An ascii string containing the name of the platform.
1248
1249 CONFIG_CDP_TRIGGER
1250
1251 A 32bit integer sent on the trigger.
1252
1253 CONFIG_CDP_POWER_CONSUMPTION
1254
1255 A 16bit integer containing the power consumption of the
1256 device in .1 of milliwatts.
1257
1258 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1259
1260 A byte containing the id of the VLAN.
1261
wdenkc6097192002-11-03 00:24:07 +00001262- Status LED: CONFIG_STATUS_LED
1263
1264 Several configurations allow to display the current
1265 status using a LED. For instance, the LED will blink
1266 fast while running U-Boot code, stop blinking as
1267 soon as a reply to a BOOTP request was received, and
1268 start blinking slow once the Linux kernel is running
1269 (supported by a status LED driver in the Linux
1270 kernel). Defining CONFIG_STATUS_LED enables this
1271 feature in U-Boot.
1272
1273- CAN Support: CONFIG_CAN_DRIVER
1274
1275 Defining CONFIG_CAN_DRIVER enables CAN driver support
1276 on those systems that support this (optional)
1277 feature, like the TQM8xxL modules.
1278
1279- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1280
wdenkb9bbd242003-06-30 16:24:52 +00001281 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001282 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001283 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001284
wdenk21136db2003-07-16 21:53:01 +00001285 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001286 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001287 CONFIG_COMMANDS) and communicate with i2c based realtime
1288 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001289 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001290
Ben Warren45657152006-09-07 16:50:54 -04001291 CONFIG_I2C_CMD_TREE is a recommended option that places
1292 all I2C commands under a single 'i2c' root command. The
1293 older 'imm', 'imd', 'iprobe' etc. commands are considered
1294 deprecated and may disappear in the future.
1295
1296 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001297
wdenk21136db2003-07-16 21:53:01 +00001298 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001299 bit-banging) driver instead of CPM or similar hardware
1300 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001301
wdenk21136db2003-07-16 21:53:01 +00001302 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001303 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001304
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001305 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001306 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001307 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001308 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001309
wdenkb9bbd242003-06-30 16:24:52 +00001310 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001311 sets the CPU up as a master node and so its address should
wdenkb9bbd242003-06-30 16:24:52 +00001312 therefore be cleared to 0 (See, eg, MPC823e User's Manual
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001313 p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001314
wdenk21136db2003-07-16 21:53:01 +00001315 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001316
wdenkb9bbd242003-06-30 16:24:52 +00001317 If you use the software i2c interface (CONFIG_SOFT_I2C)
1318 then the following macros need to be defined (examples are
1319 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001320
1321 I2C_INIT
1322
wdenkb9bbd242003-06-30 16:24:52 +00001323 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001324 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001325
wdenk544e9732004-02-06 23:19:44 +00001326 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001327
wdenkc6097192002-11-03 00:24:07 +00001328 I2C_PORT
1329
wdenk4a5c8a72003-03-06 00:02:04 +00001330 (Only for MPC8260 CPU). The I/O port to use (the code
1331 assumes both bits are on the same port). Valid values
1332 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001333
1334 I2C_ACTIVE
1335
1336 The code necessary to make the I2C data line active
1337 (driven). If the data line is open collector, this
1338 define can be null.
1339
wdenkb9bbd242003-06-30 16:24:52 +00001340 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1341
wdenkc6097192002-11-03 00:24:07 +00001342 I2C_TRISTATE
1343
1344 The code necessary to make the I2C data line tri-stated
1345 (inactive). If the data line is open collector, this
1346 define can be null.
1347
wdenkb9bbd242003-06-30 16:24:52 +00001348 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1349
wdenkc6097192002-11-03 00:24:07 +00001350 I2C_READ
1351
1352 Code that returns TRUE if the I2C data line is high,
1353 FALSE if it is low.
1354
wdenkb9bbd242003-06-30 16:24:52 +00001355 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1356
wdenkc6097192002-11-03 00:24:07 +00001357 I2C_SDA(bit)
1358
1359 If <bit> is TRUE, sets the I2C data line high. If it
1360 is FALSE, it clears it (low).
1361
wdenkb9bbd242003-06-30 16:24:52 +00001362 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001363 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001364 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001365
wdenkc6097192002-11-03 00:24:07 +00001366 I2C_SCL(bit)
1367
1368 If <bit> is TRUE, sets the I2C clock line high. If it
1369 is FALSE, it clears it (low).
1370
wdenkb9bbd242003-06-30 16:24:52 +00001371 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001372 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001373 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001374
wdenkc6097192002-11-03 00:24:07 +00001375 I2C_DELAY
1376
1377 This delay is invoked four times per clock cycle so this
1378 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001379 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001380 like:
1381
wdenkb9bbd242003-06-30 16:24:52 +00001382 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001383
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001384 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00001385
wdenk57b2d802003-06-27 21:31:46 +00001386 When a board is reset during an i2c bus transfer
1387 chips might think that the current transfer is still
1388 in progress. On some boards it is possible to access
1389 the i2c SCLK line directly, either by using the
1390 processor pin as a GPIO or by having a second pin
1391 connected to the bus. If this option is defined a
1392 custom i2c_init_board() routine in boards/xxx/board.c
1393 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001394
wdenk0e2bd9c2004-06-06 21:51:03 +00001395 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1396
1397 This option enables configuration of bi_iic_fast[] flags
1398 in u-boot bd_info structure based on u-boot environment
1399 variable "i2cfast". (see also i2cfast)
1400
Ben Warren45657152006-09-07 16:50:54 -04001401 CONFIG_I2C_MULTI_BUS
1402
1403 This option allows the use of multiple I2C buses, each of which
1404 must have a controller. At any point in time, only one bus is
1405 active. To switch to a different bus, use the 'i2c dev' command.
1406 Note that bus numbering is zero-based.
1407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001408 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04001409
1410 This option specifies a list of I2C devices that will be skipped
1411 when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1412 command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001413 pairs. Otherwise, specify a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04001414
1415 e.g.
1416 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001417 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04001418
1419 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1420
1421 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001422 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04001423
1424 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1425
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001426 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06001427
1428 If defined, then this indicates the I2C bus number for DDR SPD.
1429 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1430
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001431 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001432
1433 If defined, then this indicates the I2C bus number for the RTC.
1434 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1435
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001436 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01001437
1438 If defined, then this indicates the I2C bus number for the DTT.
1439 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1440
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001441 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07001442
1443 If defined, specifies the I2C address of the DTT device.
1444 If not defined, then U-Boot uses predefined value for
1445 specified DTT device.
1446
Timur Tabiab347542006-11-03 19:15:00 -06001447 CONFIG_FSL_I2C
1448
1449 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01001450 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06001451
Heiko Schocher6ee861b2008-10-15 09:39:47 +02001452 CONFIG_I2C_MUX
1453
1454 Define this option if you have I2C devices reached over 1 .. n
1455 I2C Muxes like the pca9544a. This option addes a new I2C
1456 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1457 new I2C Bus to the existing I2C Busses. If you select the
1458 new Bus with "i2c dev", u-bbot sends first the commandos for
1459 the muxes to activate this new "bus".
1460
1461 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1462 feature!
1463
1464 Example:
1465 Adding a new I2C Bus reached over 2 pca9544a muxes
1466 The First mux with address 70 and channel 6
1467 The Second mux with address 71 and channel 4
1468
1469 => i2c bus pca9544a:70:6:pca9544a:71:4
1470
1471 Use the "i2c bus" command without parameter, to get a list
1472 of I2C Busses with muxes:
1473
1474 => i2c bus
1475 Busses reached over muxes:
1476 Bus ID: 2
1477 reached over Mux(es):
1478 pca9544a@70 ch: 4
1479 Bus ID: 3
1480 reached over Mux(es):
1481 pca9544a@70 ch: 6
1482 pca9544a@71 ch: 4
1483 =>
1484
1485 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1486 u-boot sends First the Commando to the mux@70 to enable
1487 channel 6, and then the Commando to the mux@71 to enable
1488 the channel 4.
1489
1490 After that, you can use the "normal" i2c commands as
1491 usual, to communicate with your I2C devices behind
1492 the 2 muxes.
1493
1494 This option is actually implemented for the bitbanging
1495 algorithm in common/soft_i2c.c and for the Hardware I2C
1496 Bus on the MPC8260. But it should be not so difficult
1497 to add this option to other architectures.
1498
Timur Tabiab347542006-11-03 19:15:00 -06001499
wdenkc6097192002-11-03 00:24:07 +00001500- SPI Support: CONFIG_SPI
1501
1502 Enables SPI driver (so far only tested with
1503 SPI EEPROM, also an instance works with Crystal A/D and
1504 D/As on the SACSng board)
1505
1506 CONFIG_SPI_X
1507
1508 Enables extended (16-bit) SPI EEPROM addressing.
1509 (symmetrical to CONFIG_I2C_X)
1510
1511 CONFIG_SOFT_SPI
1512
wdenk4a5c8a72003-03-06 00:02:04 +00001513 Enables a software (bit-bang) SPI driver rather than
1514 using hardware support. This is a general purpose
1515 driver that only requires three general I/O port pins
1516 (two outputs, one input) to function. If this is
1517 defined, the board configuration must define several
1518 SPI configuration items (port pins to use, etc). For
1519 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001520
Ben Warren7efe9272008-01-16 22:37:35 -05001521 CONFIG_HARD_SPI
1522
1523 Enables a hardware SPI driver for general-purpose reads
1524 and writes. As with CONFIG_SOFT_SPI, the board configuration
1525 must define a list of chip-select function pointers.
1526 Currently supported on some MPC8xxx processors. For an
1527 example, see include/configs/mpc8349emds.h.
1528
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02001529 CONFIG_MXC_SPI
1530
1531 Enables the driver for the SPI controllers on i.MX and MXC
1532 SoCs. Currently only i.MX31 is supported.
1533
Matthias Fuchsa4400872007-12-27 17:12:34 +01001534- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001535
Matthias Fuchsa4400872007-12-27 17:12:34 +01001536 Enables FPGA subsystem.
1537
1538 CONFIG_FPGA_<vendor>
1539
1540 Enables support for specific chip vendors.
1541 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00001542
Matthias Fuchsa4400872007-12-27 17:12:34 +01001543 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00001544
Matthias Fuchsa4400872007-12-27 17:12:34 +01001545 Enables support for FPGA family.
1546 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1547
1548 CONFIG_FPGA_COUNT
1549
1550 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001551
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001552 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001553
wdenk57b2d802003-06-27 21:31:46 +00001554 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001555
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001556 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001557
wdenk4a5c8a72003-03-06 00:02:04 +00001558 Enable checks on FPGA configuration interface busy
1559 status by the configuration function. This option
1560 will require a board or device specific function to
1561 be written.
wdenkc6097192002-11-03 00:24:07 +00001562
1563 CONFIG_FPGA_DELAY
1564
1565 If defined, a function that provides delays in the FPGA
1566 configuration driver.
1567
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001568 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001569 Allow Control-C to interrupt FPGA configuration
1570
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001571 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001572
wdenk4a5c8a72003-03-06 00:02:04 +00001573 Check for configuration errors during FPGA bitfile
1574 loading. For example, abort during Virtex II
1575 configuration if the INIT_B line goes low (which
1576 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001577
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001578 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001579
wdenk4a5c8a72003-03-06 00:02:04 +00001580 Maximum time to wait for the INIT_B line to deassert
1581 after PROB_B has been deasserted during a Virtex II
1582 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001583 ms.
wdenkc6097192002-11-03 00:24:07 +00001584
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001585 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001586
wdenk4a5c8a72003-03-06 00:02:04 +00001587 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001588 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001589
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001590 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001591
wdenk4a5c8a72003-03-06 00:02:04 +00001592 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001593 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001594
1595- Configuration Management:
1596 CONFIG_IDENT_STRING
1597
wdenk4a5c8a72003-03-06 00:02:04 +00001598 If defined, this string will be added to the U-Boot
1599 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001600
1601- Vendor Parameter Protection:
1602
wdenk4a5c8a72003-03-06 00:02:04 +00001603 U-Boot considers the values of the environment
1604 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001605 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001606 are set once by the board vendor / manufacturer, and
1607 protects these variables from casual modification by
1608 the user. Once set, these variables are read-only,
1609 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001610 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001611
1612 If CONFIG_ENV_OVERWRITE is #defined in your config
1613 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001614 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001615 these parameters.
1616
1617 Alternatively, if you #define _both_ CONFIG_ETHADDR
1618 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001619 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001620 which can be changed exactly ONCE by the user. [The
1621 serial# is unaffected by this, i. e. it remains
1622 read-only.]
1623
1624- Protected RAM:
1625 CONFIG_PRAM
1626
1627 Define this variable to enable the reservation of
1628 "protected RAM", i. e. RAM which is not overwritten
1629 by U-Boot. Define CONFIG_PRAM to hold the number of
1630 kB you want to reserve for pRAM. You can overwrite
1631 this default value by defining an environment
1632 variable "pram" to the number of kB you want to
1633 reserve. Note that the board info structure will
1634 still show the full amount of RAM. If pRAM is
1635 reserved, a new environment variable "mem" will
1636 automatically be defined to hold the amount of
1637 remaining RAM in a form that can be passed as boot
1638 argument to Linux, for instance like that:
1639
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001640 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001641 saveenv
1642
1643 This way you can tell Linux not to use this memory,
1644 either, which results in a memory region that will
1645 not be affected by reboots.
1646
1647 *WARNING* If your board configuration uses automatic
1648 detection of the RAM size, you must make sure that
1649 this memory test is non-destructive. So far, the
1650 following board configurations are known to be
1651 "pRAM-clean":
1652
1653 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1654 HERMES, IP860, RPXlite, LWMON, LANTEC,
1655 PCU_E, FLAGADM, TQM8260
1656
1657- Error Recovery:
1658 CONFIG_PANIC_HANG
1659
1660 Define this variable to stop the system in case of a
1661 fatal error, so that you have to reset it manually.
1662 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001663 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001664 automatically as fast as possible, but it may be
1665 useful during development since you can try to debug
1666 the conditions that lead to the situation.
1667
1668 CONFIG_NET_RETRY_COUNT
1669
wdenk4a5c8a72003-03-06 00:02:04 +00001670 This variable defines the number of retries for
1671 network operations like ARP, RARP, TFTP, or BOOTP
1672 before giving up the operation. If not defined, a
1673 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001674
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02001675 CONFIG_ARP_TIMEOUT
1676
1677 Timeout waiting for an ARP reply in milliseconds.
1678
wdenkc6097192002-11-03 00:24:07 +00001679- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001680 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00001681
1682 Enable auto completion of commands using TAB.
1683
Wolfgang Denk018147d2006-11-27 15:32:42 +01001684 Note that this feature has NOT been implemented yet
1685 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001686
1687
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001688 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001689
1690 Define this variable to enable the "hush" shell (from
1691 Busybox) as command line interpreter, thus enabling
1692 powerful command line syntax like
1693 if...then...else...fi conditionals or `&&' and '||'
1694 constructs ("shell scripts").
1695
1696 If undefined, you get the old, much simpler behaviour
1697 with a somewhat smaller memory footprint.
1698
1699
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001700 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001701
1702 This defines the secondary prompt string, which is
1703 printed when the command interpreter needs more input
1704 to complete a command. Usually "> ".
1705
1706 Note:
1707
wdenk57b2d802003-06-27 21:31:46 +00001708 In the current implementation, the local variables
1709 space and global environment variables space are
1710 separated. Local variables are those you define by
1711 simply typing `name=value'. To access a local
1712 variable later on, you have write `$name' or
1713 `${name}'; to execute the contents of a variable
1714 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001715
wdenk4a5c8a72003-03-06 00:02:04 +00001716 Global environment variables are those you use
1717 setenv/printenv to work with. To run a command stored
1718 in such a variable, you need to use the run command,
1719 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001720
1721 To store commands and special characters in a
1722 variable, please use double quotation marks
1723 surrounding the whole text of the variable, instead
1724 of the backslashes before semicolons and special
1725 symbols.
1726
Wolfgang Denk2039a072006-07-21 11:35:21 +02001727- Commandline Editing and History:
1728 CONFIG_CMDLINE_EDITING
1729
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001730 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02001731 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02001732
wdenkc0aa5c52003-12-06 19:49:23 +00001733- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001734 CONFIG_EXTRA_ENV_SETTINGS
1735
wdenk4a5c8a72003-03-06 00:02:04 +00001736 Define this to contain any number of null terminated
1737 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00001738 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00001739
wdenk4a5c8a72003-03-06 00:02:04 +00001740 For example, place something like this in your
1741 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001742
1743 #define CONFIG_EXTRA_ENV_SETTINGS \
1744 "myvar1=value1\0" \
1745 "myvar2=value2\0"
1746
wdenk4a5c8a72003-03-06 00:02:04 +00001747 Warning: This method is based on knowledge about the
1748 internal format how the environment is stored by the
1749 U-Boot code. This is NOT an official, exported
1750 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00001751 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001752 You better know what you are doing here.
1753
wdenk4a5c8a72003-03-06 00:02:04 +00001754 Note: overly (ab)use of the default environment is
1755 discouraged. Make sure to check other ways to preset
1756 the environment like the autoscript function or the
1757 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001758
wdenkc0aa5c52003-12-06 19:49:23 +00001759- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00001760 CONFIG_HAS_DATAFLASH
1761
wdenk57b2d802003-06-27 21:31:46 +00001762 Defining this option enables DataFlash features and
1763 allows to read/write in Dataflash via the standard
1764 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00001765
wdenkef893942004-02-23 16:11:30 +00001766- SystemACE Support:
1767 CONFIG_SYSTEMACE
1768
1769 Adding this option adds support for Xilinx SystemACE
1770 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001771 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001772 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00001773
1774 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001775 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00001776
1777 When SystemACE support is added, the "ace" device type
1778 becomes available to the fat commands, i.e. fatls.
1779
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001780- TFTP Fixed UDP Port:
1781 CONFIG_TFTP_PORT
1782
Wolfgang Denk227b5192005-09-24 23:25:46 +02001783 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001784 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02001785 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001786 number generator is used.
1787
Wolfgang Denk227b5192005-09-24 23:25:46 +02001788 Also, the environment variable tftpdstp is used to supply
1789 the TFTP UDP destination port value. If tftpdstp isn't
1790 defined, the normal port 69 is used.
1791
1792 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001793 blindly start the TFTP transfer using the pre-configured
1794 target IP address and UDP port. This has the effect of
1795 "punching through" the (Windows XP) firewall, allowing
1796 the remainder of the TFTP transfer to proceed normally.
1797 A better solution is to properly configure the firewall,
1798 but sometimes that is not allowed.
1799
wdenkc0aa5c52003-12-06 19:49:23 +00001800- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001801 CONFIG_SHOW_BOOT_PROGRESS
1802
wdenk4a5c8a72003-03-06 00:02:04 +00001803 Defining this option allows to add some board-
1804 specific code (calling a user-provided function
1805 "show_boot_progress(int)") that enables you to show
1806 the system's boot progress on some display (for
1807 example, some LED's) on your board. At the moment,
1808 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001809
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02001810- Automatic software updates via TFTP server
1811 CONFIG_UPDATE_TFTP
1812 CONFIG_UPDATE_TFTP_CNT_MAX
1813 CONFIG_UPDATE_TFTP_MSEC_MAX
1814
1815 These options enable and control the auto-update feature;
1816 for a more detailed description refer to doc/README.update.
1817
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001818Legacy uImage format:
1819
wdenkc6097192002-11-03 00:24:07 +00001820 Arg Where When
1821 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00001822 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001823 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00001824 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001825 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00001826 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001827 4 common/cmd_bootm.c Image data has correct checksum
1828 -4 common/cmd_bootm.c Image is for unsupported architecture
1829 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001830 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001831 6 common/cmd_bootm.c Image Type check OK
1832 -6 common/cmd_bootm.c gunzip uncompression error
1833 -7 common/cmd_bootm.c Unimplemented compression type
1834 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001835 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001836 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001837
1838 9 common/image.c Start initial ramdisk verification
1839 -10 common/image.c Ramdisk header has bad magic number
1840 -11 common/image.c Ramdisk header has bad checksum
1841 10 common/image.c Ramdisk header is OK
1842 -12 common/image.c Ramdisk data has bad checksum
1843 11 common/image.c Ramdisk data has correct checksum
1844 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001845 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001846 13 common/image.c Start multifile image verification
1847 14 common/image.c No initial ramdisk, no multifile, continue.
1848
1849 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001850
wdenkd729d302004-02-27 00:07:27 +00001851 -30 lib_ppc/board.c Fatal error, hang the system
1852 -31 post/post.c POST test failed, detected by post_output_backlog()
1853 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00001854
Heiko Schocher633e03a2007-06-22 19:11:54 +02001855 34 common/cmd_doc.c before loading a Image from a DOC device
1856 -35 common/cmd_doc.c Bad usage of "doc" command
1857 35 common/cmd_doc.c correct usage of "doc" command
1858 -36 common/cmd_doc.c No boot device
1859 36 common/cmd_doc.c correct boot device
1860 -37 common/cmd_doc.c Unknown Chip ID on boot device
1861 37 common/cmd_doc.c correct chip ID found, device available
1862 -38 common/cmd_doc.c Read Error on boot device
1863 38 common/cmd_doc.c reading Image header from DOC device OK
1864 -39 common/cmd_doc.c Image header has bad magic number
1865 39 common/cmd_doc.c Image header has correct magic number
1866 -40 common/cmd_doc.c Error reading Image from DOC device
1867 40 common/cmd_doc.c Image header has correct magic number
1868 41 common/cmd_ide.c before loading a Image from a IDE device
1869 -42 common/cmd_ide.c Bad usage of "ide" command
1870 42 common/cmd_ide.c correct usage of "ide" command
1871 -43 common/cmd_ide.c No boot device
1872 43 common/cmd_ide.c boot device found
1873 -44 common/cmd_ide.c Device not available
1874 44 common/cmd_ide.c Device available
1875 -45 common/cmd_ide.c wrong partition selected
1876 45 common/cmd_ide.c partition selected
1877 -46 common/cmd_ide.c Unknown partition table
1878 46 common/cmd_ide.c valid partition table found
1879 -47 common/cmd_ide.c Invalid partition type
1880 47 common/cmd_ide.c correct partition type
1881 -48 common/cmd_ide.c Error reading Image Header on boot device
1882 48 common/cmd_ide.c reading Image Header from IDE device OK
1883 -49 common/cmd_ide.c Image header has bad magic number
1884 49 common/cmd_ide.c Image header has correct magic number
1885 -50 common/cmd_ide.c Image header has bad checksum
1886 50 common/cmd_ide.c Image header has correct checksum
1887 -51 common/cmd_ide.c Error reading Image from IDE device
1888 51 common/cmd_ide.c reading Image from IDE device OK
1889 52 common/cmd_nand.c before loading a Image from a NAND device
1890 -53 common/cmd_nand.c Bad usage of "nand" command
1891 53 common/cmd_nand.c correct usage of "nand" command
1892 -54 common/cmd_nand.c No boot device
1893 54 common/cmd_nand.c boot device found
1894 -55 common/cmd_nand.c Unknown Chip ID on boot device
1895 55 common/cmd_nand.c correct chip ID found, device available
1896 -56 common/cmd_nand.c Error reading Image Header on boot device
1897 56 common/cmd_nand.c reading Image Header from NAND device OK
1898 -57 common/cmd_nand.c Image header has bad magic number
1899 57 common/cmd_nand.c Image header has correct magic number
1900 -58 common/cmd_nand.c Error reading Image from NAND device
1901 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00001902
Heiko Schocher633e03a2007-06-22 19:11:54 +02001903 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001904
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001905 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02001906 -64 net/eth.c no Ethernet found.
1907 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00001908
Heiko Schocher633e03a2007-06-22 19:11:54 +02001909 -80 common/cmd_net.c usage wrong
1910 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001911 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02001912 81 common/cmd_net.c NetLoop() back without error
1913 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1914 82 common/cmd_net.c trying automatic boot
1915 83 common/cmd_net.c running autoscript
1916 -83 common/cmd_net.c some error in automatic boot or autoscript
1917 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00001918
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001919FIT uImage format:
1920
1921 Arg Where When
1922 100 common/cmd_bootm.c Kernel FIT Image has correct format
1923 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1924 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1925 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1926 102 common/cmd_bootm.c Kernel unit name specified
1927 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01001928 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001929 104 common/cmd_bootm.c Got kernel subimage node offset
1930 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1931 105 common/cmd_bootm.c Kernel subimage hash verification OK
1932 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1933 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001934 -106 common/cmd_bootm.c Kernel subimage has wrong type
1935 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001936 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1937 108 common/cmd_bootm.c Got kernel subimage data/size
1938 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1939 -109 common/cmd_bootm.c Can't get kernel subimage type
1940 -110 common/cmd_bootm.c Can't get kernel subimage comp
1941 -111 common/cmd_bootm.c Can't get kernel subimage os
1942 -112 common/cmd_bootm.c Can't get kernel subimage load address
1943 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1944
1945 120 common/image.c Start initial ramdisk verification
1946 -120 common/image.c Ramdisk FIT image has incorrect format
1947 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001948 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001949 -122 common/image.c Can't get configuration for ramdisk subimage
1950 123 common/image.c Ramdisk unit name specified
1951 -124 common/image.c Can't get ramdisk subimage node offset
1952 125 common/image.c Got ramdisk subimage node offset
1953 -125 common/image.c Ramdisk subimage hash verification failed
1954 126 common/image.c Ramdisk subimage hash verification OK
1955 -126 common/image.c Ramdisk subimage for unsupported architecture
1956 127 common/image.c Architecture check OK
1957 -127 common/image.c Can't get ramdisk subimage data/size
1958 128 common/image.c Got ramdisk subimage data/size
1959 129 common/image.c Can't get ramdisk load address
1960 -129 common/image.c Got ramdisk load address
1961
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001962 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001963 131 common/cmd_doc.c FIT image format OK
1964
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001965 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001966 141 common/cmd_ide.c FIT image format OK
1967
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001968 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01001969 151 common/cmd_nand.c FIT image format OK
1970
1971
wdenkc6097192002-11-03 00:24:07 +00001972Modem Support:
1973--------------
1974
wdenk8dba0502003-03-31 16:34:49 +00001975[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001976
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001977- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00001978 CONFIG_MODEM_SUPPORT
1979
1980- RTS/CTS Flow control enable:
1981 CONFIG_HWFLOW
1982
1983- Modem debug support:
1984 CONFIG_MODEM_SUPPORT_DEBUG
1985
wdenk4a5c8a72003-03-06 00:02:04 +00001986 Enables debugging stuff (char screen[1024], dbg())
1987 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001988
wdenkc0aa5c52003-12-06 19:49:23 +00001989- Interrupt support (PPC):
1990
wdenk1ebf41e2004-01-02 14:00:00 +00001991 There are common interrupt_init() and timer_interrupt()
1992 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001993 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00001994 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001995 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00001996 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001997 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00001998 specific handling. If board has watchdog / status_led
1999 / other_activity_monitor it works automatically from
2000 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00002001
wdenkc6097192002-11-03 00:24:07 +00002002- General:
2003
wdenk4a5c8a72003-03-06 00:02:04 +00002004 In the target system modem support is enabled when a
2005 specific key (key combination) is pressed during
2006 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002007 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00002008 board_init(). Currently key_pressed() is a dummy
2009 function, returning 1 and thus enabling modem
2010 initialization.
wdenkc6097192002-11-03 00:24:07 +00002011
wdenk4a5c8a72003-03-06 00:02:04 +00002012 If there are no modem init strings in the
2013 environment, U-Boot proceed to autoboot; the
2014 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002015 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002016
2017 See also: doc/README.Modem
2018
2019
wdenkc6097192002-11-03 00:24:07 +00002020Configuration Settings:
2021-----------------------
2022
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002023- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002024 undefine this when you're short of memory.
2025
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002026- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002027 prompt for user input.
2028
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002029- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002030
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002031- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002032
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002033- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002034
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002035- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002036 the application (usually a Linux kernel) when it is
2037 booted
2038
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002039- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002040 List of legal baudrate settings for this board.
2041
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002042- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00002043 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002044
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002045- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00002046 If the board specific function
2047 extern int overwrite_console (void);
2048 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002049 serial port, else the settings in the environment are used.
2050
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002051- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00002052 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002053
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002054- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002055 Enable overwrite of previous console environment settings.
2056
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002057- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002058 Begin and End addresses of the area used by the
2059 simple memory test.
2060
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002061- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00002062 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002063
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002064- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00002065 Scratch address used by the alternate memory test
2066 You only need to set this if address zero isn't writeable
2067
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002068- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2069 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01002070 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002071 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01002072 fixing up gd->ram_size the Linux kernel should gets passed
2073 the now "corrected" memory size and won't touch it either.
2074 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01002075 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01002076 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01002077 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01002078
2079 This option can be used as a workaround for the 440EPx/GRx
2080 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2081 be touched.
2082
2083 WARNING: Please make sure that this value is a multiple of
2084 the Linux page size (normally 4k). If this is not the case,
2085 then the end address of the Linux memory will be located at a
2086 non page size aligned address and this could cause major
2087 problems.
2088
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002089- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002090 Default load address for network file downloads
2091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002092- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002093 Enable temporary baudrate change while serial download
2094
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002095- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002096 Physical start address of SDRAM. _Must_ be 0 here.
2097
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002098- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002099 Physical start address of Motherboard I/O (if using a
2100 Cogent motherboard)
2101
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002102- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002103 Physical start address of Flash memory.
2104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002105- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002106 Physical start address of boot monitor code (set by
2107 make config files to be same as the text base address
2108 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002109 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002110
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002111- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00002112 Size of memory reserved for monitor code, used to
2113 determine _at_compile_time_ (!) if the environment is
2114 embedded within the U-Boot image, or in a separate
2115 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002116
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002117- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002118 Size of DRAM reserved for malloc() use.
2119
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002120- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01002121 Normally compressed uImages are limited to an
2122 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002123 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01002124 to adjust this setting to your needs.
2125
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002126- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002127 Maximum size of memory mapped by the startup code of
2128 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002129 the Linux kernel (bd_info, boot arguments, FDT blob if
2130 used) must be put below this limit, unless "bootm_low"
2131 enviroment variable is defined and non-zero. In such case
2132 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002133 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002134
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002135- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002136 Max number of Flash memory banks
2137
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002138- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002139 Max number of sectors on a Flash chip
2140
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002141- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002142 Timeout for Flash erase operations (in ms)
2143
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002144- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002145 Timeout for Flash write operations (in ms)
2146
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002147- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002148 Timeout for Flash set sector lock bit operation (in ms)
2149
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002150- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00002151 Timeout for Flash clear lock bits operation (in ms)
2152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002153- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00002154 If defined, hardware flash sectors protection is used
2155 instead of U-Boot software protection.
2156
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002157- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002158
2159 Enable TFTP transfers directly to flash memory;
2160 without this option such a download has to be
2161 performed in two steps: (1) download to RAM, and (2)
2162 copy from RAM to flash.
2163
2164 The two-step approach is usually more reliable, since
2165 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002166 the flash, but in some situations (when system RAM is
2167 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002168 downloaded image) this option may be very useful.
2169
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002170- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00002171 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00002172 common flash structure for storing flash geometry.
2173
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02002174- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00002175 This option also enables the building of the cfi_flash driver
2176 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002177
Piotr Ziecik3e939e92008-11-17 15:57:58 +01002178- CONFIG_FLASH_CFI_MTD
2179 This option enables the building of the cfi_mtd driver
2180 in the drivers directory. The driver exports CFI flash
2181 to the MTD layer.
2182
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002183- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02002184 Use buffered writes to flash.
2185
2186- CONFIG_FLASH_SPANSION_S29WS_N
2187 s29ws-n MirrorBit flash has non-standard addresses for buffered
2188 write commands.
2189
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002190- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01002191 If this option is defined, the common CFI flash doesn't
2192 print it's warning upon not recognized FLASH banks. This
2193 is useful, if some of the configured banks are only
2194 optionally available.
2195
Jerry Van Barenaae73572008-03-08 13:48:01 -05002196- CONFIG_FLASH_SHOW_PROGRESS
2197 If defined (must be an integer), print out countdown
2198 digits and dots. Recommended value: 45 (9..1) for 80
2199 column displays, 15 (3..1) for 40 column displays.
2200
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002201- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002202 Defines the number of Ethernet receive buffers. On some
2203 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00002204 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2205 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002206 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00002207 Defaults to 4 if not defined.
2208
wdenkc6097192002-11-03 00:24:07 +00002209The following definitions that deal with the placement and management
2210of environment data (variable area); in general, we support the
2211following configurations:
2212
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002213- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002214
2215 Define this if the environment is in flash memory.
2216
2217 a) The environment occupies one whole flash sector, which is
2218 "embedded" in the text segment with the U-Boot code. This
2219 happens usually with "bottom boot sector" or "top boot
2220 sector" type flash chips, which have several smaller
2221 sectors at the start or the end. For instance, such a
2222 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2223 such a case you would place the environment in one of the
2224 4 kB sectors - with U-Boot code before and after it. With
2225 "top boot sector" type flash chips, you would put the
2226 environment in one of the last sectors, leaving a gap
2227 between U-Boot and the environment.
2228
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002229 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002230
2231 Offset of environment data (variable area) to the
2232 beginning of flash memory; for instance, with bottom boot
2233 type flash chips the second sector can be used: the offset
2234 for this sector is given here.
2235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002236 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002237
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002238 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002239
2240 This is just another way to specify the start address of
2241 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002242 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002243
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002244 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002245
2246 Size of the sector containing the environment.
2247
2248
2249 b) Sometimes flash chips have few, equal sized, BIG sectors.
2250 In such a case you don't want to spend a whole sector for
2251 the environment.
2252
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002253 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002254
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02002255 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002256 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002257 of this flash sector for the environment. This saves
2258 memory for the RAM copy of the environment.
2259
2260 It may also save flash memory if you decide to use this
2261 when your environment is "embedded" within U-Boot code,
2262 since then the remainder of the flash sector could be used
2263 for U-Boot code. It should be pointed out that this is
2264 STRONGLY DISCOURAGED from a robustness point of view:
2265 updating the environment in flash makes it always
2266 necessary to erase the WHOLE sector. If something goes
2267 wrong before the contents has been restored from a copy in
2268 RAM, your target system will be dead.
2269
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002270 - CONFIG_ENV_ADDR_REDUND
2271 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002272
wdenk4a5c8a72003-03-06 00:02:04 +00002273 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002274 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00002275 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00002276 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002277
2278BE CAREFUL! Any changes to the flash layout, and some changes to the
2279source code will make it necessary to adapt <board>/u-boot.lds*
2280accordingly!
2281
2282
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02002283- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002284
2285 Define this if you have some non-volatile memory device
2286 (NVRAM, battery buffered SRAM) which you want to use for the
2287 environment.
2288
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002289 - CONFIG_ENV_ADDR:
2290 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002291
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002292 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002293 want to use for environment. It is assumed that this memory
2294 can just be read and written to, without any special
2295 provision.
2296
2297BE CAREFUL! The first access to the environment happens quite early
2298in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002299console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002300U-Boot will hang.
2301
2302Please note that even with NVRAM we still use a copy of the
2303environment in RAM: we could work on NVRAM directly, but we want to
2304keep settings there always unmodified except somebody uses "saveenv"
2305to save the current settings.
2306
2307
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02002308- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002309
2310 Use this if you have an EEPROM or similar serial access
2311 device and a driver for it.
2312
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002313 - CONFIG_ENV_OFFSET:
2314 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002315
2316 These two #defines specify the offset and size of the
2317 environment area within the total memory of your EEPROM.
2318
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002319 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002320 If defined, specified the chip address of the EEPROM device.
2321 The default address is zero.
2322
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002323 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002324 If defined, the number of bits used to address bytes in a
2325 single page in the EEPROM device. A 64 byte page, for example
2326 would require six bits.
2327
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002328 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002329 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00002330 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002331
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002332 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002333 The length in bytes of the EEPROM memory array address. Note
2334 that this is NOT the chip address length!
2335
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002336 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00002337 EEPROM chips that implement "address overflow" are ones
2338 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2339 address and the extra bits end up in the "chip address" bit
2340 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2341 byte chips.
2342
2343 Note that we consider the length of the address field to
2344 still be one byte because the extra address bits are hidden
2345 in the chip address.
2346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002347 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002348 The size in bytes of the EEPROM device.
2349
wdenkc6097192002-11-03 00:24:07 +00002350
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02002351- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00002352
wdenk1ebf41e2004-01-02 14:00:00 +00002353 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00002354 want to use for the environment.
2355
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002356 - CONFIG_ENV_OFFSET:
2357 - CONFIG_ENV_ADDR:
2358 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00002359
2360 These three #defines specify the offset and size of the
2361 environment area within the total memory of your DataFlash placed
2362 at the specified address.
2363
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02002364- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00002365
2366 Define this if you have a NAND device which you want to use
2367 for the environment.
2368
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002369 - CONFIG_ENV_OFFSET:
2370 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00002371
2372 These two #defines specify the offset and size of the environment
2373 area within the first NAND device.
wdenk86765902003-12-06 23:55:10 +00002374
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002375 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002376
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002377 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002378 size used to hold a redundant copy of the environment data,
2379 so that there is a valid backup copy in case there is a
2380 power failure during a "saveenv" operation.
2381
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02002382 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2383 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002384 the NAND devices block size.
2385
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002386- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002387
2388 Defines offset to the initial SPI buffer area in DPRAM. The
2389 area is used at an early stage (ROM part) if the environment
2390 is configured to reside in the SPI EEPROM: We need a 520 byte
2391 scratch DPRAM area. It is used between the two initialization
2392 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2393 to be a good choice since it makes it far enough from the
2394 start of the data area as well as from the stack pointer.
2395
Bruce Adleredecc942007-11-02 13:15:42 -07002396Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002397has been relocated to RAM and a RAM copy of the environment has been
2398created; also, when using EEPROM you will have to use getenv_r()
2399until then to read environment variables.
2400
wdenk8dba0502003-03-31 16:34:49 +00002401The environment is protected by a CRC32 checksum. Before the monitor
2402is relocated into RAM, as a result of a bad CRC you will be working
2403with the compiled-in default environment - *silently*!!! [This is
2404necessary, because the first environment variable we need is the
2405"baudrate" setting for the console - if we have a bad CRC, we don't
2406have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002407
2408Note: once the monitor has been relocated, then it will complain if
2409the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002410use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002411
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002412- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002413 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002414
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002415 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00002416 also needs to be defined.
2417
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002418- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002419 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002420
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002421- CONFIG_SYS_64BIT_VSPRINTF:
wdenkf602aa02004-03-13 23:29:43 +00002422 Makes vsprintf (and all *printf functions) support printing
2423 of 64bit values by using the L quantifier
2424
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002425- CONFIG_SYS_64BIT_STRTOUL:
wdenkf602aa02004-03-13 23:29:43 +00002426 Adds simple_strtoull that returns a 64bit value
2427
wdenkc6097192002-11-03 00:24:07 +00002428Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002429---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002430
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002431- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002432 Cache Line Size of the CPU.
2433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002434- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002435 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00002436
wdenk9c53f402003-10-15 23:53:47 +00002437 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2438 and RPXsuper) to be able to adjust the position of
2439 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002440
wdenk1272e232002-11-10 22:06:23 +00002441- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002442 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00002443
2444 the default drive number (default value 0)
2445
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002446 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00002447
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002448 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00002449 (default value 1)
2450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002451 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00002452
wdenk4a5c8a72003-03-06 00:02:04 +00002453 defines the offset of register from address. It
2454 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002455 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00002456
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002457 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2458 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00002459 default value.
wdenk1272e232002-11-10 22:06:23 +00002460
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002461 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00002462 fdc_hw_init() is called at the beginning of the FDC
2463 setup. fdc_hw_init() must be provided by the board
2464 source code. It is used to make hardware dependant
2465 initializations.
wdenk1272e232002-11-10 22:06:23 +00002466
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002467- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002468 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00002469 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002470
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002471- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002472
wdenkeb20ad32003-09-05 23:19:14 +00002473 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002474 initial data and stack; please note that this must be
2475 writable memory that is working WITHOUT special
2476 initialization, i. e. you CANNOT use normal RAM which
2477 will become available only after programming the
2478 memory controller and running certain initialization
2479 sequences.
2480
2481 U-Boot uses the following memory types:
2482 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2483 - MPC824X: data cache
2484 - PPC4xx: data cache
2485
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002486- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002487
2488 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002489 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2490 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002491 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002492 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2493 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2494 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2495 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002496
2497 Note:
2498 On the MPC824X (or other systems that use the data
2499 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002500 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002501 point to an otherwise UNUSED address space between
2502 the top of RAM and the start of the PCI space.
2503
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002504- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002505
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002506- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002507
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002508- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002509
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002510- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002512- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002514- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002515
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002516- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002517 SDRAM timing
2518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002519- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002520 periodic timer for refresh
2521
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002522- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002523
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002524- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2525 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2526 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2527 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002528 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2529
2530- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002531 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2532 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002533 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002535- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2536 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002537 Machine Mode Register and Memory Periodic Timer
2538 Prescaler definitions (SDRAM timing)
2539
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002540- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002541 enable I2C microcode relocation patch (MPC8xx);
2542 define relocation offset in DPRAM [DSP2]
2543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002544- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01002545 enable SMC microcode relocation patch (MPC8xx);
2546 define relocation offset in DPRAM [SMC1]
2547
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002548- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002549 enable SPI microcode relocation patch (MPC8xx);
2550 define relocation offset in DPRAM [SCC4]
2551
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002552- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002553 Use OSCM clock mode on MBX8xx board. Be careful,
2554 wrong setting might damage your board. Read
2555 doc/README.MBX before setting this variable!
2556
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002557- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00002558 Offset of the bootmode word in DPRAM used by post
2559 (Power On Self Tests). This definition overrides
2560 #define'd default value in commproc.h resp.
2561 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00002562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002563- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2564 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2565 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2566 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2567 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2568 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2569 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2570 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
wdenkbf2f8c92003-05-22 22:52:13 +00002571 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2572
Ben Warren45657152006-09-07 16:50:54 -04002573- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002574 Get DDR timing information from an I2C EEPROM. Common
2575 with pluggable memory modules such as SODIMMs
2576
Ben Warren45657152006-09-07 16:50:54 -04002577 SPD_EEPROM_ADDRESS
2578 I2C address of the SPD EEPROM
2579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002580- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002581 If SPD EEPROM is on an I2C bus other than the first
2582 one, specify here. Note that the value must resolve
2583 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04002584
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002585- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002586 Only for 83xx systems. If specified, then DDR should
2587 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002588
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002589- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002590 Only for 83xx systems. If specified, then DDR should
2591 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06002592
wdenk6203e402004-04-18 10:13:26 +00002593- CONFIG_ETHER_ON_FEC[12]
2594 Define to enable FEC[12] on a 8xx series processor.
2595
2596- CONFIG_FEC[12]_PHY
2597 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00002598 to the given FEC; i. e.
2599 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00002600 means that the PHY with address 4 is connected to FEC1
2601
2602 When set to -1, means to probe for first available.
2603
2604- CONFIG_FEC[12]_PHY_NORXERR
2605 The PHY does not have a RXERR line (RMII only).
2606 (so program the FEC to ignore it).
2607
2608- CONFIG_RMII
2609 Enable RMII mode for all FECs.
2610 Note that this is a global option, we can't
2611 have one FEC in standard MII mode and another in RMII mode.
2612
wdenk20c98a62004-04-23 20:32:05 +00002613- CONFIG_CRC32_VERIFY
2614 Add a verify option to the crc32 command.
2615 The syntax is:
2616
2617 => crc32 -v <address> <count> <crc32>
2618
2619 Where address/count indicate a memory area
2620 and crc32 is the correct crc32 which the
2621 area should have.
2622
wdenk64519362004-07-11 17:40:54 +00002623- CONFIG_LOOPW
2624 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002625 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00002626
stroesecc3af832004-12-16 18:46:55 +00002627- CONFIG_MX_CYCLIC
2628 Add the "mdc" and "mwc" memory commands. These are cyclic
2629 "md/mw" commands.
2630 Examples:
2631
wdenk07d7e6b2004-12-16 21:44:03 +00002632 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002633 This command will print 4 bytes (10,11,12,13) each 500 ms.
2634
wdenk07d7e6b2004-12-16 21:44:03 +00002635 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002636 This command will write 12345678 to address 100 all 10 ms.
2637
wdenk07d7e6b2004-12-16 21:44:03 +00002638 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002639 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00002640
wdenk3d3d99f2005-04-04 12:44:11 +00002641- CONFIG_SKIP_LOWLEVEL_INIT
2642- CONFIG_SKIP_RELOCATE_UBOOT
2643
wdenke085e5b2005-04-05 23:32:21 +00002644 [ARM only] If these variables are defined, then
2645 certain low level initializations (like setting up
2646 the memory controller) are omitted and/or U-Boot does
2647 not relocate itself into RAM.
2648 Normally these variables MUST NOT be defined. The
2649 only exception is when U-Boot is loaded (to RAM) by
2650 some other boot loader or by a debugger which
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002651 performs these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00002652
wdenk336b2bc2005-04-02 23:52:25 +00002653
wdenkc6097192002-11-03 00:24:07 +00002654Building the Software:
2655======================
2656
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002657Building U-Boot has been tested in several native build environments
2658and in many different cross environments. Of course we cannot support
2659all possibly existing versions of cross development tools in all
2660(potentially obsolete) versions. In case of tool chain problems we
2661recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2662which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002663
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002664If you are not using a native environment, it is assumed that you
2665have GNU cross compiling tools available in your path. In this case,
2666you must set the environment variable CROSS_COMPILE in your shell.
2667Note that no changes to the Makefile or any other source files are
2668necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002669
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002670 $ CROSS_COMPILE=ppc_4xx-
2671 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002672
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002673U-Boot is intended to be simple to build. After installing the
2674sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002675is done by typing:
2676
2677 make NAME_config
2678
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002679where "NAME_config" is the name of one of the existing configu-
2680rations; see the main Makefile for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00002681
wdenk6c59edc2004-05-03 20:45:30 +00002682Note: for some board special configuration names may exist; check if
2683 additional information is available from the board vendor; for
2684 instance, the TQM823L systems are available without (standard)
2685 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002686 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002687
wdenk6c59edc2004-05-03 20:45:30 +00002688 make TQM823L_config
2689 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002690
wdenk6c59edc2004-05-03 20:45:30 +00002691 make TQM823L_LCD_config
2692 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002693
wdenk6c59edc2004-05-03 20:45:30 +00002694 etc.
wdenkc6097192002-11-03 00:24:07 +00002695
wdenkc6097192002-11-03 00:24:07 +00002696
wdenk6c59edc2004-05-03 20:45:30 +00002697Finally, type "make all", and you should get some working U-Boot
2698images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002699
wdenk6c59edc2004-05-03 20:45:30 +00002700- "u-boot.bin" is a raw binary image
2701- "u-boot" is an image in ELF binary format
2702- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002703
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002704By default the build is performed locally and the objects are saved
2705in the source directory. One of the two methods can be used to change
2706this behavior and build U-Boot to some external directory:
2707
27081. Add O= to the make command line invocations:
2709
2710 make O=/tmp/build distclean
2711 make O=/tmp/build NAME_config
2712 make O=/tmp/build all
2713
27142. Set environment variable BUILD_DIR to point to the desired location:
2715
2716 export BUILD_DIR=/tmp/build
2717 make distclean
2718 make NAME_config
2719 make all
2720
2721Note that the command line "O=" setting overrides the BUILD_DIR environment
2722variable.
2723
wdenkc6097192002-11-03 00:24:07 +00002724
wdenk6c59edc2004-05-03 20:45:30 +00002725Please be aware that the Makefiles assume you are using GNU make, so
2726for instance on NetBSD you might need to use "gmake" instead of
2727native "make".
wdenkc6097192002-11-03 00:24:07 +00002728
wdenkc6097192002-11-03 00:24:07 +00002729
wdenk6c59edc2004-05-03 20:45:30 +00002730If the system board that you have is not listed, then you will need
2731to port U-Boot to your hardware platform. To do this, follow these
2732steps:
wdenkc6097192002-11-03 00:24:07 +00002733
wdenk6c59edc2004-05-03 20:45:30 +000027341. Add a new configuration option for your board to the toplevel
2735 "Makefile" and to the "MAKEALL" script, using the existing
2736 entries as examples. Note that here and at many other places
2737 boards and other names are listed in alphabetical sort order. Please
2738 keep this order.
27392. Create a new directory to hold your board specific code. Add any
2740 files you need. In your board directory, you will need at least
2741 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
27423. Create a new configuration file "include/configs/<board>.h" for
2743 your board
27443. If you're porting U-Boot to a new CPU, then also create a new
2745 directory to hold your CPU specific code. Add any files you need.
27464. Run "make <board>_config" with your new name.
27475. Type "make", and you should get a working "u-boot.srec" file
2748 to be installed on your target system.
27496. Debug and solve any problems that might arise.
2750 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002751
wdenkc6097192002-11-03 00:24:07 +00002752
wdenk6c59edc2004-05-03 20:45:30 +00002753Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2754==============================================================
wdenkc6097192002-11-03 00:24:07 +00002755
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002756If you have modified U-Boot sources (for instance added a new board
2757or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00002758provide feedback to the other developers. The feedback normally takes
2759the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002760official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002761
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002762But before you submit such a patch, please verify that your modifi-
2763cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00002764the supported boards compile WITHOUT ANY compiler warnings. To do so,
2765just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002766for ALL supported system. Be warned, this will take a while. You can
2767select which (cross) compiler to use by passing a `CROSS_COMPILE'
2768environment variable to the script, i. e. to use the ELDK cross tools
2769you can type
wdenkc6097192002-11-03 00:24:07 +00002770
wdenk6c59edc2004-05-03 20:45:30 +00002771 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002772
wdenk6c59edc2004-05-03 20:45:30 +00002773or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002774
wdenk6c59edc2004-05-03 20:45:30 +00002775 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002776
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002777When using the MAKEALL script, the default behaviour is to build
2778U-Boot in the source directory. This location can be changed by
2779setting the BUILD_DIR environment variable. Also, for each target
2780built, the MAKEALL script saves two log files (<target>.ERR and
2781<target>.MAKEALL) in the <source dir>/LOG directory. This default
2782location can be changed by setting the MAKEALL_LOGDIR environment
2783variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002784
2785 export BUILD_DIR=/tmp/build
2786 export MAKEALL_LOGDIR=/tmp/log
2787 CROSS_COMPILE=ppc_8xx- MAKEALL
2788
Wolfgang Denkb240aef2008-03-26 10:40:12 +01002789With the above settings build objects are saved in the /tmp/build,
2790log files are saved in the /tmp/log and the source tree remains clean
2791during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002792
2793
wdenk6c59edc2004-05-03 20:45:30 +00002794See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002795
wdenkc6097192002-11-03 00:24:07 +00002796
wdenk6c59edc2004-05-03 20:45:30 +00002797Monitor Commands - Overview:
2798============================
wdenkc6097192002-11-03 00:24:07 +00002799
wdenk6c59edc2004-05-03 20:45:30 +00002800go - start application at address 'addr'
2801run - run commands in an environment variable
2802bootm - boot application image from memory
2803bootp - boot image via network using BootP/TFTP protocol
2804tftpboot- boot image via network using TFTP protocol
2805 and env variables "ipaddr" and "serverip"
2806 (and eventually "gatewayip")
2807rarpboot- boot image via network using RARP/TFTP protocol
2808diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2809loads - load S-Record file over serial line
2810loadb - load binary file over serial line (kermit mode)
2811md - memory display
2812mm - memory modify (auto-incrementing)
2813nm - memory modify (constant address)
2814mw - memory write (fill)
2815cp - memory copy
2816cmp - memory compare
2817crc32 - checksum calculation
2818imd - i2c memory display
2819imm - i2c memory modify (auto-incrementing)
2820inm - i2c memory modify (constant address)
2821imw - i2c memory write (fill)
2822icrc32 - i2c checksum calculation
2823iprobe - probe to discover valid I2C chip addresses
2824iloop - infinite loop on address range
2825isdram - print SDRAM configuration information
2826sspi - SPI utility commands
2827base - print or set address offset
2828printenv- print environment variables
2829setenv - set environment variables
2830saveenv - save environment variables to persistent storage
2831protect - enable or disable FLASH write protection
2832erase - erase FLASH memory
2833flinfo - print FLASH memory information
2834bdinfo - print Board Info structure
2835iminfo - print header information for application image
2836coninfo - print console devices and informations
2837ide - IDE sub-system
2838loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00002839loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00002840mtest - simple RAM test
2841icache - enable or disable instruction cache
2842dcache - enable or disable data cache
2843reset - Perform RESET of the CPU
2844echo - echo args to console
2845version - print monitor version
2846help - print online help
2847? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002848
wdenkc6097192002-11-03 00:24:07 +00002849
wdenk6c59edc2004-05-03 20:45:30 +00002850Monitor Commands - Detailed Description:
2851========================================
wdenkc6097192002-11-03 00:24:07 +00002852
wdenk6c59edc2004-05-03 20:45:30 +00002853TODO.
wdenkc6097192002-11-03 00:24:07 +00002854
wdenk6c59edc2004-05-03 20:45:30 +00002855For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002856
2857
wdenk6c59edc2004-05-03 20:45:30 +00002858Environment Variables:
2859======================
wdenkc6097192002-11-03 00:24:07 +00002860
wdenk6c59edc2004-05-03 20:45:30 +00002861U-Boot supports user configuration using Environment Variables which
2862can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002863
wdenk6c59edc2004-05-03 20:45:30 +00002864Environment Variables are set using "setenv", printed using
2865"printenv", and saved to Flash using "saveenv". Using "setenv"
2866without a value can be used to delete a variable from the
2867environment. As long as you don't save the environment you are
2868working with an in-memory copy. In case the Flash area containing the
2869environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002870
wdenk6c59edc2004-05-03 20:45:30 +00002871Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002872
wdenk6c59edc2004-05-03 20:45:30 +00002873 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002874
wdenk6c59edc2004-05-03 20:45:30 +00002875 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002876
wdenk6c59edc2004-05-03 20:45:30 +00002877 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002878
wdenk6c59edc2004-05-03 20:45:30 +00002879 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002880
wdenk6c59edc2004-05-03 20:45:30 +00002881 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002882
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002883 bootm_low - Memory range available for image processing in the bootm
2884 command can be restricted. This variable is given as
2885 a hexadecimal number and defines lowest address allowed
2886 for use by the bootm command. See also "bootm_size"
2887 environment variable. Address defined by "bootm_low" is
2888 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002889 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02002890
2891 bootm_size - Memory range available for image processing in the bootm
2892 command can be restricted. This variable is given as
2893 a hexadecimal number and defines the size of the region
2894 allowed for use by the bootm command. See also "bootm_low"
2895 environment variable.
2896
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02002897 updatefile - Location of the software update file on a TFTP server, used
2898 by the automatic software update feature. Please refer to
2899 documentation in doc/README.update for more details.
2900
wdenk6c59edc2004-05-03 20:45:30 +00002901 autoload - if set to "no" (any string beginning with 'n'),
2902 "bootp" will just load perform a lookup of the
2903 configuration from the BOOTP server, but not try to
2904 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002905
Marian Balakowicz18710b82008-03-12 12:13:13 +01002906 autoscript - if set to "yes" commands like "loadb", "loady",
2907 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
2908 to automatically run script images (by internally
2909 calling "autoscript").
2910
2911 autoscript_uname - if script image is in a format (FIT) this
2912 variable is used to get script subimage unit name.
2913
wdenk6c59edc2004-05-03 20:45:30 +00002914 autostart - if set to "yes", an image loaded using the "bootp",
2915 "rarpboot", "tftpboot" or "diskboot" commands will
2916 be automatically started (by internally calling
2917 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002918
wdenk6c59edc2004-05-03 20:45:30 +00002919 If set to "no", a standalone image passed to the
2920 "bootm" command will be copied to the load address
2921 (and eventually uncompressed), but NOT be started.
2922 This can be used to load and uncompress arbitrary
2923 data.
wdenkc6097192002-11-03 00:24:07 +00002924
wdenk0e2bd9c2004-06-06 21:51:03 +00002925 i2cfast - (PPC405GP|PPC405EP only)
2926 if set to 'y' configures Linux I2C driver for fast
2927 mode (400kHZ). This environment variable is used in
2928 initialization code. So, for changes to be effective
2929 it must be saved and board must be reset.
2930
wdenk6c59edc2004-05-03 20:45:30 +00002931 initrd_high - restrict positioning of initrd images:
2932 If this variable is not set, initrd images will be
2933 copied to the highest possible address in RAM; this
2934 is usually what you want since it allows for
2935 maximum initrd size. If for some reason you want to
2936 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002937 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00002938 variable to a value of "no" or "off" or "0".
2939 Alternatively, you can set it to a maximum upper
2940 address to use (U-Boot will still check that it
2941 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002942
wdenk6c59edc2004-05-03 20:45:30 +00002943 For instance, when you have a system with 16 MB
2944 RAM, and want to reserve 4 MB from use by Linux,
2945 you can do this by adding "mem=12M" to the value of
2946 the "bootargs" variable. However, now you must make
2947 sure that the initrd image is placed in the first
2948 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002949
wdenk6c59edc2004-05-03 20:45:30 +00002950 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002951
wdenk6c59edc2004-05-03 20:45:30 +00002952 If you set initrd_high to 0xFFFFFFFF, this is an
2953 indication to U-Boot that all addresses are legal
2954 for the Linux kernel, including addresses in flash
2955 memory. In this case U-Boot will NOT COPY the
2956 ramdisk at all. This may be useful to reduce the
2957 boot time on your system, but requires that this
2958 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00002959
wdenk6c59edc2004-05-03 20:45:30 +00002960 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002961
wdenk6c59edc2004-05-03 20:45:30 +00002962 loadaddr - Default load address for commands like "bootp",
2963 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002964
wdenk6c59edc2004-05-03 20:45:30 +00002965 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002966
wdenk6c59edc2004-05-03 20:45:30 +00002967 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00002968
wdenk6c59edc2004-05-03 20:45:30 +00002969 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002970
wdenk6c59edc2004-05-03 20:45:30 +00002971 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002972
wdenk6c59edc2004-05-03 20:45:30 +00002973 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002974
wdenk6c59edc2004-05-03 20:45:30 +00002975 ethprime - When CONFIG_NET_MULTI is enabled controls which
2976 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002977
wdenk6c59edc2004-05-03 20:45:30 +00002978 ethact - When CONFIG_NET_MULTI is enabled controls which
2979 interface is currently active. For example you
2980 can do the following
wdenkc6097192002-11-03 00:24:07 +00002981
wdenk6c59edc2004-05-03 20:45:30 +00002982 => setenv ethact FEC ETHERNET
2983 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2984 => setenv ethact SCC ETHERNET
2985 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002986
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01002987 ethrotate - When set to "no" U-Boot does not go through all
2988 available network interfaces.
2989 It just stays at the currently selected interface.
2990
wdenk6c59edc2004-05-03 20:45:30 +00002991 netretry - When set to "no" each network operation will
2992 either succeed or fail without retrying.
2993 When set to "once" the network operation will
2994 fail when all the available network interfaces
2995 are tried once without success.
2996 Useful on scripts which control the retry operation
2997 themselves.
wdenkc6097192002-11-03 00:24:07 +00002998
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01002999 npe_ucode - see CONFIG_IXP4XX_NPE_EXT_UCOD
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003000 if set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01003001
Wolfgang Denk227b5192005-09-24 23:25:46 +02003002 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003003 UDP source port.
3004
Wolfgang Denk227b5192005-09-24 23:25:46 +02003005 tftpdstport - If this is set, the value is used for TFTP's UDP
3006 destination port instead of the Well Know Port 69.
3007
wdenk6c59edc2004-05-03 20:45:30 +00003008 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003009 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00003010 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00003011
wdenk6c59edc2004-05-03 20:45:30 +00003012The following environment variables may be used and automatically
3013updated by the network boot commands ("bootp" and "rarpboot"),
3014depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00003015
wdenk6c59edc2004-05-03 20:45:30 +00003016 bootfile - see above
3017 dnsip - IP address of your Domain Name Server
3018 dnsip2 - IP address of your secondary Domain Name Server
3019 gatewayip - IP address of the Gateway (Router) to use
3020 hostname - Target hostname
3021 ipaddr - see above
3022 netmask - Subnet Mask
3023 rootpath - Pathname of the root filesystem on the NFS server
3024 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00003025
wdenk145d2c12004-04-15 21:48:45 +00003026
wdenk6c59edc2004-05-03 20:45:30 +00003027There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003028
wdenk6c59edc2004-05-03 20:45:30 +00003029 serial# - contains hardware identification information such
3030 as type string and/or serial number
3031 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003032
wdenk6c59edc2004-05-03 20:45:30 +00003033These variables can be set only once (usually during manufacturing of
3034the board). U-Boot refuses to delete or overwrite these variables
3035once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003036
3037
wdenk6c59edc2004-05-03 20:45:30 +00003038Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003039
wdenk6c59edc2004-05-03 20:45:30 +00003040 ver - Contains the U-Boot version string as printed
3041 with the "version" command. This variable is
3042 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003043
wdenkc6097192002-11-03 00:24:07 +00003044
wdenk6c59edc2004-05-03 20:45:30 +00003045Please note that changes to some configuration parameters may take
3046only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00003047
stroeseb9c17c52003-04-04 15:53:41 +00003048
wdenk6c59edc2004-05-03 20:45:30 +00003049Command Line Parsing:
3050=====================
stroeseb9c17c52003-04-04 15:53:41 +00003051
wdenk6c59edc2004-05-03 20:45:30 +00003052There are two different command line parsers available with U-Boot:
3053the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00003054
wdenk6c59edc2004-05-03 20:45:30 +00003055Old, simple command line parser:
3056--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003057
wdenk6c59edc2004-05-03 20:45:30 +00003058- supports environment variables (through setenv / saveenv commands)
3059- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003060- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00003061- special characters ('$', ';') can be escaped by prefixing with '\',
3062 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01003063 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00003064- You can also escape text by enclosing in single apostrophes, for example:
3065 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003066
wdenk6c59edc2004-05-03 20:45:30 +00003067Hush shell:
3068-----------
wdenkf4688a22003-05-28 08:06:31 +00003069
wdenk6c59edc2004-05-03 20:45:30 +00003070- similar to Bourne shell, with control structures like
3071 if...then...else...fi, for...do...done; while...do...done,
3072 until...do...done, ...
3073- supports environment ("global") variables (through setenv / saveenv
3074 commands) and local shell variables (through standard shell syntax
3075 "name=value"); only environment variables can be used with "run"
3076 command
wdenkf4688a22003-05-28 08:06:31 +00003077
wdenk6c59edc2004-05-03 20:45:30 +00003078General rules:
3079--------------
wdenkf4688a22003-05-28 08:06:31 +00003080
wdenk6c59edc2004-05-03 20:45:30 +00003081(1) If a command line (or an environment variable executed by a "run"
3082 command) contains several commands separated by semicolon, and
3083 one of these commands fails, then the remaining commands will be
3084 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00003085
wdenk6c59edc2004-05-03 20:45:30 +00003086(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003087 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00003088 command will cause "run" to terminate, i. e. the remaining
3089 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00003090
wdenk6c59edc2004-05-03 20:45:30 +00003091Note for Redundant Ethernet Interfaces:
3092=======================================
wdenkf4688a22003-05-28 08:06:31 +00003093
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003094Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00003095such configurations and is capable of automatic selection of a
3096"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00003097
wdenk6c59edc2004-05-03 20:45:30 +00003098Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3099MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3100"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00003101
wdenk6c59edc2004-05-03 20:45:30 +00003102If the network interface stores some valid MAC address (for instance
3103in SROM), this is used as default address if there is NO correspon-
3104ding setting in the environment; if the corresponding environment
3105variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00003106
wdenk6c59edc2004-05-03 20:45:30 +00003107o If the SROM has a valid MAC address, and there is no address in the
3108 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003109
wdenk6c59edc2004-05-03 20:45:30 +00003110o If there is no valid address in the SROM, and a definition in the
3111 environment exists, then the value from the environment variable is
3112 used.
wdenkc6097192002-11-03 00:24:07 +00003113
wdenk6c59edc2004-05-03 20:45:30 +00003114o If both the SROM and the environment contain a MAC address, and
3115 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003116
wdenk6c59edc2004-05-03 20:45:30 +00003117o If both the SROM and the environment contain a MAC address, and the
3118 addresses differ, the value from the environment is used and a
3119 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003120
wdenk6c59edc2004-05-03 20:45:30 +00003121o If neither SROM nor the environment contain a MAC address, an error
3122 is raised.
wdenkc6097192002-11-03 00:24:07 +00003123
wdenkc6097192002-11-03 00:24:07 +00003124
wdenk6c59edc2004-05-03 20:45:30 +00003125Image Formats:
3126==============
wdenkc6097192002-11-03 00:24:07 +00003127
Marian Balakowicz18710b82008-03-12 12:13:13 +01003128U-Boot is capable of booting (and performing other auxiliary operations on)
3129images in two formats:
3130
3131New uImage format (FIT)
3132-----------------------
3133
3134Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3135to Flattened Device Tree). It allows the use of images with multiple
3136components (several kernels, ramdisks, etc.), with contents protected by
3137SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3138
3139
3140Old uImage format
3141-----------------
3142
3143Old image format is based on binary files which can be basically anything,
3144preceded by a special header; see the definitions in include/image.h for
3145details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003146
wdenk6c59edc2004-05-03 20:45:30 +00003147* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3148 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05003149 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3150 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3151 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02003152* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk6c59edc2004-05-03 20:45:30 +00003153 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk83c15852006-10-24 14:21:16 +02003154 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00003155* Compression Type (uncompressed, gzip, bzip2)
3156* Load Address
3157* Entry Point
3158* Image Name
3159* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003160
wdenk6c59edc2004-05-03 20:45:30 +00003161The header is marked by a special Magic Number, and both the header
3162and the data portions of the image are secured against corruption by
3163CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003164
wdenkc6097192002-11-03 00:24:07 +00003165
wdenk6c59edc2004-05-03 20:45:30 +00003166Linux Support:
3167==============
wdenkc6097192002-11-03 00:24:07 +00003168
wdenk6c59edc2004-05-03 20:45:30 +00003169Although U-Boot should support any OS or standalone application
3170easily, the main focus has always been on Linux during the design of
3171U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003172
wdenk6c59edc2004-05-03 20:45:30 +00003173U-Boot includes many features that so far have been part of some
3174special "boot loader" code within the Linux kernel. Also, any
3175"initrd" images to be used are no longer part of one big Linux image;
3176instead, kernel and "initrd" are separate images. This implementation
3177serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003178
wdenk6c59edc2004-05-03 20:45:30 +00003179- the same features can be used for other OS or standalone
3180 applications (for instance: using compressed images to reduce the
3181 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003182
wdenk6c59edc2004-05-03 20:45:30 +00003183- it becomes much easier to port new Linux kernel versions because
3184 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003185
wdenk6c59edc2004-05-03 20:45:30 +00003186- the same Linux kernel image can now be used with different "initrd"
3187 images; of course this also means that different kernel images can
3188 be run with the same "initrd". This makes testing easier (you don't
3189 have to build a new "zImage.initrd" Linux image when you just
3190 change a file in your "initrd"). Also, a field-upgrade of the
3191 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003192
wdenkc6097192002-11-03 00:24:07 +00003193
wdenk6c59edc2004-05-03 20:45:30 +00003194Linux HOWTO:
3195============
wdenkc6097192002-11-03 00:24:07 +00003196
wdenk6c59edc2004-05-03 20:45:30 +00003197Porting Linux to U-Boot based systems:
3198---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk6c59edc2004-05-03 20:45:30 +00003200U-Boot cannot save you from doing all the necessary modifications to
3201configure the Linux device drivers for use with your target hardware
3202(no, we don't intend to provide a full virtual machine interface to
3203Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003204
wdenk6c59edc2004-05-03 20:45:30 +00003205But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003206
wdenk6c59edc2004-05-03 20:45:30 +00003207Just make sure your machine specific header file (for instance
3208include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02003209Information structure as we define in include/asm-<arch>/u-boot.h,
3210and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003211as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003212
wdenkc6097192002-11-03 00:24:07 +00003213
wdenk6c59edc2004-05-03 20:45:30 +00003214Configuring the Linux kernel:
3215-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003216
wdenk6c59edc2004-05-03 20:45:30 +00003217No specific requirements for U-Boot. Make sure you have some root
3218device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003219
wdenkc6097192002-11-03 00:24:07 +00003220
wdenk6c59edc2004-05-03 20:45:30 +00003221Building a Linux Image:
3222-----------------------
wdenkc6097192002-11-03 00:24:07 +00003223
wdenk6c59edc2004-05-03 20:45:30 +00003224With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3225not used. If you use recent kernel source, a new build target
3226"uImage" will exist which automatically builds an image usable by
3227U-Boot. Most older kernels also have support for a "pImage" target,
3228which was introduced for our predecessor project PPCBoot and uses a
3229100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003230
wdenk6c59edc2004-05-03 20:45:30 +00003231Example:
wdenkc6097192002-11-03 00:24:07 +00003232
wdenk6c59edc2004-05-03 20:45:30 +00003233 make TQM850L_config
3234 make oldconfig
3235 make dep
3236 make uImage
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk6c59edc2004-05-03 20:45:30 +00003238The "uImage" build target uses a special tool (in 'tools/mkimage') to
3239encapsulate a compressed Linux kernel image with header information,
3240CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003241
wdenk6c59edc2004-05-03 20:45:30 +00003242* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003243
wdenk6c59edc2004-05-03 20:45:30 +00003244* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003245
wdenk6c59edc2004-05-03 20:45:30 +00003246 ${CROSS_COMPILE}-objcopy -O binary \
3247 -R .note -R .comment \
3248 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003249
wdenk6c59edc2004-05-03 20:45:30 +00003250* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00003251
wdenk6c59edc2004-05-03 20:45:30 +00003252 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00003253
wdenk6c59edc2004-05-03 20:45:30 +00003254* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003255
wdenk6c59edc2004-05-03 20:45:30 +00003256 mkimage -A ppc -O linux -T kernel -C gzip \
3257 -a 0 -e 0 -n "Linux Kernel Image" \
3258 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003259
wdenkc6097192002-11-03 00:24:07 +00003260
wdenk6c59edc2004-05-03 20:45:30 +00003261The "mkimage" tool can also be used to create ramdisk images for use
3262with U-Boot, either separated from the Linux kernel image, or
3263combined into one file. "mkimage" encapsulates the images with a 64
3264byte header containing information about target architecture,
3265operating system, image type, compression method, entry points, time
3266stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003267
wdenk6c59edc2004-05-03 20:45:30 +00003268"mkimage" can be called in two ways: to verify existing images and
3269print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003270
wdenk6c59edc2004-05-03 20:45:30 +00003271In the first form (with "-l" option) mkimage lists the information
3272contained in the header of an existing U-Boot image; this includes
3273checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003274
wdenk6c59edc2004-05-03 20:45:30 +00003275 tools/mkimage -l image
3276 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003277
wdenk6c59edc2004-05-03 20:45:30 +00003278The second form (with "-d" option) is used to build a U-Boot image
3279from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003280
wdenk6c59edc2004-05-03 20:45:30 +00003281 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3282 -n name -d data_file image
3283 -A ==> set architecture to 'arch'
3284 -O ==> set operating system to 'os'
3285 -T ==> set image type to 'type'
3286 -C ==> set compression type 'comp'
3287 -a ==> set load address to 'addr' (hex)
3288 -e ==> set entry point to 'ep' (hex)
3289 -n ==> set image name to 'name'
3290 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003291
wdenkcd914452004-05-29 16:53:29 +00003292Right now, all Linux kernels for PowerPC systems use the same load
3293address (0x00000000), but the entry point address depends on the
3294kernel version:
wdenkc6097192002-11-03 00:24:07 +00003295
wdenk6c59edc2004-05-03 20:45:30 +00003296- 2.2.x kernels have the entry point at 0x0000000C,
3297- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003298
wdenk6c59edc2004-05-03 20:45:30 +00003299So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003300
wdenk6c59edc2004-05-03 20:45:30 +00003301 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3302 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3303 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3304 > examples/uImage.TQM850L
3305 Image Name: 2.4.4 kernel for TQM850L
3306 Created: Wed Jul 19 02:34:59 2000
3307 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3308 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3309 Load Address: 0x00000000
3310 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003311
wdenk6c59edc2004-05-03 20:45:30 +00003312To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003313
wdenk6c59edc2004-05-03 20:45:30 +00003314 -> tools/mkimage -l examples/uImage.TQM850L
3315 Image Name: 2.4.4 kernel for TQM850L
3316 Created: Wed Jul 19 02:34:59 2000
3317 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3318 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3319 Load Address: 0x00000000
3320 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003321
wdenk6c59edc2004-05-03 20:45:30 +00003322NOTE: for embedded systems where boot time is critical you can trade
3323speed for memory and install an UNCOMPRESSED image instead: this
3324needs more space in Flash, but boots much faster since it does not
3325need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003326
wdenk6c59edc2004-05-03 20:45:30 +00003327 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3328 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3329 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3330 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3331 > examples/uImage.TQM850L-uncompressed
3332 Image Name: 2.4.4 kernel for TQM850L
3333 Created: Wed Jul 19 02:34:59 2000
3334 Image Type: PowerPC Linux Kernel Image (uncompressed)
3335 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3336 Load Address: 0x00000000
3337 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003338
wdenkc6097192002-11-03 00:24:07 +00003339
wdenk6c59edc2004-05-03 20:45:30 +00003340Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3341when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003342
wdenk6c59edc2004-05-03 20:45:30 +00003343 -> tools/mkimage -n 'Simple Ramdisk Image' \
3344 > -A ppc -O linux -T ramdisk -C gzip \
3345 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3346 Image Name: Simple Ramdisk Image
3347 Created: Wed Jan 12 14:01:50 2000
3348 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3349 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3350 Load Address: 0x00000000
3351 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003352
wdenkc6097192002-11-03 00:24:07 +00003353
wdenk6c59edc2004-05-03 20:45:30 +00003354Installing a Linux Image:
3355-------------------------
wdenkc6097192002-11-03 00:24:07 +00003356
wdenk6c59edc2004-05-03 20:45:30 +00003357To downloading a U-Boot image over the serial (console) interface,
3358you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003359
wdenk6c59edc2004-05-03 20:45:30 +00003360 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003361
wdenk6c59edc2004-05-03 20:45:30 +00003362The 'objcopy' does not understand the information in the U-Boot
3363image header, so the resulting S-Record file will be relative to
3364address 0x00000000. To load it to a given address, you need to
3365specify the target address as 'offset' parameter with the 'loads'
3366command.
wdenkc6097192002-11-03 00:24:07 +00003367
wdenk6c59edc2004-05-03 20:45:30 +00003368Example: install the image to address 0x40100000 (which on the
3369TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003370
wdenk6c59edc2004-05-03 20:45:30 +00003371 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003372
wdenk6c59edc2004-05-03 20:45:30 +00003373 .......... done
3374 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003375
wdenk6c59edc2004-05-03 20:45:30 +00003376 => loads 40100000
3377 ## Ready for S-Record download ...
3378 ~>examples/image.srec
3379 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3380 ...
3381 15989 15990 15991 15992
3382 [file transfer complete]
3383 [connected]
3384 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003385
wdenkc6097192002-11-03 00:24:07 +00003386
wdenk6c59edc2004-05-03 20:45:30 +00003387You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003388this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00003389corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003390
wdenk6c59edc2004-05-03 20:45:30 +00003391 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003392
wdenk6c59edc2004-05-03 20:45:30 +00003393 ## Checking Image at 40100000 ...
3394 Image Name: 2.2.13 for initrd on TQM850L
3395 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3396 Data Size: 335725 Bytes = 327 kB = 0 MB
3397 Load Address: 00000000
3398 Entry Point: 0000000c
3399 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003400
3401
wdenk6c59edc2004-05-03 20:45:30 +00003402Boot Linux:
3403-----------
wdenkc6097192002-11-03 00:24:07 +00003404
wdenk6c59edc2004-05-03 20:45:30 +00003405The "bootm" command is used to boot an application that is stored in
3406memory (RAM or Flash). In case of a Linux kernel image, the contents
3407of the "bootargs" environment variable is passed to the kernel as
3408parameters. You can check and modify this variable using the
3409"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003410
wdenkc6097192002-11-03 00:24:07 +00003411
wdenk6c59edc2004-05-03 20:45:30 +00003412 => printenv bootargs
3413 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003414
wdenk6c59edc2004-05-03 20:45:30 +00003415 => 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 +00003416
wdenk6c59edc2004-05-03 20:45:30 +00003417 => printenv bootargs
3418 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 +00003419
wdenk6c59edc2004-05-03 20:45:30 +00003420 => bootm 40020000
3421 ## Booting Linux kernel at 40020000 ...
3422 Image Name: 2.2.13 for NFS on TQM850L
3423 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3424 Data Size: 381681 Bytes = 372 kB = 0 MB
3425 Load Address: 00000000
3426 Entry Point: 0000000c
3427 Verifying Checksum ... OK
3428 Uncompressing Kernel Image ... OK
3429 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
3430 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3431 time_init: decrementer frequency = 187500000/60
3432 Calibrating delay loop... 49.77 BogoMIPS
3433 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3434 ...
wdenkc6097192002-11-03 00:24:07 +00003435
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003436If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00003437the memory addresses of both the kernel and the initrd image (PPBCOOT
3438format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003439
wdenk6c59edc2004-05-03 20:45:30 +00003440 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003441
wdenk6c59edc2004-05-03 20:45:30 +00003442 ## Checking Image at 40100000 ...
3443 Image Name: 2.2.13 for initrd on TQM850L
3444 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3445 Data Size: 335725 Bytes = 327 kB = 0 MB
3446 Load Address: 00000000
3447 Entry Point: 0000000c
3448 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003449
wdenk6c59edc2004-05-03 20:45:30 +00003450 ## Checking Image at 40200000 ...
3451 Image Name: Simple Ramdisk Image
3452 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3453 Data Size: 566530 Bytes = 553 kB = 0 MB
3454 Load Address: 00000000
3455 Entry Point: 00000000
3456 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003457
wdenk6c59edc2004-05-03 20:45:30 +00003458 => bootm 40100000 40200000
3459 ## Booting Linux kernel at 40100000 ...
3460 Image Name: 2.2.13 for initrd on TQM850L
3461 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3462 Data Size: 335725 Bytes = 327 kB = 0 MB
3463 Load Address: 00000000
3464 Entry Point: 0000000c
3465 Verifying Checksum ... OK
3466 Uncompressing Kernel Image ... OK
3467 ## Loading RAMDisk Image at 40200000 ...
3468 Image Name: Simple Ramdisk Image
3469 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3470 Data Size: 566530 Bytes = 553 kB = 0 MB
3471 Load Address: 00000000
3472 Entry Point: 00000000
3473 Verifying Checksum ... OK
3474 Loading Ramdisk ... OK
3475 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
3476 Boot arguments: root=/dev/ram
3477 time_init: decrementer frequency = 187500000/60
3478 Calibrating delay loop... 49.77 BogoMIPS
3479 ...
3480 RAMDISK: Compressed image found at block 0
3481 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003482
wdenk6c59edc2004-05-03 20:45:30 +00003483 bash#
wdenkc6097192002-11-03 00:24:07 +00003484
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003485Boot Linux and pass a flat device tree:
3486-----------
3487
3488First, U-Boot must be compiled with the appropriate defines. See the section
3489titled "Linux Kernel Interface" above for a more in depth explanation. The
3490following is an example of how to start a kernel and pass an updated
3491flat device tree:
3492
3493=> print oftaddr
3494oftaddr=0x300000
3495=> print oft
3496oft=oftrees/mpc8540ads.dtb
3497=> tftp $oftaddr $oft
3498Speed: 1000, full duplex
3499Using TSEC0 device
3500TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3501Filename 'oftrees/mpc8540ads.dtb'.
3502Load address: 0x300000
3503Loading: #
3504done
3505Bytes transferred = 4106 (100a hex)
3506=> tftp $loadaddr $bootfile
3507Speed: 1000, full duplex
3508Using TSEC0 device
3509TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3510Filename 'uImage'.
3511Load address: 0x200000
3512Loading:############
3513done
3514Bytes transferred = 1029407 (fb51f hex)
3515=> print loadaddr
3516loadaddr=200000
3517=> print oftaddr
3518oftaddr=0x300000
3519=> bootm $loadaddr - $oftaddr
3520## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01003521 Image Name: Linux-2.6.17-dirty
3522 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3523 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003524 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01003525 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003526 Verifying Checksum ... OK
3527 Uncompressing Kernel Image ... OK
3528Booting using flat device tree at 0x300000
3529Using MPC85xx ADS machine description
3530Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3531[snip]
3532
3533
wdenk6c59edc2004-05-03 20:45:30 +00003534More About U-Boot Image Types:
3535------------------------------
wdenkc6097192002-11-03 00:24:07 +00003536
wdenk6c59edc2004-05-03 20:45:30 +00003537U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk6c59edc2004-05-03 20:45:30 +00003539 "Standalone Programs" are directly runnable in the environment
3540 provided by U-Boot; it is expected that (if they behave
3541 well) you can continue to work in U-Boot after return from
3542 the Standalone Program.
3543 "OS Kernel Images" are usually images of some Embedded OS which
3544 will take over control completely. Usually these programs
3545 will install their own set of exception handlers, device
3546 drivers, set up the MMU, etc. - this means, that you cannot
3547 expect to re-enter U-Boot except by resetting the CPU.
3548 "RAMDisk Images" are more or less just data blocks, and their
3549 parameters (address, size) are passed to an OS kernel that is
3550 being started.
3551 "Multi-File Images" contain several images, typically an OS
3552 (Linux) kernel image and one or more data images like
3553 RAMDisks. This construct is useful for instance when you want
3554 to boot over the network using BOOTP etc., where the boot
3555 server provides just a single image file, but you want to get
3556 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk6c59edc2004-05-03 20:45:30 +00003558 "Multi-File Images" start with a list of image sizes, each
3559 image size (in bytes) specified by an "uint32_t" in network
3560 byte order. This list is terminated by an "(uint32_t)0".
3561 Immediately after the terminating 0 follow the images, one by
3562 one, all aligned on "uint32_t" boundaries (size rounded up to
3563 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00003564
wdenk6c59edc2004-05-03 20:45:30 +00003565 "Firmware Images" are binary images containing firmware (like
3566 U-Boot or FPGA images) which usually will be programmed to
3567 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00003568
wdenk6c59edc2004-05-03 20:45:30 +00003569 "Script files" are command sequences that will be executed by
3570 U-Boot's command interpreter; this feature is especially
3571 useful when you configure U-Boot to use a real shell (hush)
3572 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00003573
stroeseb9c17c52003-04-04 15:53:41 +00003574
wdenk6c59edc2004-05-03 20:45:30 +00003575Standalone HOWTO:
3576=================
stroeseb9c17c52003-04-04 15:53:41 +00003577
wdenk6c59edc2004-05-03 20:45:30 +00003578One of the features of U-Boot is that you can dynamically load and
3579run "standalone" applications, which can use some resources of
3580U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00003581
wdenk6c59edc2004-05-03 20:45:30 +00003582Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00003583
wdenk6c59edc2004-05-03 20:45:30 +00003584"Hello World" Demo:
3585-------------------
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk6c59edc2004-05-03 20:45:30 +00003587'examples/hello_world.c' contains a small "Hello World" Demo
3588application; it is automatically compiled when you build U-Boot.
3589It's configured to run at address 0x00040004, so you can play with it
3590like that:
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk6c59edc2004-05-03 20:45:30 +00003592 => loads
3593 ## Ready for S-Record download ...
3594 ~>examples/hello_world.srec
3595 1 2 3 4 5 6 7 8 9 10 11 ...
3596 [file transfer complete]
3597 [connected]
3598 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003599
wdenk6c59edc2004-05-03 20:45:30 +00003600 => go 40004 Hello World! This is a test.
3601 ## Starting application at 0x00040004 ...
3602 Hello World
3603 argc = 7
3604 argv[0] = "40004"
3605 argv[1] = "Hello"
3606 argv[2] = "World!"
3607 argv[3] = "This"
3608 argv[4] = "is"
3609 argv[5] = "a"
3610 argv[6] = "test."
3611 argv[7] = "<NULL>"
3612 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003613
wdenk6c59edc2004-05-03 20:45:30 +00003614 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003615
wdenk6c59edc2004-05-03 20:45:30 +00003616Another example, which demonstrates how to register a CPM interrupt
3617handler with the U-Boot code, can be found in 'examples/timer.c'.
3618Here, a CPM timer is set up to generate an interrupt every second.
3619The interrupt service routine is trivial, just printing a '.'
3620character, but this is just a demo program. The application can be
3621controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003622
wdenk6c59edc2004-05-03 20:45:30 +00003623 ? - print current values og the CPM Timer registers
3624 b - enable interrupts and start timer
3625 e - stop timer and disable interrupts
3626 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003627
wdenk6c59edc2004-05-03 20:45:30 +00003628 => loads
3629 ## Ready for S-Record download ...
3630 ~>examples/timer.srec
3631 1 2 3 4 5 6 7 8 9 10 11 ...
3632 [file transfer complete]
3633 [connected]
3634 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003635
wdenk6c59edc2004-05-03 20:45:30 +00003636 => go 40004
3637 ## Starting application at 0x00040004 ...
3638 TIMERS=0xfff00980
3639 Using timer 1
3640 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003641
wdenk6c59edc2004-05-03 20:45:30 +00003642Hit 'b':
3643 [q, b, e, ?] Set interval 1000000 us
3644 Enabling timer
3645Hit '?':
3646 [q, b, e, ?] ........
3647 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3648Hit '?':
3649 [q, b, e, ?] .
3650 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3651Hit '?':
3652 [q, b, e, ?] .
3653 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3654Hit '?':
3655 [q, b, e, ?] .
3656 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3657Hit 'e':
3658 [q, b, e, ?] ...Stopping timer
3659Hit 'q':
3660 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003661
wdenkc6097192002-11-03 00:24:07 +00003662
wdenk6c59edc2004-05-03 20:45:30 +00003663Minicom warning:
3664================
wdenkc6097192002-11-03 00:24:07 +00003665
wdenk6c59edc2004-05-03 20:45:30 +00003666Over time, many people have reported problems when trying to use the
3667"minicom" terminal emulation program for serial download. I (wd)
3668consider minicom to be broken, and recommend not to use it. Under
3669Unix, I recommend to use C-Kermit for general purpose use (and
3670especially for kermit binary protocol download ("loadb" command), and
3671use "cu" for S-Record download ("loads" command).
wdenkc6097192002-11-03 00:24:07 +00003672
wdenk6c59edc2004-05-03 20:45:30 +00003673Nevertheless, if you absolutely want to use it try adding this
3674configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00003675
wdenk6c59edc2004-05-03 20:45:30 +00003676 Name Program Name U/D FullScr IO-Red. Multi
3677 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3678 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00003679
wdenk8dba0502003-03-31 16:34:49 +00003680
wdenk6c59edc2004-05-03 20:45:30 +00003681NetBSD Notes:
3682=============
wdenkc6097192002-11-03 00:24:07 +00003683
wdenk6c59edc2004-05-03 20:45:30 +00003684Starting at version 0.9.2, U-Boot supports NetBSD both as host
3685(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00003686
wdenk6c59edc2004-05-03 20:45:30 +00003687Building requires a cross environment; it is known to work on
3688NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3689need gmake since the Makefiles are not compatible with BSD make).
3690Note that the cross-powerpc package does not install include files;
3691attempting to build U-Boot will fail because <machine/ansi.h> is
3692missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00003693
wdenk6c59edc2004-05-03 20:45:30 +00003694 # cd /usr/pkg/cross/powerpc-netbsd/include
3695 # mkdir powerpc
3696 # ln -s powerpc machine
3697 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3698 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00003699
wdenk6c59edc2004-05-03 20:45:30 +00003700Native builds *don't* work due to incompatibilities between native
3701and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk6c59edc2004-05-03 20:45:30 +00003703Booting assumes that (the first part of) the image booted is a
3704stage-2 loader which in turn loads and then invokes the kernel
3705proper. Loader sources will eventually appear in the NetBSD source
3706tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00003707meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003708
wdenkc6097192002-11-03 00:24:07 +00003709
wdenk6c59edc2004-05-03 20:45:30 +00003710Implementation Internals:
3711=========================
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk6c59edc2004-05-03 20:45:30 +00003713The following is not intended to be a complete description of every
3714implementation detail. However, it should help to understand the
3715inner workings of U-Boot and make it easier to port it to custom
3716hardware.
wdenkc6097192002-11-03 00:24:07 +00003717
wdenkc6097192002-11-03 00:24:07 +00003718
wdenk6c59edc2004-05-03 20:45:30 +00003719Initial Stack, Global Data:
3720---------------------------
wdenkc6097192002-11-03 00:24:07 +00003721
wdenk6c59edc2004-05-03 20:45:30 +00003722The implementation of U-Boot is complicated by the fact that U-Boot
3723starts running out of ROM (flash memory), usually without access to
3724system RAM (because the memory controller is not initialized yet).
3725This means that we don't have writable Data or BSS segments, and BSS
3726is not initialized as zero. To be able to get a C environment working
3727at all, we have to allocate at least a minimal stack. Implementation
3728options for this are defined and restricted by the CPU used: Some CPU
3729models provide on-chip memory (like the IMMR area on MPC8xx and
3730MPC826x processors), on others (parts of) the data cache can be
3731locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003732
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003733 Chris Hallinan posted a good summary of these issues to the
wdenk6c59edc2004-05-03 20:45:30 +00003734 u-boot-users mailing list:
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk6c59edc2004-05-03 20:45:30 +00003736 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3737 From: "Chris Hallinan" <clh@net1plus.com>
3738 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3739 ...
wdenkc6097192002-11-03 00:24:07 +00003740
wdenk6c59edc2004-05-03 20:45:30 +00003741 Correct me if I'm wrong, folks, but the way I understand it
3742 is this: Using DCACHE as initial RAM for Stack, etc, does not
3743 require any physical RAM backing up the cache. The cleverness
3744 is that the cache is being used as a temporary supply of
3745 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003746 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00003747 can see how this works by studying the cache architecture and
3748 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00003749
wdenk6c59edc2004-05-03 20:45:30 +00003750 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3751 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003752 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00003753 option should work for you. Using CS 4 should be fine if your
3754 board designers haven't used it for something that would
3755 cause you grief during the initial boot! It is frequently not
3756 used.
wdenkc6097192002-11-03 00:24:07 +00003757
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003758 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00003759 with your processor/board/system design. The default value
3760 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02003761 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00003762 than your SDRAM module. If you have a 64MB SDRAM module, set
3763 it above 400_0000. Just make sure your board has no resources
3764 that are supposed to respond to that address! That code in
3765 start.S has been around a while and should work as is when
3766 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00003767
wdenk6c59edc2004-05-03 20:45:30 +00003768 -Chris Hallinan
3769 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00003770
wdenk6c59edc2004-05-03 20:45:30 +00003771It is essential to remember this, since it has some impact on the C
3772code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00003773
wdenk6c59edc2004-05-03 20:45:30 +00003774* Initialized global data (data segment) is read-only. Do not attempt
3775 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00003776
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003777* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00003778 as zero data - BSS segment) at all - this is undefined, initiali-
3779 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00003780
wdenk6c59edc2004-05-03 20:45:30 +00003781* Stack space is very limited. Avoid big data buffers or things like
3782 that.
wdenk4a5c8a72003-03-06 00:02:04 +00003783
wdenk6c59edc2004-05-03 20:45:30 +00003784Having only the stack as writable memory limits means we cannot use
3785normal global data to share information beween the code. But it
3786turned out that the implementation of U-Boot can be greatly
3787simplified by making a global data structure (gd_t) available to all
3788functions. We could pass a pointer to this data as argument to _all_
3789functions, but this would bloat the code. Instead we use a feature of
3790the GCC compiler (Global Register Variables) to share the data: we
3791place a pointer (gd) to the global data into a register which we
3792reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003793
wdenk6c59edc2004-05-03 20:45:30 +00003794When choosing a register for such a purpose we are restricted by the
3795relevant (E)ABI specifications for the current architecture, and by
3796GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003797
wdenk6c59edc2004-05-03 20:45:30 +00003798For PowerPC, the following registers have specific use:
3799 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01003800 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00003801 R3-R4: parameter passing and return values
3802 R5-R10: parameter passing
3803 R13: small data area pointer
3804 R30: GOT pointer
3805 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003806
wdenk6c59edc2004-05-03 20:45:30 +00003807 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003808
Wolfgang Denk69c09642008-02-14 22:43:22 +01003809 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003810
wdenk6c59edc2004-05-03 20:45:30 +00003811 Note: on PPC, we could use a static initializer (since the
3812 address of the global data structure is known at compile time),
3813 but it turned out that reserving a register results in somewhat
3814 smaller code - although the code savings are not that big (on
3815 average for all boards 752 bytes for the whole U-Boot image,
3816 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003817
Mike Frysinger60f09302008-02-04 19:26:54 -05003818On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3819 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3820
3821 ==> U-Boot will use P5 to hold a pointer to the global data
3822
wdenk6c59edc2004-05-03 20:45:30 +00003823On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003824
wdenk6c59edc2004-05-03 20:45:30 +00003825 R0: function argument word/integer result
3826 R1-R3: function argument word
3827 R9: GOT pointer
3828 R10: stack limit (used only if stack checking if enabled)
3829 R11: argument (frame) pointer
3830 R12: temporary workspace
3831 R13: stack pointer
3832 R14: link register
3833 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003834
wdenk6c59edc2004-05-03 20:45:30 +00003835 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003836
Wolfgang Denk6405a152006-03-31 18:32:53 +02003837NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3838or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk6c59edc2004-05-03 20:45:30 +00003840Memory Management:
3841------------------
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk6c59edc2004-05-03 20:45:30 +00003843U-Boot runs in system state and uses physical addresses, i.e. the
3844MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003845
wdenk6c59edc2004-05-03 20:45:30 +00003846The available memory is mapped to fixed addresses using the memory
3847controller. In this process, a contiguous block is formed for each
3848memory type (Flash, SDRAM, SRAM), even when it consists of several
3849physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk6c59edc2004-05-03 20:45:30 +00003851U-Boot is installed in the first 128 kB of the first Flash bank (on
3852TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3853booting and sizing and initializing DRAM, the code relocates itself
3854to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003855memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00003856configuration setting]. Below that, a structure with global Board
3857Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003858
wdenk6c59edc2004-05-03 20:45:30 +00003859Additionally, some exception handler code is copied to the low 8 kB
3860of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003861
wdenk6c59edc2004-05-03 20:45:30 +00003862So a typical memory configuration with 16 MB of DRAM could look like
3863this:
wdenkc6097192002-11-03 00:24:07 +00003864
wdenk6c59edc2004-05-03 20:45:30 +00003865 0x0000 0000 Exception Vector code
3866 :
3867 0x0000 1FFF
3868 0x0000 2000 Free for Application Use
3869 :
3870 :
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk6c59edc2004-05-03 20:45:30 +00003872 :
3873 :
3874 0x00FB FF20 Monitor Stack (Growing downward)
3875 0x00FB FFAC Board Info Data and permanent copy of global data
3876 0x00FC 0000 Malloc Arena
3877 :
3878 0x00FD FFFF
3879 0x00FE 0000 RAM Copy of Monitor Code
3880 ... eventually: LCD or video framebuffer
3881 ... eventually: pRAM (Protected RAM - unchanged by reset)
3882 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003883
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk6c59edc2004-05-03 20:45:30 +00003885System Initialization:
3886----------------------
wdenkc6097192002-11-03 00:24:07 +00003887
wdenk6c59edc2004-05-03 20:45:30 +00003888In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003889(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00003890configuration for CS0# this is a mirror of the onboard Flash memory.
3891To be able to re-map memory U-Boot then jumps to its link address.
3892To be able to implement the initialization code in C, a (small!)
3893initial stack is set up in the internal Dual Ported RAM (in case CPUs
3894which provide such a feature like MPC8xx or MPC8260), or in a locked
3895part of the data cache. After that, U-Boot initializes the CPU core,
3896the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003897
wdenk6c59edc2004-05-03 20:45:30 +00003898Next, all (potentially) available memory banks are mapped using a
3899preliminary mapping. For example, we put them on 512 MB boundaries
3900(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3901on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3902programmed for SDRAM access. Using the temporary configuration, a
3903simple memory test is run that determines the size of the SDRAM
3904banks.
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk6c59edc2004-05-03 20:45:30 +00003906When there is more than one SDRAM bank, and the banks are of
3907different size, the largest is mapped first. For equal size, the first
3908bank (CS2#) is mapped first. The first mapping is always for address
39090x00000000, with any additional banks following immediately to create
3910contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003911
wdenk6c59edc2004-05-03 20:45:30 +00003912Then, the monitor installs itself at the upper end of the SDRAM area
3913and allocates memory for use by malloc() and for the global Board
3914Info data; also, the exception vector code is copied to the low RAM
3915pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003916
wdenk6c59edc2004-05-03 20:45:30 +00003917Only after this relocation will you have a "normal" C environment;
3918until that you are restricted in several ways, mostly because you are
3919running from ROM, and because the code will have to be relocated to a
3920new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003921
wdenkc6097192002-11-03 00:24:07 +00003922
wdenk6c59edc2004-05-03 20:45:30 +00003923U-Boot Porting Guide:
3924----------------------
wdenkc6097192002-11-03 00:24:07 +00003925
wdenk6c59edc2004-05-03 20:45:30 +00003926[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3927list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003928
wdenkc6097192002-11-03 00:24:07 +00003929
wdenk6c59edc2004-05-03 20:45:30 +00003930int main (int argc, char *argv[])
3931{
3932 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003933
wdenk6c59edc2004-05-03 20:45:30 +00003934 signal (SIGALRM, no_more_time);
3935 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk6c59edc2004-05-03 20:45:30 +00003937 if (available_money > available_manpower) {
3938 pay consultant to port U-Boot;
3939 return 0;
3940 }
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk6c59edc2004-05-03 20:45:30 +00003942 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00003943
wdenk6c59edc2004-05-03 20:45:30 +00003944 Subscribe to u-boot-users mailing list;
wdenkc6097192002-11-03 00:24:07 +00003945
wdenk6c59edc2004-05-03 20:45:30 +00003946 if (clueless) {
3947 email ("Hi, I am new to U-Boot, how do I get started?");
3948 }
wdenkc6097192002-11-03 00:24:07 +00003949
wdenk6c59edc2004-05-03 20:45:30 +00003950 while (learning) {
3951 Read the README file in the top level directory;
3952 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3953 Read the source, Luke;
3954 }
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk6c59edc2004-05-03 20:45:30 +00003956 if (available_money > toLocalCurrency ($2500)) {
3957 Buy a BDI2000;
3958 } else {
3959 Add a lot of aggravation and time;
3960 }
wdenkc6097192002-11-03 00:24:07 +00003961
wdenk6c59edc2004-05-03 20:45:30 +00003962 Create your own board support subdirectory;
wdenk34b613e2002-12-17 01:51:00 +00003963
wdenk6c59edc2004-05-03 20:45:30 +00003964 Create your own board config file;
wdenkc6097192002-11-03 00:24:07 +00003965
wdenk6c59edc2004-05-03 20:45:30 +00003966 while (!running) {
3967 do {
3968 Add / modify source code;
3969 } until (compiles);
3970 Debug;
3971 if (clueless)
3972 email ("Hi, I am having problems...");
wdenk634d2f72004-04-15 23:14:49 +00003973 }
wdenk6c59edc2004-05-03 20:45:30 +00003974 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk6c59edc2004-05-03 20:45:30 +00003976 return 0;
3977}
wdenkc6097192002-11-03 00:24:07 +00003978
wdenk6c59edc2004-05-03 20:45:30 +00003979void no_more_time (int sig)
3980{
3981 hire_a_guru();
3982}
wdenkc6097192002-11-03 00:24:07 +00003983
wdenkc6097192002-11-03 00:24:07 +00003984
wdenk6c59edc2004-05-03 20:45:30 +00003985Coding Standards:
3986-----------------
wdenkc6097192002-11-03 00:24:07 +00003987
wdenk6c59edc2004-05-03 20:45:30 +00003988All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02003989coding style; see the file "Documentation/CodingStyle" and the script
3990"scripts/Lindent" in your Linux kernel source directory. In sources
3991originating from U-Boot a style corresponding to "Lindent -pcs" (adding
3992spaces before parameters to function calls) is actually used.
3993
3994Source files originating from a different project (for example the
3995MTD subsystem) are generally exempt from these guidelines and are not
3996reformated to ease subsequent migration to newer versions of those
3997sources.
wdenkc6097192002-11-03 00:24:07 +00003998
Detlev Zundelaa63d482006-09-01 15:39:02 +02003999Please note that U-Boot is implemented in C (and to some small parts in
4000Assembler); no C++ is used, so please do not use C++ style comments (//)
4001in your code.
wdenkad276f22004-01-04 16:28:35 +00004002
wdenk6c59edc2004-05-03 20:45:30 +00004003Please also stick to the following formatting rules:
4004- remove any trailing white space
4005- use TAB characters for indentation, not spaces
4006- make sure NOT to use DOS '\r\n' line feeds
4007- do not add more than 2 empty lines to source files
4008- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk6c59edc2004-05-03 20:45:30 +00004010Submissions which do not conform to the standards may be returned
4011with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004012
wdenkc6097192002-11-03 00:24:07 +00004013
wdenk6c59edc2004-05-03 20:45:30 +00004014Submitting Patches:
4015-------------------
wdenkc6097192002-11-03 00:24:07 +00004016
wdenk6c59edc2004-05-03 20:45:30 +00004017Since the number of patches for U-Boot is growing, we need to
4018establish some rules. Submissions which do not conform to these rules
4019may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004020
wdenkcbc49a52005-05-03 14:12:25 +00004021Patches shall be sent to the u-boot-users mailing list.
wdenkc6097192002-11-03 00:24:07 +00004022
Magnus Liljaf3b287b2008-08-06 19:32:33 +02004023Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004024
wdenk6c59edc2004-05-03 20:45:30 +00004025When you send a patch, please include the following information with
4026it:
wdenkc6097192002-11-03 00:24:07 +00004027
wdenk6c59edc2004-05-03 20:45:30 +00004028* For bug fixes: a description of the bug and how your patch fixes
4029 this bug. Please try to include a way of demonstrating that the
4030 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004031
wdenk6c59edc2004-05-03 20:45:30 +00004032* For new features: a description of the feature and your
4033 implementation.
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk6c59edc2004-05-03 20:45:30 +00004035* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00004036
wdenk6c59edc2004-05-03 20:45:30 +00004037* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00004038
wdenk6c59edc2004-05-03 20:45:30 +00004039* When you add support for a new board, don't forget to add this
4040 board to the MAKEALL script, too.
wdenkc6097192002-11-03 00:24:07 +00004041
wdenk6c59edc2004-05-03 20:45:30 +00004042* If your patch adds new configuration options, don't forget to
4043 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00004044
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004045* The patch itself. If you are using git (which is *strongly*
4046 recommended) you can easily generate the patch using the
4047 "git-format-patch". If you then use "git-send-email" to send it to
4048 the U-Boot mailing list, you will avoid most of the common problems
4049 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00004050
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004051 If you cannot use git, use "diff -purN OLD NEW". If your version of
4052 diff does not support these options, then get the latest version of
4053 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00004054
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004055 The current directory when running this command shall be the parent
4056 directory of the U-Boot source tree (i. e. please make sure that
4057 your patch includes sufficient directory information for the
4058 affected files).
4059
4060 We prefer patches as plain text. MIME attachments are discouraged,
4061 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00004062
wdenk6c59edc2004-05-03 20:45:30 +00004063* If one logical set of modifications affects or creates several
4064 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00004065
wdenk6c59edc2004-05-03 20:45:30 +00004066* Changesets that contain different, unrelated modifications shall be
4067 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00004068
wdenkc6097192002-11-03 00:24:07 +00004069
wdenk6c59edc2004-05-03 20:45:30 +00004070Notes:
wdenkc6097192002-11-03 00:24:07 +00004071
wdenk6c59edc2004-05-03 20:45:30 +00004072* Before sending the patch, run the MAKEALL script on your patched
4073 source tree and make sure that no errors or warnings are reported
4074 for any of the boards.
4075
4076* Keep your modifications to the necessary minimum: A patch
4077 containing several unrelated changes or arbitrary reformats will be
4078 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00004079
wdenk6c59edc2004-05-03 20:45:30 +00004080* If you modify existing code, make sure that your new code does not
4081 add to the memory footprint of the code ;-) Small is beautiful!
4082 When adding new features, these should compile conditionally only
4083 (using #ifdef), and the resulting code with the new feature
4084 disabled must not need more memory than the old code without your
4085 modification.
wdenkcbc49a52005-05-03 14:12:25 +00004086
4087* Remember that there is a size limit of 40 kB per message on the
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004088 u-boot-users mailing list. Bigger patches will be moderated. If
4089 they are reasonable and not bigger than 100 kB, they will be
4090 acknowledged. Even bigger patches should be avoided.