blob: ebee20f63ea46f8929786bd50c111fc442fcc539 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk218ca722008-03-26 10:40:12 +01002# (C) Copyright 2000 - 2008
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
129U-Boot uses a 3 level version number containing a version, a
130sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
131sub-version "34", and patchlevel "4".
132
133The patchlevel is used to indicate certain stages of development
134between released versions, i. e. officially released versions of
135U-Boot will always have a patchlevel of "0".
136
137
wdenkc6097192002-11-03 00:24:07 +0000138Directory Hierarchy:
139====================
140
wdenk7152b1d2003-09-05 23:19:14 +0000141- board Board dependent files
142- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000143- cpu CPU specific files
wdenk983fda82004-10-28 00:09:35 +0000144 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenk11dadd542004-02-27 00:07:27 +0000145 - arm720t Files specific to ARM 720 CPUs
146 - arm920t Files specific to ARM 920 CPUs
wdenka85f9f22005-04-06 13:52:31 +0000147 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk983fda82004-10-28 00:09:35 +0000148 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenk1d9f4102004-10-09 22:21:29 +0000149 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenk11dadd542004-02-27 00:07:27 +0000150 - arm925t Files specific to ARM 925 CPUs
151 - arm926ejs Files specific to ARM 926 CPUs
wdenk8ed96042005-01-09 23:16:25 +0000152 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk72a087e2006-10-24 14:27:35 +0200153 - at32ap Files specific to Atmel AVR32 AP CPUs
wdenk11dadd542004-02-27 00:07:27 +0000154 - i386 Files specific to i386 CPUs
155 - ixp Files specific to Intel XScale IXP CPUs
Daniel Hellstromb3309902008-03-28 10:00:33 +0100156 - leon2 Files specific to Gaisler LEON2 SPARC CPU
Daniel Hellstrom1e9a1642008-03-26 22:51:29 +0100157 - leon3 Files specific to Gaisler LEON3 SPARC CPU
wdenk983fda82004-10-28 00:09:35 +0000158 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
TsiChungLiew1552af72008-01-14 17:43:33 -0600159 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
TsiChung Liew8e585f02007-06-18 13:50:13 -0500160 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
TsiChungLiew8ae158c2007-08-16 15:05:11 -0500161 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
TsiChungLiew57a12722008-01-15 14:15:46 -0600162 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
wdenk11dadd542004-02-27 00:07:27 +0000163 - mips Files specific to MIPS CPUs
wdenk983fda82004-10-28 00:09:35 +0000164 - mpc5xx Files specific to Freescale MPC5xx CPUs
165 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
166 - mpc8xx Files specific to Freescale MPC8xx CPUs
167 - mpc8220 Files specific to Freescale MPC8220 CPUs
168 - mpc824x Files specific to Freescale MPC824x CPUs
169 - mpc8260 Files specific to Freescale MPC8260 CPUs
170 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenk11dadd542004-02-27 00:07:27 +0000171 - nios Files specific to Altera NIOS CPUs
wdenk5c952cf2004-10-10 21:27:30 +0000172 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200173 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenk11dadd542004-02-27 00:07:27 +0000174 - pxa Files specific to Intel XScale PXA CPUs
175 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
176 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000177- disk Code for disk drive partition handling
178- doc Documentation (don't expect too much)
wdenk7152b1d2003-09-05 23:19:14 +0000179- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000180- dtt Digital Thermometer and Thermostat drivers
181- examples Example code for standalone applications, etc.
182- include Header Files
wdenk11dadd542004-02-27 00:07:27 +0000183- lib_arm Files generic to ARM architecture
Wolfgang Denk7b64fef2006-10-24 14:21:16 +0200184- lib_avr32 Files generic to AVR32 architecture
wdenk11dadd542004-02-27 00:07:27 +0000185- lib_generic Files generic to all architectures
186- lib_i386 Files generic to i386 architecture
187- lib_m68k Files generic to m68k architecture
188- lib_mips Files generic to MIPS architecture
189- lib_nios Files generic to NIOS architecture
190- lib_ppc Files generic to PowerPC architecture
Daniel Hellstromc2f02da2008-03-28 09:47:00 +0100191- lib_sparc Files generic to SPARC architecture
Wolfgang Denk218ca722008-03-26 10:40:12 +0100192- libfdt Library files to support flattened device trees
wdenkc6097192002-11-03 00:24:07 +0000193- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000194- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000195- rtc Real Time Clock drivers
196- tools Tools to build S-Record or U-Boot images, etc.
197
wdenkc6097192002-11-03 00:24:07 +0000198Software Configuration:
199=======================
200
201Configuration is usually done using C preprocessor defines; the
202rationale behind that is to avoid dead code whenever possible.
203
204There are two classes of configuration variables:
205
206* Configuration _OPTIONS_:
207 These are selectable by the user and have names beginning with
208 "CONFIG_".
209
210* Configuration _SETTINGS_:
211 These depend on the hardware etc. and should not be meddled with if
212 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200213 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000214
215Later we will add a configuration tool - probably similar to or even
216identical to what's used for the Linux kernel. Right now, we have to
217do the configuration by hand, which means creating some symbolic
218links and editing some configuration files. We use the TQM8xxL boards
219as an example here.
220
221
222Selection of Processor Architecture and Board Type:
223---------------------------------------------------
224
225For all supported boards there are ready-to-use default
226configurations available; just type "make <board_name>_config".
227
228Example: For a TQM823L module type:
229
230 cd u-boot
231 make TQM823L_config
232
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200233For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000234e.g. "make cogent_mpc8xx_config". And also configure the cogent
235directory according to the instructions in cogent/README.
236
237
238Configuration Options:
239----------------------
240
241Configuration depends on the combination of board and CPU type; all
242such information is kept in a configuration file
243"include/configs/<board_name>.h".
244
245Example: For a TQM823L module, all configuration settings are in
246"include/configs/TQM823L.h".
247
248
wdenk7f6c2cb2002-11-10 22:06:23 +0000249Many of the options are named exactly as the corresponding Linux
250kernel configuration options. The intention is to make it easier to
251build a config tool - later.
252
253
wdenkc6097192002-11-03 00:24:07 +0000254The following options need to be configured:
255
Kim Phillips26281142007-08-10 13:28:25 -0500256- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000257
Kim Phillips26281142007-08-10 13:28:25 -0500258- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200259
260- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100261 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000262
263- CPU Module Type: (if CONFIG_COGENT is defined)
264 Define exactly one of
265 CONFIG_CMA286_60_OLD
266--- FIXME --- not tested yet:
267 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
268 CONFIG_CMA287_23, CONFIG_CMA287_50
269
270- Motherboard Type: (if CONFIG_COGENT is defined)
271 Define exactly one of
272 CONFIG_CMA101, CONFIG_CMA102
273
274- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
275 Define one or more of
276 CONFIG_CMA302
277
278- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
279 Define one or more of
280 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200281 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000282 a "rotator" |\-/|\-/
283
wdenk2535d602003-07-17 23:16:40 +0000284- Board flavour: (if CONFIG_MPC8260ADS is defined)
285 CONFIG_ADSTYPE
286 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200287 CONFIG_SYS_8260ADS - original MPC8260ADS
288 CONFIG_SYS_8266ADS - MPC8266ADS
289 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
290 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000291
wdenkc6097192002-11-03 00:24:07 +0000292- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000293 Define exactly one of
294 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000295
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200296- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000297 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
298 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000299 e.g. if there is no 32KHz
300 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000301 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
302 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000303
wdenk66ca92a2004-09-28 17:59:53 +0000304- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200305 CONFIG_SYS_8xx_CPUCLK_MIN
306 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000307 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000308 See doc/README.MPC866
309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200310 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000311
wdenkba56f622004-02-06 23:19:44 +0000312 Define this to measure the actual CPU clock instead
313 of relying on the correctness of the configured
314 values. Mostly useful for board bringup to make sure
315 the PLL is locked at the intended frequency. Note
316 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200317 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000318
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100319- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200320 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100321
322 Defines the Monahans run mode to oscillator
323 ratio. Valid values are 8, 16, 24, 31. The core
324 frequency is this value multiplied by 13 MHz.
325
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200326 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200327
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100328 Defines the Monahans turbo mode to oscillator
329 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200330 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100331 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200332
wdenk5da627a2003-10-09 20:09:04 +0000333- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000334 CONFIG_CLOCKS_IN_MHZ
335
336 U-Boot stores all clock information in Hz
337 internally. For binary compatibility with older Linux
338 kernels (which expect the clocks passed in the
339 bd_info data to be in MHz) the environment variable
340 "clocks_in_mhz" can be defined so that U-Boot
341 converts clock data to MHZ before passing it to the
342 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000343 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100344 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000345 default environment.
346
wdenk5da627a2003-10-09 20:09:04 +0000347 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
348
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200349 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000350 expect it to be in bytes, others in MB.
351 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
352
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400353 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200354
355 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400356 passed using flattened device trees (based on open firmware
357 concepts).
358
359 CONFIG_OF_LIBFDT
360 * New libfdt-based support
361 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500362 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400363
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200364 OF_CPU - The proper name of the cpus node.
Kumar Galac2871f02006-01-11 13:59:02 -0600365 OF_SOC - The proper name of the soc node.
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200366 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600367 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200368
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200369 boards with QUICC Engines require OF_QE to set UCC MAC
370 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500371
Kumar Gala4e253132006-01-11 13:54:17 -0600372 CONFIG_OF_BOARD_SETUP
373
374 Board code has addition modification that it wants to make
375 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000376
Matthew McClintock02677682006-06-28 10:41:37 -0500377 CONFIG_OF_BOOT_CPU
378
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200379 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500380 param header, the default value is zero if undefined.
381
wdenk6705d812004-08-02 23:22:59 +0000382- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200383 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000384
385 Define this if you want support for Amba PrimeCell PL010 UARTs.
386
Andreas Engel48d01922008-09-08 14:30:53 +0200387 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000388
389 Define this if you want support for Amba PrimeCell PL011 UARTs.
390
391 CONFIG_PL011_CLOCK
392
393 If you have Amba PrimeCell PL011 UARTs, set this variable to
394 the clock speed of the UARTs.
395
396 CONFIG_PL01x_PORTS
397
398 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
399 define this to a list of base addresses for each (supported)
400 port. See e.g. include/configs/versatile.h
401
402
wdenkc6097192002-11-03 00:24:07 +0000403- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000404 Depending on board, define exactly one serial port
405 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
406 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
407 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000408
409 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
410 port routines must be defined elsewhere
411 (i.e. serial_init(), serial_getc(), ...)
412
413 CONFIG_CFB_CONSOLE
414 Enables console device for a color framebuffer. Needs following
415 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
416 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
417 (default big endian)
418 VIDEO_HW_RECTFILL graphic chip supports
419 rectangle fill
420 (cf. smiLynxEM)
421 VIDEO_HW_BITBLT graphic chip supports
422 bit-blit (cf. smiLynxEM)
423 VIDEO_VISIBLE_COLS visible pixel columns
424 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000425 VIDEO_VISIBLE_ROWS visible pixel rows
426 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000427 VIDEO_DATA_FORMAT graphic data format
428 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000429 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000430 VIDEO_KBD_INIT_FCT keyboard int fct
431 (i.e. i8042_kbd_init())
432 VIDEO_TSTC_FCT test char fct
433 (i.e. i8042_tstc)
434 VIDEO_GETC_FCT get char fct
435 (i.e. i8042_getc)
436 CONFIG_CONSOLE_CURSOR cursor drawing on/off
437 (requires blink timer
438 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200439 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000440 CONFIG_CONSOLE_TIME display time/date info in
441 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500442 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000443 CONFIG_VIDEO_LOGO display Linux logo in
444 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000445 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
446 linux_logo.h for logo.
447 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000448 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200449 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000450 the logo
451
wdenk43d96162003-03-06 00:02:04 +0000452 When CONFIG_CFB_CONSOLE is defined, video console is
453 default i/o. Serial console can be forced with
454 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000455
wdenkd4ca31c2004-01-02 14:00:00 +0000456 When CONFIG_SILENT_CONSOLE is defined, all console
457 messages (by U-Boot and Linux!) can be silenced with
458 the "silent" environment variable. See
459 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000460
wdenkc6097192002-11-03 00:24:07 +0000461- Console Baudrate:
462 CONFIG_BAUDRATE - in bps
463 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200464 CONFIG_SYS_BAUDRATE_TABLE, see below.
465 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000466
467- Interrupt driven serial port input:
468 CONFIG_SERIAL_SOFTWARE_FIFO
469
470 PPC405GP only.
471 Use an interrupt handler for receiving data on the
472 serial port. It also enables using hardware handshake
473 (RTS/CTS) and UART's built-in FIFO. Set the number of
474 bytes the interrupt driven input buffer should have.
475
wdenk109c0e32004-03-23 21:43:07 +0000476 Leave undefined to disable this feature, including
477 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000478
stroese1d49b1f2003-05-23 11:39:05 +0000479- Console UART Number:
480 CONFIG_UART1_CONSOLE
481
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200482 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000483 If defined internal UART1 (and not UART0) is used
484 as default U-Boot console.
485
wdenkc6097192002-11-03 00:24:07 +0000486- Boot Delay: CONFIG_BOOTDELAY - in seconds
487 Delay before automatically booting the default image;
488 set to -1 to disable autoboot.
489
490 See doc/README.autoboot for these options that
491 work with CONFIG_BOOTDELAY. None are required.
492 CONFIG_BOOT_RETRY_TIME
493 CONFIG_BOOT_RETRY_MIN
494 CONFIG_AUTOBOOT_KEYED
495 CONFIG_AUTOBOOT_PROMPT
496 CONFIG_AUTOBOOT_DELAY_STR
497 CONFIG_AUTOBOOT_STOP_STR
498 CONFIG_AUTOBOOT_DELAY_STR2
499 CONFIG_AUTOBOOT_STOP_STR2
500 CONFIG_ZERO_BOOTDELAY_CHECK
501 CONFIG_RESET_TO_RETRY
502
503- Autoboot Command:
504 CONFIG_BOOTCOMMAND
505 Only needed when CONFIG_BOOTDELAY is enabled;
506 define a command string that is automatically executed
507 when no character is read on the console interface
508 within "Boot Delay" after reset.
509
510 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000511 This can be used to pass arguments to the bootm
512 command. The value of CONFIG_BOOTARGS goes into the
513 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000514
515 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000516 The value of these goes into the environment as
517 "ramboot" and "nfsboot" respectively, and can be used
518 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200519 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000520
521- Pre-Boot Commands:
522 CONFIG_PREBOOT
523
524 When this option is #defined, the existence of the
525 environment variable "preboot" will be checked
526 immediately before starting the CONFIG_BOOTDELAY
527 countdown and/or running the auto-boot command resp.
528 entering interactive mode.
529
530 This feature is especially useful when "preboot" is
531 automatically generated or modified. For an example
532 see the LWMON board specific code: here "preboot" is
533 modified when the user holds down a certain
534 combination of keys on the (special) keyboard when
535 booting the systems
536
537- Serial Download Echo Mode:
538 CONFIG_LOADS_ECHO
539 If defined to 1, all characters received during a
540 serial download (using the "loads" command) are
541 echoed back. This might be needed by some terminal
542 emulations (like "cu"), but may as well just take
543 time on others. This setting #define's the initial
544 value of the "loads_echo" environment variable.
545
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500546- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000547 CONFIG_KGDB_BAUDRATE
548 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200549 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000550
551- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500552 Monitor commands can be included or excluded
553 from the build by using the #include files
554 "config_cmd_all.h" and #undef'ing unwanted
555 commands, or using "config_cmd_default.h"
556 and augmenting with additional #define's
557 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000558
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500559 The default command configuration includes all commands
560 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000561
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500562 CONFIG_CMD_ASKENV * ask for env variable
563 CONFIG_CMD_AUTOSCRIPT Autoscript Support
564 CONFIG_CMD_BDI bdinfo
565 CONFIG_CMD_BEDBUG * Include BedBug Debugger
566 CONFIG_CMD_BMP * BMP support
567 CONFIG_CMD_BSP * Board specific commands
568 CONFIG_CMD_BOOTD bootd
569 CONFIG_CMD_CACHE * icache, dcache
570 CONFIG_CMD_CONSOLE coninfo
571 CONFIG_CMD_DATE * support for RTC, date/time...
572 CONFIG_CMD_DHCP * DHCP support
573 CONFIG_CMD_DIAG * Diagnostics
574 CONFIG_CMD_DOC * Disk-On-Chip Support
575 CONFIG_CMD_DTT * Digital Therm and Thermostat
576 CONFIG_CMD_ECHO echo arguments
577 CONFIG_CMD_EEPROM * EEPROM read/write support
578 CONFIG_CMD_ELF * bootelf, bootvx
579 CONFIG_CMD_ENV saveenv
580 CONFIG_CMD_FDC * Floppy Disk Support
581 CONFIG_CMD_FAT * FAT partition support
582 CONFIG_CMD_FDOS * Dos diskette Support
583 CONFIG_CMD_FLASH flinfo, erase, protect
584 CONFIG_CMD_FPGA FPGA device initialization support
585 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
586 CONFIG_CMD_I2C * I2C serial bus support
587 CONFIG_CMD_IDE * IDE harddisk support
588 CONFIG_CMD_IMI iminfo
589 CONFIG_CMD_IMLS List all found images
590 CONFIG_CMD_IMMAP * IMMR dump support
591 CONFIG_CMD_IRQ * irqinfo
592 CONFIG_CMD_ITEST Integer/string test of 2 values
593 CONFIG_CMD_JFFS2 * JFFS2 Support
594 CONFIG_CMD_KGDB * kgdb
595 CONFIG_CMD_LOADB loadb
596 CONFIG_CMD_LOADS loads
597 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
598 loop, loopw, mtest
599 CONFIG_CMD_MISC Misc functions like sleep etc
600 CONFIG_CMD_MMC * MMC memory mapped support
601 CONFIG_CMD_MII * MII utility commands
602 CONFIG_CMD_NAND * NAND support
603 CONFIG_CMD_NET bootp, tftpboot, rarpboot
604 CONFIG_CMD_PCI * pciinfo
605 CONFIG_CMD_PCMCIA * PCMCIA support
606 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
607 host
608 CONFIG_CMD_PORTIO * Port I/O
609 CONFIG_CMD_REGINFO * Register dump
610 CONFIG_CMD_RUN run command in env variable
611 CONFIG_CMD_SAVES * save S record dump
612 CONFIG_CMD_SCSI * SCSI Support
613 CONFIG_CMD_SDRAM * print SDRAM configuration information
614 (requires CONFIG_CMD_I2C)
615 CONFIG_CMD_SETGETDCR Support for DCR Register access
616 (4xx only)
617 CONFIG_CMD_SPI * SPI serial bus support
618 CONFIG_CMD_USB * USB support
619 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500620 CONFIG_CMD_CDP * Cisco Discover Protocol support
621 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000622
wdenkc6097192002-11-03 00:24:07 +0000623
624 EXAMPLE: If you want all functions except of network
625 support you can write:
626
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500627 #include "config_cmd_all.h"
628 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000629
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400630 Other Commands:
631 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000632
633 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500634 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000635 what you (and your U-Boot users) are doing. Data
636 cache cannot be enabled on systems like the 8xx or
637 8260 (where accesses to the IMMR region must be
638 uncached), and it cannot be disabled on all other
639 systems where we (mis-) use the data cache to hold an
640 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000641
642
643 XXX - this list needs to get updated!
644
645- Watchdog:
646 CONFIG_WATCHDOG
647 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000648 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000649 code for a watchdog. For the 8xx and 8260 CPUs, the
650 SIU Watchdog feature is enabled in the SYPCR
651 register.
652
stroesec1551ea2003-04-04 15:53:41 +0000653- U-Boot Version:
654 CONFIG_VERSION_VARIABLE
655 If this variable is defined, an environment variable
656 named "ver" is created by U-Boot showing the U-Boot
657 version as printed by the "version" command.
658 This variable is readonly.
659
wdenkc6097192002-11-03 00:24:07 +0000660- Real-Time Clock:
661
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500662 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000663 has to be selected, too. Define exactly one of the
664 following options:
665
666 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
667 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200668 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000669 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000670 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000671 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000672 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000673 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100674 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000675 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200676 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000677
wdenkb37c7e52003-06-30 16:24:52 +0000678 Note that if the RTC uses I2C, then the I2C interface
679 must also be configured. See I2C Support, below.
680
wdenkc6097192002-11-03 00:24:07 +0000681- Timestamp Support:
682
wdenk43d96162003-03-06 00:02:04 +0000683 When CONFIG_TIMESTAMP is selected, the timestamp
684 (date and time) of an image is printed by image
685 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500686 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000687
688- Partition Support:
689 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400690 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000691
Wolfgang Denk218ca722008-03-26 10:40:12 +0100692 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
693 CONFIG_CMD_SCSI) you must configure support for at
694 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000695
696- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000697 CONFIG_IDE_RESET_ROUTINE - this is defined in several
698 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000699
wdenk4d13cba2004-03-14 14:09:05 +0000700 CONFIG_IDE_RESET - is this is defined, IDE Reset will
701 be performed by calling the function
702 ide_set_reset(int reset)
703 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000704
705- ATAPI Support:
706 CONFIG_ATAPI
707
708 Set this to enable ATAPI support.
709
wdenkc40b2952004-03-13 23:29:43 +0000710- LBA48 Support
711 CONFIG_LBA48
712
713 Set this to enable support for disks larger than 137GB
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200714 Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
wdenkc40b2952004-03-13 23:29:43 +0000715 Whithout these , LBA48 support uses 32bit variables and will 'only'
716 support disks up to 2.1TB.
717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200718 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000719 When enabled, makes the IDE subsystem use 64bit sector addresses.
720 Default is 32bit.
721
wdenkc6097192002-11-03 00:24:07 +0000722- SCSI Support:
723 At the moment only there is only support for the
724 SYM53C8XX SCSI controller; define
725 CONFIG_SCSI_SYM53C8XX to enable it.
726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200727 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
728 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
729 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000730 maximum numbers of LUNs, SCSI ID's and target
731 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200732 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000733
734- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000735 CONFIG_E1000
736 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000737
Andre Schwarzac3315c2008-03-06 16:45:44 +0100738 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200739 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100740
wdenkc6097192002-11-03 00:24:07 +0000741 CONFIG_EEPRO100
742 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200743 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000744 write routine for first time initialisation.
745
746 CONFIG_TULIP
747 Support for Digital 2114x chips.
748 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
749 modem chip initialisation (KS8761/QS6611).
750
751 CONFIG_NATSEMI
752 Support for National dp83815 chips.
753
754 CONFIG_NS8382X
755 Support for National dp8382[01] gigabit chips.
756
wdenk45219c42003-05-12 21:50:16 +0000757- NETWORK Support (other):
758
759 CONFIG_DRIVER_LAN91C96
760 Support for SMSC's LAN91C96 chips.
761
762 CONFIG_LAN91C96_BASE
763 Define this to hold the physical address
764 of the LAN91C96's I/O space
765
766 CONFIG_LAN91C96_USE_32_BIT
767 Define this to enable 32 bit addressing
768
wdenkf39748a2004-06-09 13:37:52 +0000769 CONFIG_DRIVER_SMC91111
770 Support for SMSC's LAN91C111 chip
771
772 CONFIG_SMC91111_BASE
773 Define this to hold the physical address
774 of the device (I/O space)
775
776 CONFIG_SMC_USE_32_BIT
777 Define this if data bus is 32 bits
778
779 CONFIG_SMC_USE_IOFUNCS
780 Define this to use i/o functions instead of macros
781 (some hardware wont work with macros)
782
Jens Gehrlein557b3772008-05-05 14:06:11 +0200783 CONFIG_DRIVER_SMC911X
784 Support for SMSC's LAN911x and LAN921x chips
785
786 CONFIG_DRIVER_SMC911X_BASE
787 Define this to hold the physical address
788 of the device (I/O space)
789
790 CONFIG_DRIVER_SMC911X_32_BIT
791 Define this if data bus is 32 bits
792
793 CONFIG_DRIVER_SMC911X_16_BIT
794 Define this if data bus is 16 bits. If your processor
795 automatically converts one 32 bit word to two 16 bit
796 words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
797
wdenkc6097192002-11-03 00:24:07 +0000798- USB Support:
799 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000800 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000801 CONFIG_USB_UHCI to enable it.
802 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000803 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000804 storage devices.
805 Note:
806 Supported are USB Keyboards and USB Floppy drives
807 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000808 MPC5200 USB requires additional defines:
809 CONFIG_USB_CLOCK
810 for 528 MHz Clock: 0x0001bbbb
811 CONFIG_USB_CONFIG
812 for differential drivers: 0x00001000
813 for single ended drivers: 0x00005000
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200814 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200815 May be defined to allow interrupt polling
816 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000817
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200818- USB Device:
819 Define the below if you wish to use the USB console.
820 Once firmware is rebuilt from a serial console issue the
821 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200822 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200823 it has found a new device. The environment variable usbtty
824 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200825 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200826 Common Device Class Abstract Control Model serial device.
827 If you select usbtty = gserial you should be able to enumerate
828 a Linux host by
829 # modprobe usbserial vendor=0xVendorID product=0xProductID
830 else if using cdc_acm, simply setting the environment
831 variable usbtty to be cdc_acm should suffice. The following
832 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200833
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200834 CONFIG_USB_DEVICE
835 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000836
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200837 CONFIG_USB_TTY
838 Define this to have a tty type of device available to
839 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200841 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200842 Define this if you want stdin, stdout &/or stderr to
843 be set to usbtty.
844
845 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200846 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200847 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200848 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200849
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200850 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200851 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200852 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200853
Wolfgang Denk386eda02006-06-14 18:14:56 +0200854 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200855 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200856 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200857 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
858 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
859 should pretend to be a Linux device to it's target host.
860
861 CONFIG_USBD_MANUFACTURER
862 Define this string as the name of your company for
863 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200864
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200865 CONFIG_USBD_PRODUCT_NAME
866 Define this string as the name of your product
867 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
868
869 CONFIG_USBD_VENDORID
870 Define this as your assigned Vendor ID from the USB
871 Implementors Forum. This *must* be a genuine Vendor ID
872 to avoid polluting the USB namespace.
873 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200874
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200875 CONFIG_USBD_PRODUCTID
876 Define this as the unique Product ID
877 for your device
878 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000879
880
881- MMC Support:
882 The MMC controller on the Intel PXA is supported. To
883 enable this define CONFIG_MMC. The MMC can be
884 accessed from the boot prompt by mapping the device
885 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500886 enabled with CONFIG_CMD_MMC. The MMC driver also works with
887 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000888
wdenk6705d812004-08-02 23:22:59 +0000889- Journaling Flash filesystem support:
890 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
891 CONFIG_JFFS2_NAND_DEV
892 Define these for a default partition on a NAND device
893
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200894 CONFIG_SYS_JFFS2_FIRST_SECTOR,
895 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +0000896 Define these for a default partition on a NOR device
897
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200898 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +0000899 Define this to create an own partition. You have to provide a
900 function struct part_info* jffs2_part_info(int part_num)
901
902 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200903 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +0000904 to disable the command chpart. This is the default when you
905 have not defined a custom partition
906
wdenkc6097192002-11-03 00:24:07 +0000907- Keyboard Support:
908 CONFIG_ISA_KEYBOARD
909
910 Define this to enable standard (PC-Style) keyboard
911 support
912
913 CONFIG_I8042_KBD
914 Standard PC keyboard driver with US (is default) and
915 GERMAN key layout (switch via environment 'keymap=de') support.
916 Export function i8042_kbd_init, i8042_tstc and i8042_getc
917 for cfb_console. Supports cursor blinking.
918
919- Video support:
920 CONFIG_VIDEO
921
922 Define this to enable video support (for output to
923 video).
924
925 CONFIG_VIDEO_CT69000
926
927 Enable Chips & Technologies 69000 Video chip
928
929 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000930 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000931 video output is selected via environment 'videoout'
932 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
933 assumed.
wdenkc6097192002-11-03 00:24:07 +0000934
wdenkb79a11c2004-03-25 15:14:43 +0000935 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200936 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +0000937 are possible:
938 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000939 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000940
941 Colors 640x480 800x600 1024x768 1152x864 1280x1024
942 -------------+---------------------------------------------
943 8 bits | 0x301* 0x303 0x305 0x161 0x307
944 15 bits | 0x310 0x313 0x316 0x162 0x319
945 16 bits | 0x311 0x314 0x317 0x163 0x31A
946 24 bits | 0x312 0x315 0x318 ? 0x31B
947 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000948 (i.e. setenv videomode 317; saveenv; reset;)
949
wdenkb79a11c2004-03-25 15:14:43 +0000950 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +0100951 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +0000952
953
stroesec1551ea2003-04-04 15:53:41 +0000954 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +0000955 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +0000956 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
957 or CONFIG_VIDEO_SED13806_16BPP
958
wdenk682011f2003-06-03 23:54:09 +0000959- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +0000960 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +0000961
wdenk8bde7f72003-06-27 21:31:46 +0000962 Define this to enable a custom keyboard support.
963 This simply calls drv_keyboard_init() which must be
964 defined in your board-specific files.
965 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +0000966
wdenkc6097192002-11-03 00:24:07 +0000967- LCD Support: CONFIG_LCD
968
969 Define this to enable LCD support (for output to LCD
970 display); also select one of the supported displays
971 by defining one of these:
972
Stelian Pop39cf4802008-05-09 21:57:18 +0200973 CONFIG_ATMEL_LCD:
974
975 HITACHI TX09D70VM1CCA, 3.5", 240x320.
976
wdenkfd3103b2003-11-25 16:55:19 +0000977 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000978
wdenkfd3103b2003-11-25 16:55:19 +0000979 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000980
wdenkfd3103b2003-11-25 16:55:19 +0000981 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +0000982
wdenkfd3103b2003-11-25 16:55:19 +0000983 NEC NL6448BC20-08. 6.5", 640x480.
984 Active, color, single scan.
985
986 CONFIG_NEC_NL6448BC33_54
987
988 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000989 Active, color, single scan.
990
991 CONFIG_SHARP_16x9
992
993 Sharp 320x240. Active, color, single scan.
994 It isn't 16x9, and I am not sure what it is.
995
996 CONFIG_SHARP_LQ64D341
997
998 Sharp LQ64D341 display, 640x480.
999 Active, color, single scan.
1000
1001 CONFIG_HLD1045
1002
1003 HLD1045 display, 640x480.
1004 Active, color, single scan.
1005
1006 CONFIG_OPTREX_BW
1007
1008 Optrex CBL50840-2 NF-FW 99 22 M5
1009 or
1010 Hitachi LMG6912RPFC-00T
1011 or
1012 Hitachi SP14Q002
1013
1014 320x240. Black & white.
1015
1016 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001017 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001018
wdenk7152b1d2003-09-05 23:19:14 +00001019- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001020
wdenk8bde7f72003-06-27 21:31:46 +00001021 If this option is set, the environment is checked for
1022 a variable "splashimage". If found, the usual display
1023 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001024 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001025 specified in "splashimage" is loaded instead. The
1026 console is redirected to the "nulldev", too. This
1027 allows for a "silent" boot where a splash screen is
1028 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001029
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001030- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1031
1032 If this option is set, additionally to standard BMP
1033 images, gzipped BMP images can be displayed via the
1034 splashscreen support or the bmp command.
1035
wdenkc29fdfc2003-08-29 20:57:53 +00001036- Compression support:
1037 CONFIG_BZIP2
1038
1039 If this option is set, support for bzip2 compressed
1040 images is included. If not, only uncompressed and gzip
1041 compressed images are supported.
1042
wdenk42d1f032003-10-15 23:53:47 +00001043 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001044 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001045 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001046
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001047 CONFIG_LZMA
1048
1049 If this option is set, support for lzma compressed
1050 images is included.
1051
1052 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1053 requires an amount of dynamic memory that is given by the
1054 formula:
1055
1056 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1057
1058 Where lc and lp stand for, respectively, Literal context bits
1059 and Literal pos bits.
1060
1061 This value is upper-bounded by 14MB in the worst case. Anyway,
1062 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1063 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1064 a very small buffer.
1065
1066 Use the lzmainfo tool to determinate the lc and lp values and
1067 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001068 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001069
wdenk17ea1172004-06-06 21:51:03 +00001070- MII/PHY support:
1071 CONFIG_PHY_ADDR
1072
1073 The address of PHY on MII bus.
1074
1075 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1076
1077 The clock frequency of the MII bus
1078
1079 CONFIG_PHY_GIGE
1080
1081 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001082 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001083
1084 CONFIG_PHY_RESET_DELAY
1085
1086 Some PHY like Intel LXT971A need extra delay after
1087 reset before any MII register access is possible.
1088 For such PHY, set this option to the usec delay
1089 required. (minimum 300usec for LXT971A)
1090
1091 CONFIG_PHY_CMD_DELAY (ppc4xx)
1092
1093 Some PHY like Intel LXT971A need extra delay after
1094 command issued before MII status register can be read
1095
wdenkc6097192002-11-03 00:24:07 +00001096- Ethernet address:
1097 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001098 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001099 CONFIG_ETH2ADDR
1100 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001101 CONFIG_ETH4ADDR
1102 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001103
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001104 Define a default value for Ethernet address to use
1105 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001106 is not determined automatically.
1107
1108- IP address:
1109 CONFIG_IPADDR
1110
1111 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001112 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001113 determined through e.g. bootp.
1114
1115- Server IP address:
1116 CONFIG_SERVERIP
1117
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001118 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001119 server to contact when using the "tftboot" command.
1120
David Updegraff53a5c422007-06-11 10:41:07 -05001121- Multicast TFTP Mode:
1122 CONFIG_MCAST_TFTP
1123
1124 Defines whether you want to support multicast TFTP as per
1125 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001126 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001127 driver in use must provide a function: mcast() to join/leave a
1128 multicast group.
1129
1130 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001131- BOOTP Recovery Mode:
1132 CONFIG_BOOTP_RANDOM_DELAY
1133
1134 If you have many targets in a network that try to
1135 boot using BOOTP, you may want to avoid that all
1136 systems send out BOOTP requests at precisely the same
1137 moment (which would happen for instance at recovery
1138 from a power failure, when all systems will try to
1139 boot, thus flooding the BOOTP server. Defining
1140 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1141 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001142 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001143
1144 1st BOOTP request: delay 0 ... 1 sec
1145 2nd BOOTP request: delay 0 ... 2 sec
1146 3rd BOOTP request: delay 0 ... 4 sec
1147 4th and following
1148 BOOTP requests: delay 0 ... 8 sec
1149
stroesefe389a82003-08-28 14:17:32 +00001150- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001151 You can fine tune the DHCP functionality by defining
1152 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001153
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001154 CONFIG_BOOTP_SUBNETMASK
1155 CONFIG_BOOTP_GATEWAY
1156 CONFIG_BOOTP_HOSTNAME
1157 CONFIG_BOOTP_NISDOMAIN
1158 CONFIG_BOOTP_BOOTPATH
1159 CONFIG_BOOTP_BOOTFILESIZE
1160 CONFIG_BOOTP_DNS
1161 CONFIG_BOOTP_DNS2
1162 CONFIG_BOOTP_SEND_HOSTNAME
1163 CONFIG_BOOTP_NTPSERVER
1164 CONFIG_BOOTP_TIMEOFFSET
1165 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001166
Wilson Callan5d110f02007-07-28 10:56:13 -04001167 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1168 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001169
1170 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1171 serverip from a DHCP server, it is possible that more
1172 than one DNS serverip is offered to the client.
1173 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1174 serverip will be stored in the additional environment
1175 variable "dnsip2". The first DNS serverip is always
1176 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001177 is defined.
stroesefe389a82003-08-28 14:17:32 +00001178
1179 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1180 to do a dynamic update of a DNS server. To do this, they
1181 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001182 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001183 of the "hostname" environment variable is passed as
1184 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001185
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001186 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1187
1188 A 32bit value in microseconds for a delay between
1189 receiving a "DHCP Offer" and sending the "DHCP Request".
1190 This fixes a problem with certain DHCP servers that don't
1191 respond 100% of the time to a "DHCP request". E.g. On an
1192 AT91RM9200 processor running at 180MHz, this delay needed
1193 to be *at least* 15,000 usec before a Windows Server 2003
1194 DHCP server would reply 100% of the time. I recommend at
1195 least 50,000 usec to be safe. The alternative is to hope
1196 that one of the retries will be successful but note that
1197 the DHCP timeout and retry process takes a longer than
1198 this delay.
1199
wdenka3d991b2004-04-15 21:48:45 +00001200 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001201 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001202
1203 The device id used in CDP trigger frames.
1204
1205 CONFIG_CDP_DEVICE_ID_PREFIX
1206
1207 A two character string which is prefixed to the MAC address
1208 of the device.
1209
1210 CONFIG_CDP_PORT_ID
1211
1212 A printf format string which contains the ascii name of
1213 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001214 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001215
1216 CONFIG_CDP_CAPABILITIES
1217
1218 A 32bit integer which indicates the device capabilities;
1219 0x00000010 for a normal host which does not forwards.
1220
1221 CONFIG_CDP_VERSION
1222
1223 An ascii string containing the version of the software.
1224
1225 CONFIG_CDP_PLATFORM
1226
1227 An ascii string containing the name of the platform.
1228
1229 CONFIG_CDP_TRIGGER
1230
1231 A 32bit integer sent on the trigger.
1232
1233 CONFIG_CDP_POWER_CONSUMPTION
1234
1235 A 16bit integer containing the power consumption of the
1236 device in .1 of milliwatts.
1237
1238 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1239
1240 A byte containing the id of the VLAN.
1241
wdenkc6097192002-11-03 00:24:07 +00001242- Status LED: CONFIG_STATUS_LED
1243
1244 Several configurations allow to display the current
1245 status using a LED. For instance, the LED will blink
1246 fast while running U-Boot code, stop blinking as
1247 soon as a reply to a BOOTP request was received, and
1248 start blinking slow once the Linux kernel is running
1249 (supported by a status LED driver in the Linux
1250 kernel). Defining CONFIG_STATUS_LED enables this
1251 feature in U-Boot.
1252
1253- CAN Support: CONFIG_CAN_DRIVER
1254
1255 Defining CONFIG_CAN_DRIVER enables CAN driver support
1256 on those systems that support this (optional)
1257 feature, like the TQM8xxL modules.
1258
1259- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1260
wdenkb37c7e52003-06-30 16:24:52 +00001261 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001262 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001263 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001264
wdenk945af8d2003-07-16 21:53:01 +00001265 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001266 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001267 CONFIG_COMMANDS) and communicate with i2c based realtime
1268 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001269 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001270
Ben Warrenbb99ad62006-09-07 16:50:54 -04001271 CONFIG_I2C_CMD_TREE is a recommended option that places
1272 all I2C commands under a single 'i2c' root command. The
1273 older 'imm', 'imd', 'iprobe' etc. commands are considered
1274 deprecated and may disappear in the future.
1275
1276 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001277
wdenk945af8d2003-07-16 21:53:01 +00001278 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001279 bit-banging) driver instead of CPM or similar hardware
1280 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001281
wdenk945af8d2003-07-16 21:53:01 +00001282 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001283 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001284
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001285 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001286 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001287 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001288 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001289
wdenkb37c7e52003-06-30 16:24:52 +00001290 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001291 sets the CPU up as a master node and so its address should
wdenkb37c7e52003-06-30 16:24:52 +00001292 therefore be cleared to 0 (See, eg, MPC823e User's Manual
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001293 p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001294
wdenk945af8d2003-07-16 21:53:01 +00001295 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001296
1297 If you use the software i2c interface (CONFIG_SOFT_I2C)
1298 then the following macros need to be defined (examples are
1299 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001300
1301 I2C_INIT
1302
wdenkb37c7e52003-06-30 16:24:52 +00001303 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001304 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001305
wdenkba56f622004-02-06 23:19:44 +00001306 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001307
wdenkc6097192002-11-03 00:24:07 +00001308 I2C_PORT
1309
wdenk43d96162003-03-06 00:02:04 +00001310 (Only for MPC8260 CPU). The I/O port to use (the code
1311 assumes both bits are on the same port). Valid values
1312 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001313
1314 I2C_ACTIVE
1315
1316 The code necessary to make the I2C data line active
1317 (driven). If the data line is open collector, this
1318 define can be null.
1319
wdenkb37c7e52003-06-30 16:24:52 +00001320 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1321
wdenkc6097192002-11-03 00:24:07 +00001322 I2C_TRISTATE
1323
1324 The code necessary to make the I2C data line tri-stated
1325 (inactive). If the data line is open collector, this
1326 define can be null.
1327
wdenkb37c7e52003-06-30 16:24:52 +00001328 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1329
wdenkc6097192002-11-03 00:24:07 +00001330 I2C_READ
1331
1332 Code that returns TRUE if the I2C data line is high,
1333 FALSE if it is low.
1334
wdenkb37c7e52003-06-30 16:24:52 +00001335 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1336
wdenkc6097192002-11-03 00:24:07 +00001337 I2C_SDA(bit)
1338
1339 If <bit> is TRUE, sets the I2C data line high. If it
1340 is FALSE, it clears it (low).
1341
wdenkb37c7e52003-06-30 16:24:52 +00001342 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001343 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001344 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001345
wdenkc6097192002-11-03 00:24:07 +00001346 I2C_SCL(bit)
1347
1348 If <bit> is TRUE, sets the I2C clock line high. If it
1349 is FALSE, it clears it (low).
1350
wdenkb37c7e52003-06-30 16:24:52 +00001351 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001352 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001353 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001354
wdenkc6097192002-11-03 00:24:07 +00001355 I2C_DELAY
1356
1357 This delay is invoked four times per clock cycle so this
1358 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001359 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001360 like:
1361
wdenkb37c7e52003-06-30 16:24:52 +00001362 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001363
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001364 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001365
wdenk8bde7f72003-06-27 21:31:46 +00001366 When a board is reset during an i2c bus transfer
1367 chips might think that the current transfer is still
1368 in progress. On some boards it is possible to access
1369 the i2c SCLK line directly, either by using the
1370 processor pin as a GPIO or by having a second pin
1371 connected to the bus. If this option is defined a
1372 custom i2c_init_board() routine in boards/xxx/board.c
1373 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001374
wdenk17ea1172004-06-06 21:51:03 +00001375 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1376
1377 This option enables configuration of bi_iic_fast[] flags
1378 in u-boot bd_info structure based on u-boot environment
1379 variable "i2cfast". (see also i2cfast)
1380
Ben Warrenbb99ad62006-09-07 16:50:54 -04001381 CONFIG_I2C_MULTI_BUS
1382
1383 This option allows the use of multiple I2C buses, each of which
1384 must have a controller. At any point in time, only one bus is
1385 active. To switch to a different bus, use the 'i2c dev' command.
1386 Note that bus numbering is zero-based.
1387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001388 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001389
1390 This option specifies a list of I2C devices that will be skipped
1391 when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1392 command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
Wolfgang Denk218ca722008-03-26 10:40:12 +01001393 pairs. Otherwise, specify a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001394
1395 e.g.
1396 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001397 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001398
1399 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1400
1401 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001402 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001403
1404 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1405
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001406 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001407
1408 If defined, then this indicates the I2C bus number for DDR SPD.
1409 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1410
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001411 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001412
1413 If defined, then this indicates the I2C bus number for the RTC.
1414 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1415
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001416 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001417
1418 If defined, then this indicates the I2C bus number for the DTT.
1419 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1420
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001421 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001422
1423 If defined, specifies the I2C address of the DTT device.
1424 If not defined, then U-Boot uses predefined value for
1425 specified DTT device.
1426
Timur Tabibe5e6182006-11-03 19:15:00 -06001427 CONFIG_FSL_I2C
1428
1429 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001430 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001431
Heiko Schocher67b23a32008-10-15 09:39:47 +02001432 CONFIG_I2C_MUX
1433
1434 Define this option if you have I2C devices reached over 1 .. n
1435 I2C Muxes like the pca9544a. This option addes a new I2C
1436 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1437 new I2C Bus to the existing I2C Busses. If you select the
1438 new Bus with "i2c dev", u-bbot sends first the commandos for
1439 the muxes to activate this new "bus".
1440
1441 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1442 feature!
1443
1444 Example:
1445 Adding a new I2C Bus reached over 2 pca9544a muxes
1446 The First mux with address 70 and channel 6
1447 The Second mux with address 71 and channel 4
1448
1449 => i2c bus pca9544a:70:6:pca9544a:71:4
1450
1451 Use the "i2c bus" command without parameter, to get a list
1452 of I2C Busses with muxes:
1453
1454 => i2c bus
1455 Busses reached over muxes:
1456 Bus ID: 2
1457 reached over Mux(es):
1458 pca9544a@70 ch: 4
1459 Bus ID: 3
1460 reached over Mux(es):
1461 pca9544a@70 ch: 6
1462 pca9544a@71 ch: 4
1463 =>
1464
1465 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1466 u-boot sends First the Commando to the mux@70 to enable
1467 channel 6, and then the Commando to the mux@71 to enable
1468 the channel 4.
1469
1470 After that, you can use the "normal" i2c commands as
1471 usual, to communicate with your I2C devices behind
1472 the 2 muxes.
1473
1474 This option is actually implemented for the bitbanging
1475 algorithm in common/soft_i2c.c and for the Hardware I2C
1476 Bus on the MPC8260. But it should be not so difficult
1477 to add this option to other architectures.
1478
Timur Tabibe5e6182006-11-03 19:15:00 -06001479
wdenkc6097192002-11-03 00:24:07 +00001480- SPI Support: CONFIG_SPI
1481
1482 Enables SPI driver (so far only tested with
1483 SPI EEPROM, also an instance works with Crystal A/D and
1484 D/As on the SACSng board)
1485
1486 CONFIG_SPI_X
1487
1488 Enables extended (16-bit) SPI EEPROM addressing.
1489 (symmetrical to CONFIG_I2C_X)
1490
1491 CONFIG_SOFT_SPI
1492
wdenk43d96162003-03-06 00:02:04 +00001493 Enables a software (bit-bang) SPI driver rather than
1494 using hardware support. This is a general purpose
1495 driver that only requires three general I/O port pins
1496 (two outputs, one input) to function. If this is
1497 defined, the board configuration must define several
1498 SPI configuration items (port pins to use, etc). For
1499 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001500
Ben Warren04a9e112008-01-16 22:37:35 -05001501 CONFIG_HARD_SPI
1502
1503 Enables a hardware SPI driver for general-purpose reads
1504 and writes. As with CONFIG_SOFT_SPI, the board configuration
1505 must define a list of chip-select function pointers.
1506 Currently supported on some MPC8xxx processors. For an
1507 example, see include/configs/mpc8349emds.h.
1508
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001509 CONFIG_MXC_SPI
1510
1511 Enables the driver for the SPI controllers on i.MX and MXC
1512 SoCs. Currently only i.MX31 is supported.
1513
Matthias Fuchs01335022007-12-27 17:12:34 +01001514- FPGA Support: CONFIG_FPGA
1515
1516 Enables FPGA subsystem.
1517
1518 CONFIG_FPGA_<vendor>
1519
1520 Enables support for specific chip vendors.
1521 (ALTERA, XILINX)
1522
1523 CONFIG_FPGA_<family>
1524
1525 Enables support for FPGA family.
1526 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1527
1528 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001529
wdenk43d96162003-03-06 00:02:04 +00001530 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001531
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001532 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001533
wdenk8bde7f72003-06-27 21:31:46 +00001534 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001535
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001536 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001537
wdenk43d96162003-03-06 00:02:04 +00001538 Enable checks on FPGA configuration interface busy
1539 status by the configuration function. This option
1540 will require a board or device specific function to
1541 be written.
wdenkc6097192002-11-03 00:24:07 +00001542
1543 CONFIG_FPGA_DELAY
1544
1545 If defined, a function that provides delays in the FPGA
1546 configuration driver.
1547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001548 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001549 Allow Control-C to interrupt FPGA configuration
1550
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001551 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001552
wdenk43d96162003-03-06 00:02:04 +00001553 Check for configuration errors during FPGA bitfile
1554 loading. For example, abort during Virtex II
1555 configuration if the INIT_B line goes low (which
1556 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001558 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001559
wdenk43d96162003-03-06 00:02:04 +00001560 Maximum time to wait for the INIT_B line to deassert
1561 after PROB_B has been deasserted during a Virtex II
1562 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001563 ms.
wdenkc6097192002-11-03 00:24:07 +00001564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001565 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001566
wdenk43d96162003-03-06 00:02:04 +00001567 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001568 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001569
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001570 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001571
wdenk43d96162003-03-06 00:02:04 +00001572 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001573 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001574
1575- Configuration Management:
1576 CONFIG_IDENT_STRING
1577
wdenk43d96162003-03-06 00:02:04 +00001578 If defined, this string will be added to the U-Boot
1579 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001580
1581- Vendor Parameter Protection:
1582
wdenk43d96162003-03-06 00:02:04 +00001583 U-Boot considers the values of the environment
1584 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001585 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001586 are set once by the board vendor / manufacturer, and
1587 protects these variables from casual modification by
1588 the user. Once set, these variables are read-only,
1589 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001590 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001591
1592 If CONFIG_ENV_OVERWRITE is #defined in your config
1593 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001594 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001595 these parameters.
1596
1597 Alternatively, if you #define _both_ CONFIG_ETHADDR
1598 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001599 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001600 which can be changed exactly ONCE by the user. [The
1601 serial# is unaffected by this, i. e. it remains
1602 read-only.]
1603
1604- Protected RAM:
1605 CONFIG_PRAM
1606
1607 Define this variable to enable the reservation of
1608 "protected RAM", i. e. RAM which is not overwritten
1609 by U-Boot. Define CONFIG_PRAM to hold the number of
1610 kB you want to reserve for pRAM. You can overwrite
1611 this default value by defining an environment
1612 variable "pram" to the number of kB you want to
1613 reserve. Note that the board info structure will
1614 still show the full amount of RAM. If pRAM is
1615 reserved, a new environment variable "mem" will
1616 automatically be defined to hold the amount of
1617 remaining RAM in a form that can be passed as boot
1618 argument to Linux, for instance like that:
1619
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001620 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001621 saveenv
1622
1623 This way you can tell Linux not to use this memory,
1624 either, which results in a memory region that will
1625 not be affected by reboots.
1626
1627 *WARNING* If your board configuration uses automatic
1628 detection of the RAM size, you must make sure that
1629 this memory test is non-destructive. So far, the
1630 following board configurations are known to be
1631 "pRAM-clean":
1632
1633 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1634 HERMES, IP860, RPXlite, LWMON, LANTEC,
1635 PCU_E, FLAGADM, TQM8260
1636
1637- Error Recovery:
1638 CONFIG_PANIC_HANG
1639
1640 Define this variable to stop the system in case of a
1641 fatal error, so that you have to reset it manually.
1642 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001643 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001644 automatically as fast as possible, but it may be
1645 useful during development since you can try to debug
1646 the conditions that lead to the situation.
1647
1648 CONFIG_NET_RETRY_COUNT
1649
wdenk43d96162003-03-06 00:02:04 +00001650 This variable defines the number of retries for
1651 network operations like ARP, RARP, TFTP, or BOOTP
1652 before giving up the operation. If not defined, a
1653 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001654
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001655 CONFIG_ARP_TIMEOUT
1656
1657 Timeout waiting for an ARP reply in milliseconds.
1658
wdenkc6097192002-11-03 00:24:07 +00001659- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001660 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001661
1662 Enable auto completion of commands using TAB.
1663
Wolfgang Denka9398e02006-11-27 15:32:42 +01001664 Note that this feature has NOT been implemented yet
1665 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001666
1667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001668 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001669
1670 Define this variable to enable the "hush" shell (from
1671 Busybox) as command line interpreter, thus enabling
1672 powerful command line syntax like
1673 if...then...else...fi conditionals or `&&' and '||'
1674 constructs ("shell scripts").
1675
1676 If undefined, you get the old, much simpler behaviour
1677 with a somewhat smaller memory footprint.
1678
1679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001680 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001681
1682 This defines the secondary prompt string, which is
1683 printed when the command interpreter needs more input
1684 to complete a command. Usually "> ".
1685
1686 Note:
1687
wdenk8bde7f72003-06-27 21:31:46 +00001688 In the current implementation, the local variables
1689 space and global environment variables space are
1690 separated. Local variables are those you define by
1691 simply typing `name=value'. To access a local
1692 variable later on, you have write `$name' or
1693 `${name}'; to execute the contents of a variable
1694 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001695
wdenk43d96162003-03-06 00:02:04 +00001696 Global environment variables are those you use
1697 setenv/printenv to work with. To run a command stored
1698 in such a variable, you need to use the run command,
1699 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001700
1701 To store commands and special characters in a
1702 variable, please use double quotation marks
1703 surrounding the whole text of the variable, instead
1704 of the backslashes before semicolons and special
1705 symbols.
1706
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001707- Commandline Editing and History:
1708 CONFIG_CMDLINE_EDITING
1709
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001710 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001711 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001712
wdenka8c7c702003-12-06 19:49:23 +00001713- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001714 CONFIG_EXTRA_ENV_SETTINGS
1715
wdenk43d96162003-03-06 00:02:04 +00001716 Define this to contain any number of null terminated
1717 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001718 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001719
wdenk43d96162003-03-06 00:02:04 +00001720 For example, place something like this in your
1721 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001722
1723 #define CONFIG_EXTRA_ENV_SETTINGS \
1724 "myvar1=value1\0" \
1725 "myvar2=value2\0"
1726
wdenk43d96162003-03-06 00:02:04 +00001727 Warning: This method is based on knowledge about the
1728 internal format how the environment is stored by the
1729 U-Boot code. This is NOT an official, exported
1730 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001731 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001732 You better know what you are doing here.
1733
wdenk43d96162003-03-06 00:02:04 +00001734 Note: overly (ab)use of the default environment is
1735 discouraged. Make sure to check other ways to preset
1736 the environment like the autoscript function or the
1737 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001738
wdenka8c7c702003-12-06 19:49:23 +00001739- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001740 CONFIG_HAS_DATAFLASH
1741
wdenk8bde7f72003-06-27 21:31:46 +00001742 Defining this option enables DataFlash features and
1743 allows to read/write in Dataflash via the standard
1744 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001745
wdenk3f85ce22004-02-23 16:11:30 +00001746- SystemACE Support:
1747 CONFIG_SYSTEMACE
1748
1749 Adding this option adds support for Xilinx SystemACE
1750 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001751 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001752 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001753
1754 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001755 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001756
1757 When SystemACE support is added, the "ace" device type
1758 becomes available to the fat commands, i.e. fatls.
1759
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001760- TFTP Fixed UDP Port:
1761 CONFIG_TFTP_PORT
1762
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001763 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001764 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001765 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001766 number generator is used.
1767
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001768 Also, the environment variable tftpdstp is used to supply
1769 the TFTP UDP destination port value. If tftpdstp isn't
1770 defined, the normal port 69 is used.
1771
1772 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001773 blindly start the TFTP transfer using the pre-configured
1774 target IP address and UDP port. This has the effect of
1775 "punching through" the (Windows XP) firewall, allowing
1776 the remainder of the TFTP transfer to proceed normally.
1777 A better solution is to properly configure the firewall,
1778 but sometimes that is not allowed.
1779
wdenka8c7c702003-12-06 19:49:23 +00001780- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001781 CONFIG_SHOW_BOOT_PROGRESS
1782
wdenk43d96162003-03-06 00:02:04 +00001783 Defining this option allows to add some board-
1784 specific code (calling a user-provided function
1785 "show_boot_progress(int)") that enables you to show
1786 the system's boot progress on some display (for
1787 example, some LED's) on your board. At the moment,
1788 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001789
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02001790- Automatic software updates via TFTP server
1791 CONFIG_UPDATE_TFTP
1792 CONFIG_UPDATE_TFTP_CNT_MAX
1793 CONFIG_UPDATE_TFTP_MSEC_MAX
1794
1795 These options enable and control the auto-update feature;
1796 for a more detailed description refer to doc/README.update.
1797
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001798Legacy uImage format:
1799
wdenkc6097192002-11-03 00:24:07 +00001800 Arg Where When
1801 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001802 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001803 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001804 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001805 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001806 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001807 4 common/cmd_bootm.c Image data has correct checksum
1808 -4 common/cmd_bootm.c Image is for unsupported architecture
1809 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001810 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001811 6 common/cmd_bootm.c Image Type check OK
1812 -6 common/cmd_bootm.c gunzip uncompression error
1813 -7 common/cmd_bootm.c Unimplemented compression type
1814 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001815 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001816 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001817
1818 9 common/image.c Start initial ramdisk verification
1819 -10 common/image.c Ramdisk header has bad magic number
1820 -11 common/image.c Ramdisk header has bad checksum
1821 10 common/image.c Ramdisk header is OK
1822 -12 common/image.c Ramdisk data has bad checksum
1823 11 common/image.c Ramdisk data has correct checksum
1824 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001825 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001826 13 common/image.c Start multifile image verification
1827 14 common/image.c No initial ramdisk, no multifile, continue.
1828
1829 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001830
wdenk11dadd542004-02-27 00:07:27 +00001831 -30 lib_ppc/board.c Fatal error, hang the system
1832 -31 post/post.c POST test failed, detected by post_output_backlog()
1833 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001834
Heiko Schocher566a4942007-06-22 19:11:54 +02001835 34 common/cmd_doc.c before loading a Image from a DOC device
1836 -35 common/cmd_doc.c Bad usage of "doc" command
1837 35 common/cmd_doc.c correct usage of "doc" command
1838 -36 common/cmd_doc.c No boot device
1839 36 common/cmd_doc.c correct boot device
1840 -37 common/cmd_doc.c Unknown Chip ID on boot device
1841 37 common/cmd_doc.c correct chip ID found, device available
1842 -38 common/cmd_doc.c Read Error on boot device
1843 38 common/cmd_doc.c reading Image header from DOC device OK
1844 -39 common/cmd_doc.c Image header has bad magic number
1845 39 common/cmd_doc.c Image header has correct magic number
1846 -40 common/cmd_doc.c Error reading Image from DOC device
1847 40 common/cmd_doc.c Image header has correct magic number
1848 41 common/cmd_ide.c before loading a Image from a IDE device
1849 -42 common/cmd_ide.c Bad usage of "ide" command
1850 42 common/cmd_ide.c correct usage of "ide" command
1851 -43 common/cmd_ide.c No boot device
1852 43 common/cmd_ide.c boot device found
1853 -44 common/cmd_ide.c Device not available
1854 44 common/cmd_ide.c Device available
1855 -45 common/cmd_ide.c wrong partition selected
1856 45 common/cmd_ide.c partition selected
1857 -46 common/cmd_ide.c Unknown partition table
1858 46 common/cmd_ide.c valid partition table found
1859 -47 common/cmd_ide.c Invalid partition type
1860 47 common/cmd_ide.c correct partition type
1861 -48 common/cmd_ide.c Error reading Image Header on boot device
1862 48 common/cmd_ide.c reading Image Header from IDE device OK
1863 -49 common/cmd_ide.c Image header has bad magic number
1864 49 common/cmd_ide.c Image header has correct magic number
1865 -50 common/cmd_ide.c Image header has bad checksum
1866 50 common/cmd_ide.c Image header has correct checksum
1867 -51 common/cmd_ide.c Error reading Image from IDE device
1868 51 common/cmd_ide.c reading Image from IDE device OK
1869 52 common/cmd_nand.c before loading a Image from a NAND device
1870 -53 common/cmd_nand.c Bad usage of "nand" command
1871 53 common/cmd_nand.c correct usage of "nand" command
1872 -54 common/cmd_nand.c No boot device
1873 54 common/cmd_nand.c boot device found
1874 -55 common/cmd_nand.c Unknown Chip ID on boot device
1875 55 common/cmd_nand.c correct chip ID found, device available
1876 -56 common/cmd_nand.c Error reading Image Header on boot device
1877 56 common/cmd_nand.c reading Image Header from NAND device OK
1878 -57 common/cmd_nand.c Image header has bad magic number
1879 57 common/cmd_nand.c Image header has correct magic number
1880 -58 common/cmd_nand.c Error reading Image from NAND device
1881 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00001882
Heiko Schocher566a4942007-06-22 19:11:54 +02001883 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001884
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001885 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02001886 -64 net/eth.c no Ethernet found.
1887 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00001888
Heiko Schocher566a4942007-06-22 19:11:54 +02001889 -80 common/cmd_net.c usage wrong
1890 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001891 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02001892 81 common/cmd_net.c NetLoop() back without error
1893 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1894 82 common/cmd_net.c trying automatic boot
1895 83 common/cmd_net.c running autoscript
1896 -83 common/cmd_net.c some error in automatic boot or autoscript
1897 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00001898
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001899FIT uImage format:
1900
1901 Arg Where When
1902 100 common/cmd_bootm.c Kernel FIT Image has correct format
1903 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1904 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1905 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1906 102 common/cmd_bootm.c Kernel unit name specified
1907 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01001908 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001909 104 common/cmd_bootm.c Got kernel subimage node offset
1910 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1911 105 common/cmd_bootm.c Kernel subimage hash verification OK
1912 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1913 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001914 -106 common/cmd_bootm.c Kernel subimage has wrong type
1915 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001916 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1917 108 common/cmd_bootm.c Got kernel subimage data/size
1918 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1919 -109 common/cmd_bootm.c Can't get kernel subimage type
1920 -110 common/cmd_bootm.c Can't get kernel subimage comp
1921 -111 common/cmd_bootm.c Can't get kernel subimage os
1922 -112 common/cmd_bootm.c Can't get kernel subimage load address
1923 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1924
1925 120 common/image.c Start initial ramdisk verification
1926 -120 common/image.c Ramdisk FIT image has incorrect format
1927 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001928 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001929 -122 common/image.c Can't get configuration for ramdisk subimage
1930 123 common/image.c Ramdisk unit name specified
1931 -124 common/image.c Can't get ramdisk subimage node offset
1932 125 common/image.c Got ramdisk subimage node offset
1933 -125 common/image.c Ramdisk subimage hash verification failed
1934 126 common/image.c Ramdisk subimage hash verification OK
1935 -126 common/image.c Ramdisk subimage for unsupported architecture
1936 127 common/image.c Architecture check OK
1937 -127 common/image.c Can't get ramdisk subimage data/size
1938 128 common/image.c Got ramdisk subimage data/size
1939 129 common/image.c Can't get ramdisk load address
1940 -129 common/image.c Got ramdisk load address
1941
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001942 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001943 131 common/cmd_doc.c FIT image format OK
1944
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001945 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001946 141 common/cmd_ide.c FIT image format OK
1947
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001948 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001949 151 common/cmd_nand.c FIT image format OK
1950
1951
wdenkc6097192002-11-03 00:24:07 +00001952Modem Support:
1953--------------
1954
wdenk85ec0bc2003-03-31 16:34:49 +00001955[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001956
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001957- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00001958 CONFIG_MODEM_SUPPORT
1959
1960- RTS/CTS Flow control enable:
1961 CONFIG_HWFLOW
1962
1963- Modem debug support:
1964 CONFIG_MODEM_SUPPORT_DEBUG
1965
wdenk43d96162003-03-06 00:02:04 +00001966 Enables debugging stuff (char screen[1024], dbg())
1967 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001968
wdenka8c7c702003-12-06 19:49:23 +00001969- Interrupt support (PPC):
1970
wdenkd4ca31c2004-01-02 14:00:00 +00001971 There are common interrupt_init() and timer_interrupt()
1972 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001973 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00001974 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001975 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00001976 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001977 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00001978 specific handling. If board has watchdog / status_led
1979 / other_activity_monitor it works automatically from
1980 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001981
wdenkc6097192002-11-03 00:24:07 +00001982- General:
1983
wdenk43d96162003-03-06 00:02:04 +00001984 In the target system modem support is enabled when a
1985 specific key (key combination) is pressed during
1986 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001987 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00001988 board_init(). Currently key_pressed() is a dummy
1989 function, returning 1 and thus enabling modem
1990 initialization.
wdenkc6097192002-11-03 00:24:07 +00001991
wdenk43d96162003-03-06 00:02:04 +00001992 If there are no modem init strings in the
1993 environment, U-Boot proceed to autoboot; the
1994 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001995 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00001996
1997 See also: doc/README.Modem
1998
1999
wdenkc6097192002-11-03 00:24:07 +00002000Configuration Settings:
2001-----------------------
2002
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002003- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002004 undefine this when you're short of memory.
2005
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002006- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002007 prompt for user input.
2008
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002009- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002010
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002011- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002012
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002013- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002014
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002015- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002016 the application (usually a Linux kernel) when it is
2017 booted
2018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002019- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002020 List of legal baudrate settings for this board.
2021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002022- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002023 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002025- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002026 If the board specific function
2027 extern int overwrite_console (void);
2028 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002029 serial port, else the settings in the environment are used.
2030
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002031- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002032 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002033
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002034- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002035 Enable overwrite of previous console environment settings.
2036
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002037- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002038 Begin and End addresses of the area used by the
2039 simple memory test.
2040
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002041- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002042 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002043
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002044- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002045 Scratch address used by the alternate memory test
2046 You only need to set this if address zero isn't writeable
2047
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002048- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2049 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002050 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002051 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002052 fixing up gd->ram_size the Linux kernel should gets passed
2053 the now "corrected" memory size and won't touch it either.
2054 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002055 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002056 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002057 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002058
2059 This option can be used as a workaround for the 440EPx/GRx
2060 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2061 be touched.
2062
2063 WARNING: Please make sure that this value is a multiple of
2064 the Linux page size (normally 4k). If this is not the case,
2065 then the end address of the Linux memory will be located at a
2066 non page size aligned address and this could cause major
2067 problems.
2068
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002069- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002070 Default load address for network file downloads
2071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002072- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002073 Enable temporary baudrate change while serial download
2074
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002075- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002076 Physical start address of SDRAM. _Must_ be 0 here.
2077
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002078- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002079 Physical start address of Motherboard I/O (if using a
2080 Cogent motherboard)
2081
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002082- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002083 Physical start address of Flash memory.
2084
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002085- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002086 Physical start address of boot monitor code (set by
2087 make config files to be same as the text base address
2088 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002089 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002091- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002092 Size of memory reserved for monitor code, used to
2093 determine _at_compile_time_ (!) if the environment is
2094 embedded within the U-Boot image, or in a separate
2095 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002096
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002097- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002098 Size of DRAM reserved for malloc() use.
2099
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002100- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002101 Normally compressed uImages are limited to an
2102 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002103 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002104 to adjust this setting to your needs.
2105
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002106- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002107 Maximum size of memory mapped by the startup code of
2108 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002109 the Linux kernel (bd_info, boot arguments, FDT blob if
2110 used) must be put below this limit, unless "bootm_low"
2111 enviroment variable is defined and non-zero. In such case
2112 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002113 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002115- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002116 Max number of Flash memory banks
2117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002118- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002119 Max number of sectors on a Flash chip
2120
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002121- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002122 Timeout for Flash erase operations (in ms)
2123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002124- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002125 Timeout for Flash write operations (in ms)
2126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002127- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002128 Timeout for Flash set sector lock bit operation (in ms)
2129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002130- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002131 Timeout for Flash clear lock bits operation (in ms)
2132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002133- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002134 If defined, hardware flash sectors protection is used
2135 instead of U-Boot software protection.
2136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002137- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002138
2139 Enable TFTP transfers directly to flash memory;
2140 without this option such a download has to be
2141 performed in two steps: (1) download to RAM, and (2)
2142 copy from RAM to flash.
2143
2144 The two-step approach is usually more reliable, since
2145 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002146 the flash, but in some situations (when system RAM is
2147 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002148 downloaded image) this option may be very useful.
2149
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002150- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002151 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002152 common flash structure for storing flash geometry.
2153
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002154- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002155 This option also enables the building of the cfi_flash driver
2156 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002157
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002158- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002159 Use buffered writes to flash.
2160
2161- CONFIG_FLASH_SPANSION_S29WS_N
2162 s29ws-n MirrorBit flash has non-standard addresses for buffered
2163 write commands.
2164
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002165- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002166 If this option is defined, the common CFI flash doesn't
2167 print it's warning upon not recognized FLASH banks. This
2168 is useful, if some of the configured banks are only
2169 optionally available.
2170
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002171- CONFIG_FLASH_SHOW_PROGRESS
2172 If defined (must be an integer), print out countdown
2173 digits and dots. Recommended value: 45 (9..1) for 80
2174 column displays, 15 (3..1) for 40 column displays.
2175
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002176- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002177 Defines the number of Ethernet receive buffers. On some
2178 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002179 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2180 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002181 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002182 Defaults to 4 if not defined.
2183
wdenkc6097192002-11-03 00:24:07 +00002184The following definitions that deal with the placement and management
2185of environment data (variable area); in general, we support the
2186following configurations:
2187
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002188- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002189
2190 Define this if the environment is in flash memory.
2191
2192 a) The environment occupies one whole flash sector, which is
2193 "embedded" in the text segment with the U-Boot code. This
2194 happens usually with "bottom boot sector" or "top boot
2195 sector" type flash chips, which have several smaller
2196 sectors at the start or the end. For instance, such a
2197 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2198 such a case you would place the environment in one of the
2199 4 kB sectors - with U-Boot code before and after it. With
2200 "top boot sector" type flash chips, you would put the
2201 environment in one of the last sectors, leaving a gap
2202 between U-Boot and the environment.
2203
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002204 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002205
2206 Offset of environment data (variable area) to the
2207 beginning of flash memory; for instance, with bottom boot
2208 type flash chips the second sector can be used: the offset
2209 for this sector is given here.
2210
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002211 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002212
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002213 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002214
2215 This is just another way to specify the start address of
2216 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002217 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002218
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002219 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002220
2221 Size of the sector containing the environment.
2222
2223
2224 b) Sometimes flash chips have few, equal sized, BIG sectors.
2225 In such a case you don't want to spend a whole sector for
2226 the environment.
2227
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002228 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002229
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002230 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002231 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002232 of this flash sector for the environment. This saves
2233 memory for the RAM copy of the environment.
2234
2235 It may also save flash memory if you decide to use this
2236 when your environment is "embedded" within U-Boot code,
2237 since then the remainder of the flash sector could be used
2238 for U-Boot code. It should be pointed out that this is
2239 STRONGLY DISCOURAGED from a robustness point of view:
2240 updating the environment in flash makes it always
2241 necessary to erase the WHOLE sector. If something goes
2242 wrong before the contents has been restored from a copy in
2243 RAM, your target system will be dead.
2244
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002245 - CONFIG_ENV_ADDR_REDUND
2246 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002247
wdenk43d96162003-03-06 00:02:04 +00002248 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002249 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002250 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002251 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002252
2253BE CAREFUL! Any changes to the flash layout, and some changes to the
2254source code will make it necessary to adapt <board>/u-boot.lds*
2255accordingly!
2256
2257
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002258- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002259
2260 Define this if you have some non-volatile memory device
2261 (NVRAM, battery buffered SRAM) which you want to use for the
2262 environment.
2263
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002264 - CONFIG_ENV_ADDR:
2265 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002266
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002267 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002268 want to use for environment. It is assumed that this memory
2269 can just be read and written to, without any special
2270 provision.
2271
2272BE CAREFUL! The first access to the environment happens quite early
2273in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002274console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002275U-Boot will hang.
2276
2277Please note that even with NVRAM we still use a copy of the
2278environment in RAM: we could work on NVRAM directly, but we want to
2279keep settings there always unmodified except somebody uses "saveenv"
2280to save the current settings.
2281
2282
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002283- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002284
2285 Use this if you have an EEPROM or similar serial access
2286 device and a driver for it.
2287
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002288 - CONFIG_ENV_OFFSET:
2289 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002290
2291 These two #defines specify the offset and size of the
2292 environment area within the total memory of your EEPROM.
2293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002294 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002295 If defined, specified the chip address of the EEPROM device.
2296 The default address is zero.
2297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002298 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002299 If defined, the number of bits used to address bytes in a
2300 single page in the EEPROM device. A 64 byte page, for example
2301 would require six bits.
2302
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002303 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002304 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002305 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002307 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002308 The length in bytes of the EEPROM memory array address. Note
2309 that this is NOT the chip address length!
2310
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002311 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002312 EEPROM chips that implement "address overflow" are ones
2313 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2314 address and the extra bits end up in the "chip address" bit
2315 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2316 byte chips.
2317
2318 Note that we consider the length of the address field to
2319 still be one byte because the extra address bits are hidden
2320 in the chip address.
2321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002322 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002323 The size in bytes of the EEPROM device.
2324
wdenkc6097192002-11-03 00:24:07 +00002325
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002326- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002327
wdenkd4ca31c2004-01-02 14:00:00 +00002328 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002329 want to use for the environment.
2330
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002331 - CONFIG_ENV_OFFSET:
2332 - CONFIG_ENV_ADDR:
2333 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002334
2335 These three #defines specify the offset and size of the
2336 environment area within the total memory of your DataFlash placed
2337 at the specified address.
2338
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002339- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002340
2341 Define this if you have a NAND device which you want to use
2342 for the environment.
2343
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002344 - CONFIG_ENV_OFFSET:
2345 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002346
2347 These two #defines specify the offset and size of the environment
2348 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00002349
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002350 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002351
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002352 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002353 size used to hold a redundant copy of the environment data,
2354 so that there is a valid backup copy in case there is a
2355 power failure during a "saveenv" operation.
2356
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002357 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2358 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002359 the NAND devices block size.
2360
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002361- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002362
2363 Defines offset to the initial SPI buffer area in DPRAM. The
2364 area is used at an early stage (ROM part) if the environment
2365 is configured to reside in the SPI EEPROM: We need a 520 byte
2366 scratch DPRAM area. It is used between the two initialization
2367 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2368 to be a good choice since it makes it far enough from the
2369 start of the data area as well as from the stack pointer.
2370
Bruce Adlere881cb52007-11-02 13:15:42 -07002371Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002372has been relocated to RAM and a RAM copy of the environment has been
2373created; also, when using EEPROM you will have to use getenv_r()
2374until then to read environment variables.
2375
wdenk85ec0bc2003-03-31 16:34:49 +00002376The environment is protected by a CRC32 checksum. Before the monitor
2377is relocated into RAM, as a result of a bad CRC you will be working
2378with the compiled-in default environment - *silently*!!! [This is
2379necessary, because the first environment variable we need is the
2380"baudrate" setting for the console - if we have a bad CRC, we don't
2381have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002382
2383Note: once the monitor has been relocated, then it will complain if
2384the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002385use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002386
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002387- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002388 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002389
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002390 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002391 also needs to be defined.
2392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002393- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002394 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002395
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002396- CONFIG_SYS_64BIT_VSPRINTF:
wdenkc40b2952004-03-13 23:29:43 +00002397 Makes vsprintf (and all *printf functions) support printing
2398 of 64bit values by using the L quantifier
2399
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002400- CONFIG_SYS_64BIT_STRTOUL:
wdenkc40b2952004-03-13 23:29:43 +00002401 Adds simple_strtoull that returns a 64bit value
2402
wdenkc6097192002-11-03 00:24:07 +00002403Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002404---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002405
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002406- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002407 Cache Line Size of the CPU.
2408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002410 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002411
wdenk42d1f032003-10-15 23:53:47 +00002412 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2413 and RPXsuper) to be able to adjust the position of
2414 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002415
wdenk7f6c2cb2002-11-10 22:06:23 +00002416- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002417 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002418
2419 the default drive number (default value 0)
2420
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002421 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002422
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002423 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002424 (default value 1)
2425
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002426 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002427
wdenk43d96162003-03-06 00:02:04 +00002428 defines the offset of register from address. It
2429 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002430 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002431
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002432 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2433 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002434 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002435
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002436 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002437 fdc_hw_init() is called at the beginning of the FDC
2438 setup. fdc_hw_init() must be provided by the board
2439 source code. It is used to make hardware dependant
2440 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002441
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002442- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002443 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002444 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002445
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002446- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002447
wdenk7152b1d2003-09-05 23:19:14 +00002448 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002449 initial data and stack; please note that this must be
2450 writable memory that is working WITHOUT special
2451 initialization, i. e. you CANNOT use normal RAM which
2452 will become available only after programming the
2453 memory controller and running certain initialization
2454 sequences.
2455
2456 U-Boot uses the following memory types:
2457 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2458 - MPC824X: data cache
2459 - PPC4xx: data cache
2460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002461- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002462
2463 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002464 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2465 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002466 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002467 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2468 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2469 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2470 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002471
2472 Note:
2473 On the MPC824X (or other systems that use the data
2474 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002475 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002476 point to an otherwise UNUSED address space between
2477 the top of RAM and the start of the PCI space.
2478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002479- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002481- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002482
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002483- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002484
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002485- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002487- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002488
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002489- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002491- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002492 SDRAM timing
2493
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002494- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002495 periodic timer for refresh
2496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002497- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002499- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2500 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2501 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2502 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002503 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2504
2505- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002506 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2507 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002508 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2509
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002510- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2511 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002512 Machine Mode Register and Memory Periodic Timer
2513 Prescaler definitions (SDRAM timing)
2514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002515- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002516 enable I2C microcode relocation patch (MPC8xx);
2517 define relocation offset in DPRAM [DSP2]
2518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002519- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002520 enable SMC microcode relocation patch (MPC8xx);
2521 define relocation offset in DPRAM [SMC1]
2522
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002523- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002524 enable SPI microcode relocation patch (MPC8xx);
2525 define relocation offset in DPRAM [SCC4]
2526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002527- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002528 Use OSCM clock mode on MBX8xx board. Be careful,
2529 wrong setting might damage your board. Read
2530 doc/README.MBX before setting this variable!
2531
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002532- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002533 Offset of the bootmode word in DPRAM used by post
2534 (Power On Self Tests). This definition overrides
2535 #define'd default value in commproc.h resp.
2536 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002538- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2539 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2540 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2541 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2542 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2543 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2544 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2545 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
wdenk5d232d02003-05-22 22:52:13 +00002546 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2547
Ben Warrenbb99ad62006-09-07 16:50:54 -04002548- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002549 Get DDR timing information from an I2C EEPROM. Common
2550 with pluggable memory modules such as SODIMMs
2551
Ben Warrenbb99ad62006-09-07 16:50:54 -04002552 SPD_EEPROM_ADDRESS
2553 I2C address of the SPD EEPROM
2554
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002555- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002556 If SPD EEPROM is on an I2C bus other than the first
2557 one, specify here. Note that the value must resolve
2558 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002560- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002561 Only for 83xx systems. If specified, then DDR should
2562 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002564- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002565 Only for 83xx systems. If specified, then DDR should
2566 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002567
wdenkc26e4542004-04-18 10:13:26 +00002568- CONFIG_ETHER_ON_FEC[12]
2569 Define to enable FEC[12] on a 8xx series processor.
2570
2571- CONFIG_FEC[12]_PHY
2572 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002573 to the given FEC; i. e.
2574 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002575 means that the PHY with address 4 is connected to FEC1
2576
2577 When set to -1, means to probe for first available.
2578
2579- CONFIG_FEC[12]_PHY_NORXERR
2580 The PHY does not have a RXERR line (RMII only).
2581 (so program the FEC to ignore it).
2582
2583- CONFIG_RMII
2584 Enable RMII mode for all FECs.
2585 Note that this is a global option, we can't
2586 have one FEC in standard MII mode and another in RMII mode.
2587
wdenk5cf91d62004-04-23 20:32:05 +00002588- CONFIG_CRC32_VERIFY
2589 Add a verify option to the crc32 command.
2590 The syntax is:
2591
2592 => crc32 -v <address> <count> <crc32>
2593
2594 Where address/count indicate a memory area
2595 and crc32 is the correct crc32 which the
2596 area should have.
2597
wdenk56523f12004-07-11 17:40:54 +00002598- CONFIG_LOOPW
2599 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002600 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002601
stroese7b466642004-12-16 18:46:55 +00002602- CONFIG_MX_CYCLIC
2603 Add the "mdc" and "mwc" memory commands. These are cyclic
2604 "md/mw" commands.
2605 Examples:
2606
wdenkefe2a4d2004-12-16 21:44:03 +00002607 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002608 This command will print 4 bytes (10,11,12,13) each 500 ms.
2609
wdenkefe2a4d2004-12-16 21:44:03 +00002610 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002611 This command will write 12345678 to address 100 all 10 ms.
2612
wdenkefe2a4d2004-12-16 21:44:03 +00002613 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002614 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002615
wdenk8aa1a2d2005-04-04 12:44:11 +00002616- CONFIG_SKIP_LOWLEVEL_INIT
2617- CONFIG_SKIP_RELOCATE_UBOOT
2618
wdenk3c2b3d42005-04-05 23:32:21 +00002619 [ARM only] If these variables are defined, then
2620 certain low level initializations (like setting up
2621 the memory controller) are omitted and/or U-Boot does
2622 not relocate itself into RAM.
2623 Normally these variables MUST NOT be defined. The
2624 only exception is when U-Boot is loaded (to RAM) by
2625 some other boot loader or by a debugger which
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002626 performs these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002627
wdenk400558b2005-04-02 23:52:25 +00002628
wdenkc6097192002-11-03 00:24:07 +00002629Building the Software:
2630======================
2631
Wolfgang Denk218ca722008-03-26 10:40:12 +01002632Building U-Boot has been tested in several native build environments
2633and in many different cross environments. Of course we cannot support
2634all possibly existing versions of cross development tools in all
2635(potentially obsolete) versions. In case of tool chain problems we
2636recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2637which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002638
Wolfgang Denk218ca722008-03-26 10:40:12 +01002639If you are not using a native environment, it is assumed that you
2640have GNU cross compiling tools available in your path. In this case,
2641you must set the environment variable CROSS_COMPILE in your shell.
2642Note that no changes to the Makefile or any other source files are
2643necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002644
Wolfgang Denk218ca722008-03-26 10:40:12 +01002645 $ CROSS_COMPILE=ppc_4xx-
2646 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002647
Wolfgang Denk218ca722008-03-26 10:40:12 +01002648U-Boot is intended to be simple to build. After installing the
2649sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002650is done by typing:
2651
2652 make NAME_config
2653
Wolfgang Denk218ca722008-03-26 10:40:12 +01002654where "NAME_config" is the name of one of the existing configu-
2655rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002656
wdenk2729af92004-05-03 20:45:30 +00002657Note: for some board special configuration names may exist; check if
2658 additional information is available from the board vendor; for
2659 instance, the TQM823L systems are available without (standard)
2660 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002661 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002662
wdenk2729af92004-05-03 20:45:30 +00002663 make TQM823L_config
2664 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002665
wdenk2729af92004-05-03 20:45:30 +00002666 make TQM823L_LCD_config
2667 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002668
wdenk2729af92004-05-03 20:45:30 +00002669 etc.
wdenkc6097192002-11-03 00:24:07 +00002670
wdenkc6097192002-11-03 00:24:07 +00002671
wdenk2729af92004-05-03 20:45:30 +00002672Finally, type "make all", and you should get some working U-Boot
2673images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002674
wdenk2729af92004-05-03 20:45:30 +00002675- "u-boot.bin" is a raw binary image
2676- "u-boot" is an image in ELF binary format
2677- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002678
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002679By default the build is performed locally and the objects are saved
2680in the source directory. One of the two methods can be used to change
2681this behavior and build U-Boot to some external directory:
2682
26831. Add O= to the make command line invocations:
2684
2685 make O=/tmp/build distclean
2686 make O=/tmp/build NAME_config
2687 make O=/tmp/build all
2688
26892. Set environment variable BUILD_DIR to point to the desired location:
2690
2691 export BUILD_DIR=/tmp/build
2692 make distclean
2693 make NAME_config
2694 make all
2695
2696Note that the command line "O=" setting overrides the BUILD_DIR environment
2697variable.
2698
wdenkc6097192002-11-03 00:24:07 +00002699
wdenk2729af92004-05-03 20:45:30 +00002700Please be aware that the Makefiles assume you are using GNU make, so
2701for instance on NetBSD you might need to use "gmake" instead of
2702native "make".
wdenkc6097192002-11-03 00:24:07 +00002703
wdenkc6097192002-11-03 00:24:07 +00002704
wdenk2729af92004-05-03 20:45:30 +00002705If the system board that you have is not listed, then you will need
2706to port U-Boot to your hardware platform. To do this, follow these
2707steps:
wdenkc6097192002-11-03 00:24:07 +00002708
wdenk2729af92004-05-03 20:45:30 +000027091. Add a new configuration option for your board to the toplevel
2710 "Makefile" and to the "MAKEALL" script, using the existing
2711 entries as examples. Note that here and at many other places
2712 boards and other names are listed in alphabetical sort order. Please
2713 keep this order.
27142. Create a new directory to hold your board specific code. Add any
2715 files you need. In your board directory, you will need at least
2716 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
27173. Create a new configuration file "include/configs/<board>.h" for
2718 your board
27193. If you're porting U-Boot to a new CPU, then also create a new
2720 directory to hold your CPU specific code. Add any files you need.
27214. Run "make <board>_config" with your new name.
27225. Type "make", and you should get a working "u-boot.srec" file
2723 to be installed on your target system.
27246. Debug and solve any problems that might arise.
2725 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002726
wdenkc6097192002-11-03 00:24:07 +00002727
wdenk2729af92004-05-03 20:45:30 +00002728Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2729==============================================================
wdenkc6097192002-11-03 00:24:07 +00002730
Wolfgang Denk218ca722008-03-26 10:40:12 +01002731If you have modified U-Boot sources (for instance added a new board
2732or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002733provide feedback to the other developers. The feedback normally takes
2734the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01002735official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002736
Wolfgang Denk218ca722008-03-26 10:40:12 +01002737But before you submit such a patch, please verify that your modifi-
2738cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00002739the supported boards compile WITHOUT ANY compiler warnings. To do so,
2740just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01002741for ALL supported system. Be warned, this will take a while. You can
2742select which (cross) compiler to use by passing a `CROSS_COMPILE'
2743environment variable to the script, i. e. to use the ELDK cross tools
2744you can type
wdenkc6097192002-11-03 00:24:07 +00002745
wdenk2729af92004-05-03 20:45:30 +00002746 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002747
wdenk2729af92004-05-03 20:45:30 +00002748or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002749
wdenk2729af92004-05-03 20:45:30 +00002750 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002751
Wolfgang Denk218ca722008-03-26 10:40:12 +01002752When using the MAKEALL script, the default behaviour is to build
2753U-Boot in the source directory. This location can be changed by
2754setting the BUILD_DIR environment variable. Also, for each target
2755built, the MAKEALL script saves two log files (<target>.ERR and
2756<target>.MAKEALL) in the <source dir>/LOG directory. This default
2757location can be changed by setting the MAKEALL_LOGDIR environment
2758variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002759
2760 export BUILD_DIR=/tmp/build
2761 export MAKEALL_LOGDIR=/tmp/log
2762 CROSS_COMPILE=ppc_8xx- MAKEALL
2763
Wolfgang Denk218ca722008-03-26 10:40:12 +01002764With the above settings build objects are saved in the /tmp/build,
2765log files are saved in the /tmp/log and the source tree remains clean
2766during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002767
2768
wdenk2729af92004-05-03 20:45:30 +00002769See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002770
wdenkc6097192002-11-03 00:24:07 +00002771
wdenk2729af92004-05-03 20:45:30 +00002772Monitor Commands - Overview:
2773============================
wdenkc6097192002-11-03 00:24:07 +00002774
wdenk2729af92004-05-03 20:45:30 +00002775go - start application at address 'addr'
2776run - run commands in an environment variable
2777bootm - boot application image from memory
2778bootp - boot image via network using BootP/TFTP protocol
2779tftpboot- boot image via network using TFTP protocol
2780 and env variables "ipaddr" and "serverip"
2781 (and eventually "gatewayip")
2782rarpboot- boot image via network using RARP/TFTP protocol
2783diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2784loads - load S-Record file over serial line
2785loadb - load binary file over serial line (kermit mode)
2786md - memory display
2787mm - memory modify (auto-incrementing)
2788nm - memory modify (constant address)
2789mw - memory write (fill)
2790cp - memory copy
2791cmp - memory compare
2792crc32 - checksum calculation
2793imd - i2c memory display
2794imm - i2c memory modify (auto-incrementing)
2795inm - i2c memory modify (constant address)
2796imw - i2c memory write (fill)
2797icrc32 - i2c checksum calculation
2798iprobe - probe to discover valid I2C chip addresses
2799iloop - infinite loop on address range
2800isdram - print SDRAM configuration information
2801sspi - SPI utility commands
2802base - print or set address offset
2803printenv- print environment variables
2804setenv - set environment variables
2805saveenv - save environment variables to persistent storage
2806protect - enable or disable FLASH write protection
2807erase - erase FLASH memory
2808flinfo - print FLASH memory information
2809bdinfo - print Board Info structure
2810iminfo - print header information for application image
2811coninfo - print console devices and informations
2812ide - IDE sub-system
2813loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002814loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002815mtest - simple RAM test
2816icache - enable or disable instruction cache
2817dcache - enable or disable data cache
2818reset - Perform RESET of the CPU
2819echo - echo args to console
2820version - print monitor version
2821help - print online help
2822? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002823
wdenkc6097192002-11-03 00:24:07 +00002824
wdenk2729af92004-05-03 20:45:30 +00002825Monitor Commands - Detailed Description:
2826========================================
wdenkc6097192002-11-03 00:24:07 +00002827
wdenk2729af92004-05-03 20:45:30 +00002828TODO.
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk2729af92004-05-03 20:45:30 +00002830For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002831
2832
wdenk2729af92004-05-03 20:45:30 +00002833Environment Variables:
2834======================
wdenkc6097192002-11-03 00:24:07 +00002835
wdenk2729af92004-05-03 20:45:30 +00002836U-Boot supports user configuration using Environment Variables which
2837can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002838
wdenk2729af92004-05-03 20:45:30 +00002839Environment Variables are set using "setenv", printed using
2840"printenv", and saved to Flash using "saveenv". Using "setenv"
2841without a value can be used to delete a variable from the
2842environment. As long as you don't save the environment you are
2843working with an in-memory copy. In case the Flash area containing the
2844environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002845
wdenk2729af92004-05-03 20:45:30 +00002846Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002847
wdenk2729af92004-05-03 20:45:30 +00002848 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002849
wdenk2729af92004-05-03 20:45:30 +00002850 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002851
wdenk2729af92004-05-03 20:45:30 +00002852 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002853
wdenk2729af92004-05-03 20:45:30 +00002854 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002855
wdenk2729af92004-05-03 20:45:30 +00002856 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002857
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002858 bootm_low - Memory range available for image processing in the bootm
2859 command can be restricted. This variable is given as
2860 a hexadecimal number and defines lowest address allowed
2861 for use by the bootm command. See also "bootm_size"
2862 environment variable. Address defined by "bootm_low" is
2863 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002864 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002865
2866 bootm_size - Memory range available for image processing in the bootm
2867 command can be restricted. This variable is given as
2868 a hexadecimal number and defines the size of the region
2869 allowed for use by the bootm command. See also "bootm_low"
2870 environment variable.
2871
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02002872 updatefile - Location of the software update file on a TFTP server, used
2873 by the automatic software update feature. Please refer to
2874 documentation in doc/README.update for more details.
2875
wdenk2729af92004-05-03 20:45:30 +00002876 autoload - if set to "no" (any string beginning with 'n'),
2877 "bootp" will just load perform a lookup of the
2878 configuration from the BOOTP server, but not try to
2879 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002880
Marian Balakowicz3310c542008-03-12 12:13:13 +01002881 autoscript - if set to "yes" commands like "loadb", "loady",
2882 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
2883 to automatically run script images (by internally
2884 calling "autoscript").
2885
2886 autoscript_uname - if script image is in a format (FIT) this
2887 variable is used to get script subimage unit name.
2888
wdenk2729af92004-05-03 20:45:30 +00002889 autostart - if set to "yes", an image loaded using the "bootp",
2890 "rarpboot", "tftpboot" or "diskboot" commands will
2891 be automatically started (by internally calling
2892 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002893
wdenk2729af92004-05-03 20:45:30 +00002894 If set to "no", a standalone image passed to the
2895 "bootm" command will be copied to the load address
2896 (and eventually uncompressed), but NOT be started.
2897 This can be used to load and uncompress arbitrary
2898 data.
wdenkc6097192002-11-03 00:24:07 +00002899
wdenk17ea1172004-06-06 21:51:03 +00002900 i2cfast - (PPC405GP|PPC405EP only)
2901 if set to 'y' configures Linux I2C driver for fast
2902 mode (400kHZ). This environment variable is used in
2903 initialization code. So, for changes to be effective
2904 it must be saved and board must be reset.
2905
wdenk2729af92004-05-03 20:45:30 +00002906 initrd_high - restrict positioning of initrd images:
2907 If this variable is not set, initrd images will be
2908 copied to the highest possible address in RAM; this
2909 is usually what you want since it allows for
2910 maximum initrd size. If for some reason you want to
2911 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002912 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00002913 variable to a value of "no" or "off" or "0".
2914 Alternatively, you can set it to a maximum upper
2915 address to use (U-Boot will still check that it
2916 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002917
wdenk2729af92004-05-03 20:45:30 +00002918 For instance, when you have a system with 16 MB
2919 RAM, and want to reserve 4 MB from use by Linux,
2920 you can do this by adding "mem=12M" to the value of
2921 the "bootargs" variable. However, now you must make
2922 sure that the initrd image is placed in the first
2923 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002924
wdenk2729af92004-05-03 20:45:30 +00002925 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002926
wdenk2729af92004-05-03 20:45:30 +00002927 If you set initrd_high to 0xFFFFFFFF, this is an
2928 indication to U-Boot that all addresses are legal
2929 for the Linux kernel, including addresses in flash
2930 memory. In this case U-Boot will NOT COPY the
2931 ramdisk at all. This may be useful to reduce the
2932 boot time on your system, but requires that this
2933 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00002934
wdenk2729af92004-05-03 20:45:30 +00002935 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002936
wdenk2729af92004-05-03 20:45:30 +00002937 loadaddr - Default load address for commands like "bootp",
2938 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002939
wdenk2729af92004-05-03 20:45:30 +00002940 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002941
wdenk2729af92004-05-03 20:45:30 +00002942 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00002943
wdenk2729af92004-05-03 20:45:30 +00002944 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002945
wdenk2729af92004-05-03 20:45:30 +00002946 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002947
wdenk2729af92004-05-03 20:45:30 +00002948 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002949
wdenk2729af92004-05-03 20:45:30 +00002950 ethprime - When CONFIG_NET_MULTI is enabled controls which
2951 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002952
wdenk2729af92004-05-03 20:45:30 +00002953 ethact - When CONFIG_NET_MULTI is enabled controls which
2954 interface is currently active. For example you
2955 can do the following
wdenkc6097192002-11-03 00:24:07 +00002956
wdenk2729af92004-05-03 20:45:30 +00002957 => setenv ethact FEC ETHERNET
2958 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2959 => setenv ethact SCC ETHERNET
2960 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002961
Matthias Fuchse1692572008-01-17 07:45:05 +01002962 ethrotate - When set to "no" U-Boot does not go through all
2963 available network interfaces.
2964 It just stays at the currently selected interface.
2965
wdenk2729af92004-05-03 20:45:30 +00002966 netretry - When set to "no" each network operation will
2967 either succeed or fail without retrying.
2968 When set to "once" the network operation will
2969 fail when all the available network interfaces
2970 are tried once without success.
2971 Useful on scripts which control the retry operation
2972 themselves.
wdenkc6097192002-11-03 00:24:07 +00002973
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01002974 npe_ucode - see CONFIG_IXP4XX_NPE_EXT_UCOD
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002975 if set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01002976
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002977 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002978 UDP source port.
2979
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002980 tftpdstport - If this is set, the value is used for TFTP's UDP
2981 destination port instead of the Well Know Port 69.
2982
wdenk2729af92004-05-03 20:45:30 +00002983 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002984 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00002985 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00002986
wdenk2729af92004-05-03 20:45:30 +00002987The following environment variables may be used and automatically
2988updated by the network boot commands ("bootp" and "rarpboot"),
2989depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00002990
wdenk2729af92004-05-03 20:45:30 +00002991 bootfile - see above
2992 dnsip - IP address of your Domain Name Server
2993 dnsip2 - IP address of your secondary Domain Name Server
2994 gatewayip - IP address of the Gateway (Router) to use
2995 hostname - Target hostname
2996 ipaddr - see above
2997 netmask - Subnet Mask
2998 rootpath - Pathname of the root filesystem on the NFS server
2999 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003000
wdenka3d991b2004-04-15 21:48:45 +00003001
wdenk2729af92004-05-03 20:45:30 +00003002There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003003
wdenk2729af92004-05-03 20:45:30 +00003004 serial# - contains hardware identification information such
3005 as type string and/or serial number
3006 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003007
wdenk2729af92004-05-03 20:45:30 +00003008These variables can be set only once (usually during manufacturing of
3009the board). U-Boot refuses to delete or overwrite these variables
3010once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003011
3012
wdenk2729af92004-05-03 20:45:30 +00003013Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003014
wdenk2729af92004-05-03 20:45:30 +00003015 ver - Contains the U-Boot version string as printed
3016 with the "version" command. This variable is
3017 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003018
wdenkc6097192002-11-03 00:24:07 +00003019
wdenk2729af92004-05-03 20:45:30 +00003020Please note that changes to some configuration parameters may take
3021only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003022
stroesec1551ea2003-04-04 15:53:41 +00003023
wdenk2729af92004-05-03 20:45:30 +00003024Command Line Parsing:
3025=====================
stroesec1551ea2003-04-04 15:53:41 +00003026
wdenk2729af92004-05-03 20:45:30 +00003027There are two different command line parsers available with U-Boot:
3028the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003029
wdenk2729af92004-05-03 20:45:30 +00003030Old, simple command line parser:
3031--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003032
wdenk2729af92004-05-03 20:45:30 +00003033- supports environment variables (through setenv / saveenv commands)
3034- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003035- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003036- special characters ('$', ';') can be escaped by prefixing with '\',
3037 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003038 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003039- You can also escape text by enclosing in single apostrophes, for example:
3040 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003041
wdenk2729af92004-05-03 20:45:30 +00003042Hush shell:
3043-----------
wdenkf07771c2003-05-28 08:06:31 +00003044
wdenk2729af92004-05-03 20:45:30 +00003045- similar to Bourne shell, with control structures like
3046 if...then...else...fi, for...do...done; while...do...done,
3047 until...do...done, ...
3048- supports environment ("global") variables (through setenv / saveenv
3049 commands) and local shell variables (through standard shell syntax
3050 "name=value"); only environment variables can be used with "run"
3051 command
wdenkf07771c2003-05-28 08:06:31 +00003052
wdenk2729af92004-05-03 20:45:30 +00003053General rules:
3054--------------
wdenkf07771c2003-05-28 08:06:31 +00003055
wdenk2729af92004-05-03 20:45:30 +00003056(1) If a command line (or an environment variable executed by a "run"
3057 command) contains several commands separated by semicolon, and
3058 one of these commands fails, then the remaining commands will be
3059 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003060
wdenk2729af92004-05-03 20:45:30 +00003061(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003062 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003063 command will cause "run" to terminate, i. e. the remaining
3064 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003065
wdenk2729af92004-05-03 20:45:30 +00003066Note for Redundant Ethernet Interfaces:
3067=======================================
wdenkf07771c2003-05-28 08:06:31 +00003068
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003069Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003070such configurations and is capable of automatic selection of a
3071"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003072
wdenk2729af92004-05-03 20:45:30 +00003073Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3074MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3075"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003076
wdenk2729af92004-05-03 20:45:30 +00003077If the network interface stores some valid MAC address (for instance
3078in SROM), this is used as default address if there is NO correspon-
3079ding setting in the environment; if the corresponding environment
3080variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003081
wdenk2729af92004-05-03 20:45:30 +00003082o If the SROM has a valid MAC address, and there is no address in the
3083 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003084
wdenk2729af92004-05-03 20:45:30 +00003085o If there is no valid address in the SROM, and a definition in the
3086 environment exists, then the value from the environment variable is
3087 used.
wdenkc6097192002-11-03 00:24:07 +00003088
wdenk2729af92004-05-03 20:45:30 +00003089o If both the SROM and the environment contain a MAC address, and
3090 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003091
wdenk2729af92004-05-03 20:45:30 +00003092o If both the SROM and the environment contain a MAC address, and the
3093 addresses differ, the value from the environment is used and a
3094 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003095
wdenk2729af92004-05-03 20:45:30 +00003096o If neither SROM nor the environment contain a MAC address, an error
3097 is raised.
wdenkc6097192002-11-03 00:24:07 +00003098
wdenkc6097192002-11-03 00:24:07 +00003099
wdenk2729af92004-05-03 20:45:30 +00003100Image Formats:
3101==============
wdenkc6097192002-11-03 00:24:07 +00003102
Marian Balakowicz3310c542008-03-12 12:13:13 +01003103U-Boot is capable of booting (and performing other auxiliary operations on)
3104images in two formats:
3105
3106New uImage format (FIT)
3107-----------------------
3108
3109Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3110to Flattened Device Tree). It allows the use of images with multiple
3111components (several kernels, ramdisks, etc.), with contents protected by
3112SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3113
3114
3115Old uImage format
3116-----------------
3117
3118Old image format is based on binary files which can be basically anything,
3119preceded by a special header; see the definitions in include/image.h for
3120details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003121
wdenk2729af92004-05-03 20:45:30 +00003122* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3123 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003124 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3125 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3126 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003127* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk2729af92004-05-03 20:45:30 +00003128 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003129 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003130* Compression Type (uncompressed, gzip, bzip2)
3131* Load Address
3132* Entry Point
3133* Image Name
3134* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003135
wdenk2729af92004-05-03 20:45:30 +00003136The header is marked by a special Magic Number, and both the header
3137and the data portions of the image are secured against corruption by
3138CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003139
wdenkc6097192002-11-03 00:24:07 +00003140
wdenk2729af92004-05-03 20:45:30 +00003141Linux Support:
3142==============
wdenkc6097192002-11-03 00:24:07 +00003143
wdenk2729af92004-05-03 20:45:30 +00003144Although U-Boot should support any OS or standalone application
3145easily, the main focus has always been on Linux during the design of
3146U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003147
wdenk2729af92004-05-03 20:45:30 +00003148U-Boot includes many features that so far have been part of some
3149special "boot loader" code within the Linux kernel. Also, any
3150"initrd" images to be used are no longer part of one big Linux image;
3151instead, kernel and "initrd" are separate images. This implementation
3152serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003153
wdenk2729af92004-05-03 20:45:30 +00003154- the same features can be used for other OS or standalone
3155 applications (for instance: using compressed images to reduce the
3156 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003157
wdenk2729af92004-05-03 20:45:30 +00003158- it becomes much easier to port new Linux kernel versions because
3159 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003160
wdenk2729af92004-05-03 20:45:30 +00003161- the same Linux kernel image can now be used with different "initrd"
3162 images; of course this also means that different kernel images can
3163 be run with the same "initrd". This makes testing easier (you don't
3164 have to build a new "zImage.initrd" Linux image when you just
3165 change a file in your "initrd"). Also, a field-upgrade of the
3166 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003167
wdenkc6097192002-11-03 00:24:07 +00003168
wdenk2729af92004-05-03 20:45:30 +00003169Linux HOWTO:
3170============
wdenkc6097192002-11-03 00:24:07 +00003171
wdenk2729af92004-05-03 20:45:30 +00003172Porting Linux to U-Boot based systems:
3173---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003174
wdenk2729af92004-05-03 20:45:30 +00003175U-Boot cannot save you from doing all the necessary modifications to
3176configure the Linux device drivers for use with your target hardware
3177(no, we don't intend to provide a full virtual machine interface to
3178Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003179
wdenk2729af92004-05-03 20:45:30 +00003180But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003181
wdenk2729af92004-05-03 20:45:30 +00003182Just make sure your machine specific header file (for instance
3183include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003184Information structure as we define in include/asm-<arch>/u-boot.h,
3185and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003186as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003187
wdenkc6097192002-11-03 00:24:07 +00003188
wdenk2729af92004-05-03 20:45:30 +00003189Configuring the Linux kernel:
3190-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003191
wdenk2729af92004-05-03 20:45:30 +00003192No specific requirements for U-Boot. Make sure you have some root
3193device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003194
wdenkc6097192002-11-03 00:24:07 +00003195
wdenk2729af92004-05-03 20:45:30 +00003196Building a Linux Image:
3197-----------------------
wdenkc6097192002-11-03 00:24:07 +00003198
wdenk2729af92004-05-03 20:45:30 +00003199With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3200not used. If you use recent kernel source, a new build target
3201"uImage" will exist which automatically builds an image usable by
3202U-Boot. Most older kernels also have support for a "pImage" target,
3203which was introduced for our predecessor project PPCBoot and uses a
3204100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003205
wdenk2729af92004-05-03 20:45:30 +00003206Example:
wdenkc6097192002-11-03 00:24:07 +00003207
wdenk2729af92004-05-03 20:45:30 +00003208 make TQM850L_config
3209 make oldconfig
3210 make dep
3211 make uImage
wdenkc6097192002-11-03 00:24:07 +00003212
wdenk2729af92004-05-03 20:45:30 +00003213The "uImage" build target uses a special tool (in 'tools/mkimage') to
3214encapsulate a compressed Linux kernel image with header information,
3215CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003216
wdenk2729af92004-05-03 20:45:30 +00003217* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003218
wdenk2729af92004-05-03 20:45:30 +00003219* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003220
wdenk2729af92004-05-03 20:45:30 +00003221 ${CROSS_COMPILE}-objcopy -O binary \
3222 -R .note -R .comment \
3223 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003224
wdenk2729af92004-05-03 20:45:30 +00003225* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003226
wdenk2729af92004-05-03 20:45:30 +00003227 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk2729af92004-05-03 20:45:30 +00003229* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003230
wdenk2729af92004-05-03 20:45:30 +00003231 mkimage -A ppc -O linux -T kernel -C gzip \
3232 -a 0 -e 0 -n "Linux Kernel Image" \
3233 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003234
wdenk24ee89b2002-11-03 17:56:27 +00003235
wdenk2729af92004-05-03 20:45:30 +00003236The "mkimage" tool can also be used to create ramdisk images for use
3237with U-Boot, either separated from the Linux kernel image, or
3238combined into one file. "mkimage" encapsulates the images with a 64
3239byte header containing information about target architecture,
3240operating system, image type, compression method, entry points, time
3241stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003242
wdenk2729af92004-05-03 20:45:30 +00003243"mkimage" can be called in two ways: to verify existing images and
3244print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003245
wdenk2729af92004-05-03 20:45:30 +00003246In the first form (with "-l" option) mkimage lists the information
3247contained in the header of an existing U-Boot image; this includes
3248checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003249
wdenk2729af92004-05-03 20:45:30 +00003250 tools/mkimage -l image
3251 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003252
wdenk2729af92004-05-03 20:45:30 +00003253The second form (with "-d" option) is used to build a U-Boot image
3254from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003255
wdenk2729af92004-05-03 20:45:30 +00003256 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3257 -n name -d data_file image
3258 -A ==> set architecture to 'arch'
3259 -O ==> set operating system to 'os'
3260 -T ==> set image type to 'type'
3261 -C ==> set compression type 'comp'
3262 -a ==> set load address to 'addr' (hex)
3263 -e ==> set entry point to 'ep' (hex)
3264 -n ==> set image name to 'name'
3265 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003266
wdenk69459792004-05-29 16:53:29 +00003267Right now, all Linux kernels for PowerPC systems use the same load
3268address (0x00000000), but the entry point address depends on the
3269kernel version:
wdenkc6097192002-11-03 00:24:07 +00003270
wdenk2729af92004-05-03 20:45:30 +00003271- 2.2.x kernels have the entry point at 0x0000000C,
3272- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003273
wdenk2729af92004-05-03 20:45:30 +00003274So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003275
wdenk2729af92004-05-03 20:45:30 +00003276 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3277 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3278 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3279 > examples/uImage.TQM850L
3280 Image Name: 2.4.4 kernel for TQM850L
3281 Created: Wed Jul 19 02:34:59 2000
3282 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3283 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3284 Load Address: 0x00000000
3285 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003286
wdenk2729af92004-05-03 20:45:30 +00003287To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003288
wdenk2729af92004-05-03 20:45:30 +00003289 -> tools/mkimage -l examples/uImage.TQM850L
3290 Image Name: 2.4.4 kernel for TQM850L
3291 Created: Wed Jul 19 02:34:59 2000
3292 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3293 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3294 Load Address: 0x00000000
3295 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003296
wdenk2729af92004-05-03 20:45:30 +00003297NOTE: for embedded systems where boot time is critical you can trade
3298speed for memory and install an UNCOMPRESSED image instead: this
3299needs more space in Flash, but boots much faster since it does not
3300need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003301
wdenk2729af92004-05-03 20:45:30 +00003302 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3303 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3304 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3305 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3306 > examples/uImage.TQM850L-uncompressed
3307 Image Name: 2.4.4 kernel for TQM850L
3308 Created: Wed Jul 19 02:34:59 2000
3309 Image Type: PowerPC Linux Kernel Image (uncompressed)
3310 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3311 Load Address: 0x00000000
3312 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003313
wdenkc6097192002-11-03 00:24:07 +00003314
wdenk2729af92004-05-03 20:45:30 +00003315Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3316when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003317
wdenk2729af92004-05-03 20:45:30 +00003318 -> tools/mkimage -n 'Simple Ramdisk Image' \
3319 > -A ppc -O linux -T ramdisk -C gzip \
3320 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3321 Image Name: Simple Ramdisk Image
3322 Created: Wed Jan 12 14:01:50 2000
3323 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3324 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3325 Load Address: 0x00000000
3326 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003327
wdenkdb01a2e2004-04-15 23:14:49 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329Installing a Linux Image:
3330-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003331
wdenk2729af92004-05-03 20:45:30 +00003332To downloading a U-Boot image over the serial (console) interface,
3333you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003334
wdenk2729af92004-05-03 20:45:30 +00003335 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003336
wdenk2729af92004-05-03 20:45:30 +00003337The 'objcopy' does not understand the information in the U-Boot
3338image header, so the resulting S-Record file will be relative to
3339address 0x00000000. To load it to a given address, you need to
3340specify the target address as 'offset' parameter with the 'loads'
3341command.
wdenkc6097192002-11-03 00:24:07 +00003342
wdenk2729af92004-05-03 20:45:30 +00003343Example: install the image to address 0x40100000 (which on the
3344TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003345
wdenk2729af92004-05-03 20:45:30 +00003346 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003347
wdenk2729af92004-05-03 20:45:30 +00003348 .......... done
3349 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003350
wdenk2729af92004-05-03 20:45:30 +00003351 => loads 40100000
3352 ## Ready for S-Record download ...
3353 ~>examples/image.srec
3354 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3355 ...
3356 15989 15990 15991 15992
3357 [file transfer complete]
3358 [connected]
3359 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003360
3361
wdenk2729af92004-05-03 20:45:30 +00003362You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003363this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003364corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003365
wdenk2729af92004-05-03 20:45:30 +00003366 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003367
wdenk2729af92004-05-03 20:45:30 +00003368 ## Checking Image at 40100000 ...
3369 Image Name: 2.2.13 for initrd on TQM850L
3370 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3371 Data Size: 335725 Bytes = 327 kB = 0 MB
3372 Load Address: 00000000
3373 Entry Point: 0000000c
3374 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003375
3376
wdenk2729af92004-05-03 20:45:30 +00003377Boot Linux:
3378-----------
wdenkc6097192002-11-03 00:24:07 +00003379
wdenk2729af92004-05-03 20:45:30 +00003380The "bootm" command is used to boot an application that is stored in
3381memory (RAM or Flash). In case of a Linux kernel image, the contents
3382of the "bootargs" environment variable is passed to the kernel as
3383parameters. You can check and modify this variable using the
3384"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003385
3386
wdenk2729af92004-05-03 20:45:30 +00003387 => printenv bootargs
3388 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003389
wdenk2729af92004-05-03 20:45:30 +00003390 => 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 +00003391
wdenk2729af92004-05-03 20:45:30 +00003392 => printenv bootargs
3393 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 +00003394
wdenk2729af92004-05-03 20:45:30 +00003395 => bootm 40020000
3396 ## Booting Linux kernel at 40020000 ...
3397 Image Name: 2.2.13 for NFS on TQM850L
3398 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3399 Data Size: 381681 Bytes = 372 kB = 0 MB
3400 Load Address: 00000000
3401 Entry Point: 0000000c
3402 Verifying Checksum ... OK
3403 Uncompressing Kernel Image ... OK
3404 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
3405 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3406 time_init: decrementer frequency = 187500000/60
3407 Calibrating delay loop... 49.77 BogoMIPS
3408 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3409 ...
wdenkc6097192002-11-03 00:24:07 +00003410
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003411If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003412the memory addresses of both the kernel and the initrd image (PPBCOOT
3413format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003414
wdenk2729af92004-05-03 20:45:30 +00003415 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003416
wdenk2729af92004-05-03 20:45:30 +00003417 ## Checking Image at 40100000 ...
3418 Image Name: 2.2.13 for initrd on TQM850L
3419 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3420 Data Size: 335725 Bytes = 327 kB = 0 MB
3421 Load Address: 00000000
3422 Entry Point: 0000000c
3423 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003424
wdenk2729af92004-05-03 20:45:30 +00003425 ## Checking Image at 40200000 ...
3426 Image Name: Simple Ramdisk Image
3427 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3428 Data Size: 566530 Bytes = 553 kB = 0 MB
3429 Load Address: 00000000
3430 Entry Point: 00000000
3431 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003432
wdenk2729af92004-05-03 20:45:30 +00003433 => bootm 40100000 40200000
3434 ## Booting Linux kernel at 40100000 ...
3435 Image Name: 2.2.13 for initrd on TQM850L
3436 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3437 Data Size: 335725 Bytes = 327 kB = 0 MB
3438 Load Address: 00000000
3439 Entry Point: 0000000c
3440 Verifying Checksum ... OK
3441 Uncompressing Kernel Image ... OK
3442 ## Loading RAMDisk Image at 40200000 ...
3443 Image Name: Simple Ramdisk Image
3444 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3445 Data Size: 566530 Bytes = 553 kB = 0 MB
3446 Load Address: 00000000
3447 Entry Point: 00000000
3448 Verifying Checksum ... OK
3449 Loading Ramdisk ... OK
3450 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
3451 Boot arguments: root=/dev/ram
3452 time_init: decrementer frequency = 187500000/60
3453 Calibrating delay loop... 49.77 BogoMIPS
3454 ...
3455 RAMDISK: Compressed image found at block 0
3456 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003457
wdenk2729af92004-05-03 20:45:30 +00003458 bash#
wdenkc6097192002-11-03 00:24:07 +00003459
Matthew McClintock02677682006-06-28 10:41:37 -05003460Boot Linux and pass a flat device tree:
3461-----------
3462
3463First, U-Boot must be compiled with the appropriate defines. See the section
3464titled "Linux Kernel Interface" above for a more in depth explanation. The
3465following is an example of how to start a kernel and pass an updated
3466flat device tree:
3467
3468=> print oftaddr
3469oftaddr=0x300000
3470=> print oft
3471oft=oftrees/mpc8540ads.dtb
3472=> tftp $oftaddr $oft
3473Speed: 1000, full duplex
3474Using TSEC0 device
3475TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3476Filename 'oftrees/mpc8540ads.dtb'.
3477Load address: 0x300000
3478Loading: #
3479done
3480Bytes transferred = 4106 (100a hex)
3481=> tftp $loadaddr $bootfile
3482Speed: 1000, full duplex
3483Using TSEC0 device
3484TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3485Filename 'uImage'.
3486Load address: 0x200000
3487Loading:############
3488done
3489Bytes transferred = 1029407 (fb51f hex)
3490=> print loadaddr
3491loadaddr=200000
3492=> print oftaddr
3493oftaddr=0x300000
3494=> bootm $loadaddr - $oftaddr
3495## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003496 Image Name: Linux-2.6.17-dirty
3497 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3498 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003499 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003500 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003501 Verifying Checksum ... OK
3502 Uncompressing Kernel Image ... OK
3503Booting using flat device tree at 0x300000
3504Using MPC85xx ADS machine description
3505Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3506[snip]
3507
3508
wdenk2729af92004-05-03 20:45:30 +00003509More About U-Boot Image Types:
3510------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003511
wdenk2729af92004-05-03 20:45:30 +00003512U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003513
wdenk2729af92004-05-03 20:45:30 +00003514 "Standalone Programs" are directly runnable in the environment
3515 provided by U-Boot; it is expected that (if they behave
3516 well) you can continue to work in U-Boot after return from
3517 the Standalone Program.
3518 "OS Kernel Images" are usually images of some Embedded OS which
3519 will take over control completely. Usually these programs
3520 will install their own set of exception handlers, device
3521 drivers, set up the MMU, etc. - this means, that you cannot
3522 expect to re-enter U-Boot except by resetting the CPU.
3523 "RAMDisk Images" are more or less just data blocks, and their
3524 parameters (address, size) are passed to an OS kernel that is
3525 being started.
3526 "Multi-File Images" contain several images, typically an OS
3527 (Linux) kernel image and one or more data images like
3528 RAMDisks. This construct is useful for instance when you want
3529 to boot over the network using BOOTP etc., where the boot
3530 server provides just a single image file, but you want to get
3531 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003532
wdenk2729af92004-05-03 20:45:30 +00003533 "Multi-File Images" start with a list of image sizes, each
3534 image size (in bytes) specified by an "uint32_t" in network
3535 byte order. This list is terminated by an "(uint32_t)0".
3536 Immediately after the terminating 0 follow the images, one by
3537 one, all aligned on "uint32_t" boundaries (size rounded up to
3538 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003539
wdenk2729af92004-05-03 20:45:30 +00003540 "Firmware Images" are binary images containing firmware (like
3541 U-Boot or FPGA images) which usually will be programmed to
3542 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003543
wdenk2729af92004-05-03 20:45:30 +00003544 "Script files" are command sequences that will be executed by
3545 U-Boot's command interpreter; this feature is especially
3546 useful when you configure U-Boot to use a real shell (hush)
3547 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003548
wdenkc6097192002-11-03 00:24:07 +00003549
wdenk2729af92004-05-03 20:45:30 +00003550Standalone HOWTO:
3551=================
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk2729af92004-05-03 20:45:30 +00003553One of the features of U-Boot is that you can dynamically load and
3554run "standalone" applications, which can use some resources of
3555U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003556
wdenk2729af92004-05-03 20:45:30 +00003557Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003558
wdenk2729af92004-05-03 20:45:30 +00003559"Hello World" Demo:
3560-------------------
wdenkc6097192002-11-03 00:24:07 +00003561
wdenk2729af92004-05-03 20:45:30 +00003562'examples/hello_world.c' contains a small "Hello World" Demo
3563application; it is automatically compiled when you build U-Boot.
3564It's configured to run at address 0x00040004, so you can play with it
3565like that:
wdenkc6097192002-11-03 00:24:07 +00003566
wdenk2729af92004-05-03 20:45:30 +00003567 => loads
3568 ## Ready for S-Record download ...
3569 ~>examples/hello_world.srec
3570 1 2 3 4 5 6 7 8 9 10 11 ...
3571 [file transfer complete]
3572 [connected]
3573 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003574
wdenk2729af92004-05-03 20:45:30 +00003575 => go 40004 Hello World! This is a test.
3576 ## Starting application at 0x00040004 ...
3577 Hello World
3578 argc = 7
3579 argv[0] = "40004"
3580 argv[1] = "Hello"
3581 argv[2] = "World!"
3582 argv[3] = "This"
3583 argv[4] = "is"
3584 argv[5] = "a"
3585 argv[6] = "test."
3586 argv[7] = "<NULL>"
3587 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591Another example, which demonstrates how to register a CPM interrupt
3592handler with the U-Boot code, can be found in 'examples/timer.c'.
3593Here, a CPM timer is set up to generate an interrupt every second.
3594The interrupt service routine is trivial, just printing a '.'
3595character, but this is just a demo program. The application can be
3596controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003597
wdenk2729af92004-05-03 20:45:30 +00003598 ? - print current values og the CPM Timer registers
3599 b - enable interrupts and start timer
3600 e - stop timer and disable interrupts
3601 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003602
wdenk2729af92004-05-03 20:45:30 +00003603 => loads
3604 ## Ready for S-Record download ...
3605 ~>examples/timer.srec
3606 1 2 3 4 5 6 7 8 9 10 11 ...
3607 [file transfer complete]
3608 [connected]
3609 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003610
wdenk2729af92004-05-03 20:45:30 +00003611 => go 40004
3612 ## Starting application at 0x00040004 ...
3613 TIMERS=0xfff00980
3614 Using timer 1
3615 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003616
wdenk2729af92004-05-03 20:45:30 +00003617Hit 'b':
3618 [q, b, e, ?] Set interval 1000000 us
3619 Enabling timer
3620Hit '?':
3621 [q, b, e, ?] ........
3622 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3623Hit '?':
3624 [q, b, e, ?] .
3625 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3626Hit '?':
3627 [q, b, e, ?] .
3628 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3629Hit '?':
3630 [q, b, e, ?] .
3631 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3632Hit 'e':
3633 [q, b, e, ?] ...Stopping timer
3634Hit 'q':
3635 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003636
3637
wdenk2729af92004-05-03 20:45:30 +00003638Minicom warning:
3639================
wdenk85ec0bc2003-03-31 16:34:49 +00003640
wdenk2729af92004-05-03 20:45:30 +00003641Over time, many people have reported problems when trying to use the
3642"minicom" terminal emulation program for serial download. I (wd)
3643consider minicom to be broken, and recommend not to use it. Under
3644Unix, I recommend to use C-Kermit for general purpose use (and
3645especially for kermit binary protocol download ("loadb" command), and
3646use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003647
wdenk2729af92004-05-03 20:45:30 +00003648Nevertheless, if you absolutely want to use it try adding this
3649configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003650
wdenk2729af92004-05-03 20:45:30 +00003651 Name Program Name U/D FullScr IO-Red. Multi
3652 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3653 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003654
3655
wdenk2729af92004-05-03 20:45:30 +00003656NetBSD Notes:
3657=============
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659Starting at version 0.9.2, U-Boot supports NetBSD both as host
3660(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662Building requires a cross environment; it is known to work on
3663NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3664need gmake since the Makefiles are not compatible with BSD make).
3665Note that the cross-powerpc package does not install include files;
3666attempting to build U-Boot will fail because <machine/ansi.h> is
3667missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003668
wdenk2729af92004-05-03 20:45:30 +00003669 # cd /usr/pkg/cross/powerpc-netbsd/include
3670 # mkdir powerpc
3671 # ln -s powerpc machine
3672 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3673 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003674
wdenk2729af92004-05-03 20:45:30 +00003675Native builds *don't* work due to incompatibilities between native
3676and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003677
wdenk2729af92004-05-03 20:45:30 +00003678Booting assumes that (the first part of) the image booted is a
3679stage-2 loader which in turn loads and then invokes the kernel
3680proper. Loader sources will eventually appear in the NetBSD source
3681tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003682meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003683
3684
wdenk2729af92004-05-03 20:45:30 +00003685Implementation Internals:
3686=========================
wdenkc6097192002-11-03 00:24:07 +00003687
wdenk2729af92004-05-03 20:45:30 +00003688The following is not intended to be a complete description of every
3689implementation detail. However, it should help to understand the
3690inner workings of U-Boot and make it easier to port it to custom
3691hardware.
wdenkc6097192002-11-03 00:24:07 +00003692
3693
wdenk2729af92004-05-03 20:45:30 +00003694Initial Stack, Global Data:
3695---------------------------
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697The implementation of U-Boot is complicated by the fact that U-Boot
3698starts running out of ROM (flash memory), usually without access to
3699system RAM (because the memory controller is not initialized yet).
3700This means that we don't have writable Data or BSS segments, and BSS
3701is not initialized as zero. To be able to get a C environment working
3702at all, we have to allocate at least a minimal stack. Implementation
3703options for this are defined and restricted by the CPU used: Some CPU
3704models provide on-chip memory (like the IMMR area on MPC8xx and
3705MPC826x processors), on others (parts of) the data cache can be
3706locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003707
Wolfgang Denk218ca722008-03-26 10:40:12 +01003708 Chris Hallinan posted a good summary of these issues to the
wdenk2729af92004-05-03 20:45:30 +00003709 u-boot-users mailing list:
wdenk43d96162003-03-06 00:02:04 +00003710
wdenk2729af92004-05-03 20:45:30 +00003711 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3712 From: "Chris Hallinan" <clh@net1plus.com>
3713 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3714 ...
wdenk43d96162003-03-06 00:02:04 +00003715
wdenk2729af92004-05-03 20:45:30 +00003716 Correct me if I'm wrong, folks, but the way I understand it
3717 is this: Using DCACHE as initial RAM for Stack, etc, does not
3718 require any physical RAM backing up the cache. The cleverness
3719 is that the cache is being used as a temporary supply of
3720 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003721 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00003722 can see how this works by studying the cache architecture and
3723 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003724
wdenk2729af92004-05-03 20:45:30 +00003725 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3726 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003727 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00003728 option should work for you. Using CS 4 should be fine if your
3729 board designers haven't used it for something that would
3730 cause you grief during the initial boot! It is frequently not
3731 used.
wdenk43d96162003-03-06 00:02:04 +00003732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003733 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00003734 with your processor/board/system design. The default value
3735 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003736 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003737 than your SDRAM module. If you have a 64MB SDRAM module, set
3738 it above 400_0000. Just make sure your board has no resources
3739 that are supposed to respond to that address! That code in
3740 start.S has been around a while and should work as is when
3741 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003742
wdenk2729af92004-05-03 20:45:30 +00003743 -Chris Hallinan
3744 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003745
wdenk2729af92004-05-03 20:45:30 +00003746It is essential to remember this, since it has some impact on the C
3747code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003748
wdenk2729af92004-05-03 20:45:30 +00003749* Initialized global data (data segment) is read-only. Do not attempt
3750 to write it.
wdenkc6097192002-11-03 00:24:07 +00003751
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003752* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00003753 as zero data - BSS segment) at all - this is undefined, initiali-
3754 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003755
wdenk2729af92004-05-03 20:45:30 +00003756* Stack space is very limited. Avoid big data buffers or things like
3757 that.
wdenkc6097192002-11-03 00:24:07 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759Having only the stack as writable memory limits means we cannot use
3760normal global data to share information beween the code. But it
3761turned out that the implementation of U-Boot can be greatly
3762simplified by making a global data structure (gd_t) available to all
3763functions. We could pass a pointer to this data as argument to _all_
3764functions, but this would bloat the code. Instead we use a feature of
3765the GCC compiler (Global Register Variables) to share the data: we
3766place a pointer (gd) to the global data into a register which we
3767reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk2729af92004-05-03 20:45:30 +00003769When choosing a register for such a purpose we are restricted by the
3770relevant (E)ABI specifications for the current architecture, and by
3771GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773For PowerPC, the following registers have specific use:
3774 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01003775 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00003776 R3-R4: parameter passing and return values
3777 R5-R10: parameter passing
3778 R13: small data area pointer
3779 R30: GOT pointer
3780 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk2729af92004-05-03 20:45:30 +00003782 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003783
Wolfgang Denke7670f62008-02-14 22:43:22 +01003784 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003785
wdenk2729af92004-05-03 20:45:30 +00003786 Note: on PPC, we could use a static initializer (since the
3787 address of the global data structure is known at compile time),
3788 but it turned out that reserving a register results in somewhat
3789 smaller code - although the code savings are not that big (on
3790 average for all boards 752 bytes for the whole U-Boot image,
3791 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003792
Mike Frysinger4c58eb52008-02-04 19:26:54 -05003793On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3794 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3795
3796 ==> U-Boot will use P5 to hold a pointer to the global data
3797
wdenk2729af92004-05-03 20:45:30 +00003798On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003799
wdenk2729af92004-05-03 20:45:30 +00003800 R0: function argument word/integer result
3801 R1-R3: function argument word
3802 R9: GOT pointer
3803 R10: stack limit (used only if stack checking if enabled)
3804 R11: argument (frame) pointer
3805 R12: temporary workspace
3806 R13: stack pointer
3807 R14: link register
3808 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003809
wdenk2729af92004-05-03 20:45:30 +00003810 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003811
Wolfgang Denkd87080b2006-03-31 18:32:53 +02003812NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3813or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003814
wdenk2729af92004-05-03 20:45:30 +00003815Memory Management:
3816------------------
wdenkc6097192002-11-03 00:24:07 +00003817
wdenk2729af92004-05-03 20:45:30 +00003818U-Boot runs in system state and uses physical addresses, i.e. the
3819MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk2729af92004-05-03 20:45:30 +00003821The available memory is mapped to fixed addresses using the memory
3822controller. In this process, a contiguous block is formed for each
3823memory type (Flash, SDRAM, SRAM), even when it consists of several
3824physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk2729af92004-05-03 20:45:30 +00003826U-Boot is installed in the first 128 kB of the first Flash bank (on
3827TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3828booting and sizing and initializing DRAM, the code relocates itself
3829to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003830memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00003831configuration setting]. Below that, a structure with global Board
3832Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003833
wdenk2729af92004-05-03 20:45:30 +00003834Additionally, some exception handler code is copied to the low 8 kB
3835of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003836
wdenk2729af92004-05-03 20:45:30 +00003837So a typical memory configuration with 16 MB of DRAM could look like
3838this:
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840 0x0000 0000 Exception Vector code
3841 :
3842 0x0000 1FFF
3843 0x0000 2000 Free for Application Use
3844 :
3845 :
wdenkc6097192002-11-03 00:24:07 +00003846
wdenk2729af92004-05-03 20:45:30 +00003847 :
3848 :
3849 0x00FB FF20 Monitor Stack (Growing downward)
3850 0x00FB FFAC Board Info Data and permanent copy of global data
3851 0x00FC 0000 Malloc Arena
3852 :
3853 0x00FD FFFF
3854 0x00FE 0000 RAM Copy of Monitor Code
3855 ... eventually: LCD or video framebuffer
3856 ... eventually: pRAM (Protected RAM - unchanged by reset)
3857 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003858
3859
wdenk2729af92004-05-03 20:45:30 +00003860System Initialization:
3861----------------------
wdenkc6097192002-11-03 00:24:07 +00003862
wdenk2729af92004-05-03 20:45:30 +00003863In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003864(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00003865configuration for CS0# this is a mirror of the onboard Flash memory.
3866To be able to re-map memory U-Boot then jumps to its link address.
3867To be able to implement the initialization code in C, a (small!)
3868initial stack is set up in the internal Dual Ported RAM (in case CPUs
3869which provide such a feature like MPC8xx or MPC8260), or in a locked
3870part of the data cache. After that, U-Boot initializes the CPU core,
3871the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003872
wdenk2729af92004-05-03 20:45:30 +00003873Next, all (potentially) available memory banks are mapped using a
3874preliminary mapping. For example, we put them on 512 MB boundaries
3875(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3876on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3877programmed for SDRAM access. Using the temporary configuration, a
3878simple memory test is run that determines the size of the SDRAM
3879banks.
wdenkc6097192002-11-03 00:24:07 +00003880
wdenk2729af92004-05-03 20:45:30 +00003881When there is more than one SDRAM bank, and the banks are of
3882different size, the largest is mapped first. For equal size, the first
3883bank (CS2#) is mapped first. The first mapping is always for address
38840x00000000, with any additional banks following immediately to create
3885contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003886
wdenk2729af92004-05-03 20:45:30 +00003887Then, the monitor installs itself at the upper end of the SDRAM area
3888and allocates memory for use by malloc() and for the global Board
3889Info data; also, the exception vector code is copied to the low RAM
3890pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk2729af92004-05-03 20:45:30 +00003892Only after this relocation will you have a "normal" C environment;
3893until that you are restricted in several ways, mostly because you are
3894running from ROM, and because the code will have to be relocated to a
3895new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003896
3897
wdenk2729af92004-05-03 20:45:30 +00003898U-Boot Porting Guide:
3899----------------------
wdenkc6097192002-11-03 00:24:07 +00003900
wdenk2729af92004-05-03 20:45:30 +00003901[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3902list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003903
3904
wdenk2729af92004-05-03 20:45:30 +00003905int main (int argc, char *argv[])
3906{
3907 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003908
wdenk2729af92004-05-03 20:45:30 +00003909 signal (SIGALRM, no_more_time);
3910 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003911
wdenk2729af92004-05-03 20:45:30 +00003912 if (available_money > available_manpower) {
3913 pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00003914 return 0;
3915 }
3916
wdenk2729af92004-05-03 20:45:30 +00003917 Download latest U-Boot source;
3918
3919 Subscribe to u-boot-users mailing list;
3920
3921 if (clueless) {
3922 email ("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003923 }
3924
wdenk2729af92004-05-03 20:45:30 +00003925 while (learning) {
3926 Read the README file in the top level directory;
3927 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3928 Read the source, Luke;
3929 }
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk2729af92004-05-03 20:45:30 +00003931 if (available_money > toLocalCurrency ($2500)) {
3932 Buy a BDI2000;
3933 } else {
3934 Add a lot of aggravation and time;
3935 }
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937 Create your own board support subdirectory;
wdenkc6097192002-11-03 00:24:07 +00003938
wdenk2729af92004-05-03 20:45:30 +00003939 Create your own board config file;
wdenk6aff3112002-12-17 01:51:00 +00003940
wdenk2729af92004-05-03 20:45:30 +00003941 while (!running) {
3942 do {
3943 Add / modify source code;
3944 } until (compiles);
3945 Debug;
3946 if (clueless)
3947 email ("Hi, I am having problems...");
3948 }
3949 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951 return 0;
3952}
3953
3954void no_more_time (int sig)
3955{
3956 hire_a_guru();
3957}
wdenkc6097192002-11-03 00:24:07 +00003958
3959
wdenk2729af92004-05-03 20:45:30 +00003960Coding Standards:
3961-----------------
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk2729af92004-05-03 20:45:30 +00003963All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02003964coding style; see the file "Documentation/CodingStyle" and the script
3965"scripts/Lindent" in your Linux kernel source directory. In sources
3966originating from U-Boot a style corresponding to "Lindent -pcs" (adding
3967spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00003968
Detlev Zundel2c051652006-09-01 15:39:02 +02003969Source files originating from a different project (for example the
3970MTD subsystem) are generally exempt from these guidelines and are not
3971reformated to ease subsequent migration to newer versions of those
3972sources.
3973
3974Please note that U-Boot is implemented in C (and to some small parts in
3975Assembler); no C++ is used, so please do not use C++ style comments (//)
3976in your code.
wdenk2729af92004-05-03 20:45:30 +00003977
3978Please also stick to the following formatting rules:
3979- remove any trailing white space
3980- use TAB characters for indentation, not spaces
3981- make sure NOT to use DOS '\r\n' line feeds
3982- do not add more than 2 empty lines to source files
3983- do not add trailing empty lines to source files
3984
3985Submissions which do not conform to the standards may be returned
3986with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003987
3988
wdenk2729af92004-05-03 20:45:30 +00003989Submitting Patches:
3990-------------------
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992Since the number of patches for U-Boot is growing, we need to
3993establish some rules. Submissions which do not conform to these rules
3994may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003995
wdenk90dc6702005-05-03 14:12:25 +00003996Patches shall be sent to the u-boot-users mailing list.
wdenkc6097192002-11-03 00:24:07 +00003997
Magnus Lilja0d28f342008-08-06 19:32:33 +02003998Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01003999
wdenk2729af92004-05-03 20:45:30 +00004000When you send a patch, please include the following information with
4001it:
wdenkc6097192002-11-03 00:24:07 +00004002
wdenk2729af92004-05-03 20:45:30 +00004003* For bug fixes: a description of the bug and how your patch fixes
4004 this bug. Please try to include a way of demonstrating that the
4005 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004006
wdenk2729af92004-05-03 20:45:30 +00004007* For new features: a description of the feature and your
4008 implementation.
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk2729af92004-05-03 20:45:30 +00004010* A CHANGELOG entry as plaintext (separate from the patch)
4011
4012* For major contributions, your entry to the CREDITS file
4013
4014* When you add support for a new board, don't forget to add this
4015 board to the MAKEALL script, too.
4016
4017* If your patch adds new configuration options, don't forget to
4018 document these in the README file.
4019
Wolfgang Denk218ca722008-03-26 10:40:12 +01004020* The patch itself. If you are using git (which is *strongly*
4021 recommended) you can easily generate the patch using the
4022 "git-format-patch". If you then use "git-send-email" to send it to
4023 the U-Boot mailing list, you will avoid most of the common problems
4024 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004025
Wolfgang Denk218ca722008-03-26 10:40:12 +01004026 If you cannot use git, use "diff -purN OLD NEW". If your version of
4027 diff does not support these options, then get the latest version of
4028 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004029
Wolfgang Denk218ca722008-03-26 10:40:12 +01004030 The current directory when running this command shall be the parent
4031 directory of the U-Boot source tree (i. e. please make sure that
4032 your patch includes sufficient directory information for the
4033 affected files).
4034
4035 We prefer patches as plain text. MIME attachments are discouraged,
4036 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004037
4038* If one logical set of modifications affects or creates several
4039 files, all these changes shall be submitted in a SINGLE patch file.
4040
4041* Changesets that contain different, unrelated modifications shall be
4042 submitted as SEPARATE patches, one patch per changeset.
4043
4044
4045Notes:
4046
4047* Before sending the patch, run the MAKEALL script on your patched
4048 source tree and make sure that no errors or warnings are reported
4049 for any of the boards.
4050
4051* Keep your modifications to the necessary minimum: A patch
4052 containing several unrelated changes or arbitrary reformats will be
4053 returned with a request to re-formatting / split it.
4054
4055* If you modify existing code, make sure that your new code does not
4056 add to the memory footprint of the code ;-) Small is beautiful!
4057 When adding new features, these should compile conditionally only
4058 (using #ifdef), and the resulting code with the new feature
4059 disabled must not need more memory than the old code without your
4060 modification.
wdenk90dc6702005-05-03 14:12:25 +00004061
4062* Remember that there is a size limit of 40 kB per message on the
Wolfgang Denk218ca722008-03-26 10:40:12 +01004063 u-boot-users mailing list. Bigger patches will be moderated. If
4064 they are reasonable and not bigger than 100 kB, they will be
4065 acknowledged. Even bigger patches should be avoided.