blob: cf3867dcf39d68c739711593937a530b4fcfb7f1 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk218ca722008-03-26 10:40:12 +01002# (C) Copyright 2000 - 2008
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
129U-Boot uses a 3 level version number containing a version, a
130sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
131sub-version "34", and patchlevel "4".
132
133The patchlevel is used to indicate certain stages of development
134between released versions, i. e. officially released versions of
135U-Boot will always have a patchlevel of "0".
136
137
wdenkc6097192002-11-03 00:24:07 +0000138Directory Hierarchy:
139====================
140
wdenk7152b1d2003-09-05 23:19:14 +0000141- board Board dependent files
142- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000143- cpu CPU specific files
wdenk983fda82004-10-28 00:09:35 +0000144 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000145 - arm720t Files specific to ARM 720 CPUs
146 - arm920t Files specific to ARM 920 CPUs
wdenka85f9f22005-04-06 13:52:31 +0000147 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk983fda82004-10-28 00:09:35 +0000148 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenk1d9f4102004-10-09 22:21:29 +0000149 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000150 - arm925t Files specific to ARM 925 CPUs
151 - arm926ejs Files specific to ARM 926 CPUs
wdenk8ed96042005-01-09 23:16:25 +0000152 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk72a087e2006-10-24 14:27:35 +0200153 - at32ap Files specific to Atmel AVR32 AP CPUs
Mike Frysingeradbfeeb2008-08-07 17:50:26 -0400154 - blackfin Files specific to Analog Devices Blackfin CPUs
wdenk11dadd52004-02-27 00:07:27 +0000155 - i386 Files specific to i386 CPUs
156 - ixp Files specific to Intel XScale IXP CPUs
Daniel Hellstromb3309902008-03-28 10:00:33 +0100157 - leon2 Files specific to Gaisler LEON2 SPARC CPU
Daniel Hellstrom1e9a1642008-03-26 22:51:29 +0100158 - leon3 Files specific to Gaisler LEON3 SPARC CPU
wdenk983fda82004-10-28 00:09:35 +0000159 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
TsiChungLiew1552af72008-01-14 17:43:33 -0600160 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
TsiChung Liew8e585f02007-06-18 13:50:13 -0500161 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
TsiChungLiew8ae158c2007-08-16 15:05:11 -0500162 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
TsiChungLiew57a12722008-01-15 14:15:46 -0600163 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
wdenk11dadd52004-02-27 00:07:27 +0000164 - mips Files specific to MIPS CPUs
wdenk983fda82004-10-28 00:09:35 +0000165 - mpc5xx Files specific to Freescale MPC5xx CPUs
166 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
167 - mpc8xx Files specific to Freescale MPC8xx CPUs
168 - mpc8220 Files specific to Freescale MPC8220 CPUs
169 - mpc824x Files specific to Freescale MPC824x CPUs
170 - mpc8260 Files specific to Freescale MPC8260 CPUs
171 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000172 - nios Files specific to Altera NIOS CPUs
wdenk5c952cf2004-10-10 21:27:30 +0000173 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200174 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000175 - pxa Files specific to Intel XScale PXA CPUs
176 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
177 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000178- disk Code for disk drive partition handling
179- doc Documentation (don't expect too much)
wdenk7152b1d2003-09-05 23:19:14 +0000180- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000181- dtt Digital Thermometer and Thermostat drivers
182- examples Example code for standalone applications, etc.
183- include Header Files
wdenk11dadd52004-02-27 00:07:27 +0000184- lib_arm Files generic to ARM architecture
Wolfgang Denk7b64fef2006-10-24 14:21:16 +0200185- lib_avr32 Files generic to AVR32 architecture
Mike Frysingeradbfeeb2008-08-07 17:50:26 -0400186- lib_blackfin Files generic to Blackfin architecture
wdenk11dadd52004-02-27 00:07:27 +0000187- lib_generic Files generic to all architectures
188- lib_i386 Files generic to i386 architecture
189- lib_m68k Files generic to m68k architecture
190- lib_mips Files generic to MIPS architecture
191- lib_nios Files generic to NIOS architecture
192- lib_ppc Files generic to PowerPC architecture
Daniel Hellstromc2f02da2008-03-28 09:47:00 +0100193- lib_sparc Files generic to SPARC architecture
Wolfgang Denk218ca722008-03-26 10:40:12 +0100194- libfdt Library files to support flattened device trees
wdenkc6097192002-11-03 00:24:07 +0000195- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000196- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000197- rtc Real Time Clock drivers
198- tools Tools to build S-Record or U-Boot images, etc.
199
wdenkc6097192002-11-03 00:24:07 +0000200Software Configuration:
201=======================
202
203Configuration is usually done using C preprocessor defines; the
204rationale behind that is to avoid dead code whenever possible.
205
206There are two classes of configuration variables:
207
208* Configuration _OPTIONS_:
209 These are selectable by the user and have names beginning with
210 "CONFIG_".
211
212* Configuration _SETTINGS_:
213 These depend on the hardware etc. and should not be meddled with if
214 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200215 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000216
217Later we will add a configuration tool - probably similar to or even
218identical to what's used for the Linux kernel. Right now, we have to
219do the configuration by hand, which means creating some symbolic
220links and editing some configuration files. We use the TQM8xxL boards
221as an example here.
222
223
224Selection of Processor Architecture and Board Type:
225---------------------------------------------------
226
227For all supported boards there are ready-to-use default
228configurations available; just type "make <board_name>_config".
229
230Example: For a TQM823L module type:
231
232 cd u-boot
233 make TQM823L_config
234
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200235For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000236e.g. "make cogent_mpc8xx_config". And also configure the cogent
237directory according to the instructions in cogent/README.
238
239
240Configuration Options:
241----------------------
242
243Configuration depends on the combination of board and CPU type; all
244such information is kept in a configuration file
245"include/configs/<board_name>.h".
246
247Example: For a TQM823L module, all configuration settings are in
248"include/configs/TQM823L.h".
249
250
wdenk7f6c2cb2002-11-10 22:06:23 +0000251Many of the options are named exactly as the corresponding Linux
252kernel configuration options. The intention is to make it easier to
253build a config tool - later.
254
255
wdenkc6097192002-11-03 00:24:07 +0000256The following options need to be configured:
257
Kim Phillips26281142007-08-10 13:28:25 -0500258- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000259
Kim Phillips26281142007-08-10 13:28:25 -0500260- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200261
262- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100263 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000264
265- CPU Module Type: (if CONFIG_COGENT is defined)
266 Define exactly one of
267 CONFIG_CMA286_60_OLD
268--- FIXME --- not tested yet:
269 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
270 CONFIG_CMA287_23, CONFIG_CMA287_50
271
272- Motherboard Type: (if CONFIG_COGENT is defined)
273 Define exactly one of
274 CONFIG_CMA101, CONFIG_CMA102
275
276- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
277 Define one or more of
278 CONFIG_CMA302
279
280- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
281 Define one or more of
282 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200283 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000284 a "rotator" |\-/|\-/
285
wdenk2535d602003-07-17 23:16:40 +0000286- Board flavour: (if CONFIG_MPC8260ADS is defined)
287 CONFIG_ADSTYPE
288 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200289 CONFIG_SYS_8260ADS - original MPC8260ADS
290 CONFIG_SYS_8266ADS - MPC8266ADS
291 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
292 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000293
wdenkc6097192002-11-03 00:24:07 +0000294- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000295 Define exactly one of
296 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000297
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200298- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000299 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
300 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000301 e.g. if there is no 32KHz
302 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000303 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
304 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000305
wdenk66ca92a2004-09-28 17:59:53 +0000306- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200307 CONFIG_SYS_8xx_CPUCLK_MIN
308 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000309 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000310 See doc/README.MPC866
311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200312 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000313
wdenkba56f622004-02-06 23:19:44 +0000314 Define this to measure the actual CPU clock instead
315 of relying on the correctness of the configured
316 values. Mostly useful for board bringup to make sure
317 the PLL is locked at the intended frequency. Note
318 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200319 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000320
Heiko Schocher506f3912009-03-12 07:37:15 +0100321 CONFIG_SYS_DELAYED_ICACHE
322
323 Define this option if you want to enable the
324 ICache only when Code runs from RAM.
325
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100326- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200327 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100328
329 Defines the Monahans run mode to oscillator
330 ratio. Valid values are 8, 16, 24, 31. The core
331 frequency is this value multiplied by 13 MHz.
332
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200333 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200334
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100335 Defines the Monahans turbo mode to oscillator
336 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200337 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100338 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200339
wdenk5da627a2003-10-09 20:09:04 +0000340- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000341 CONFIG_CLOCKS_IN_MHZ
342
343 U-Boot stores all clock information in Hz
344 internally. For binary compatibility with older Linux
345 kernels (which expect the clocks passed in the
346 bd_info data to be in MHz) the environment variable
347 "clocks_in_mhz" can be defined so that U-Boot
348 converts clock data to MHZ before passing it to the
349 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000350 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100351 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000352 default environment.
353
wdenk5da627a2003-10-09 20:09:04 +0000354 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
355
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200356 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000357 expect it to be in bytes, others in MB.
358 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
359
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400360 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200361
362 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400363 passed using flattened device trees (based on open firmware
364 concepts).
365
366 CONFIG_OF_LIBFDT
367 * New libfdt-based support
368 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500369 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400370
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200371 OF_CPU - The proper name of the cpus node.
Kumar Galac2871f02006-01-11 13:59:02 -0600372 OF_SOC - The proper name of the soc node.
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200373 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600374 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200375
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200376 boards with QUICC Engines require OF_QE to set UCC MAC
377 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500378
Kumar Gala4e253132006-01-11 13:54:17 -0600379 CONFIG_OF_BOARD_SETUP
380
381 Board code has addition modification that it wants to make
382 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000383
Matthew McClintock02677682006-06-28 10:41:37 -0500384 CONFIG_OF_BOOT_CPU
385
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200386 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500387 param header, the default value is zero if undefined.
388
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100389- vxWorks boot parameters:
390
391 bootvx constructs a valid bootline using the following
392 environments variables: bootfile, ipaddr, serverip, hostname.
393 It loads the vxWorks image pointed bootfile.
394
395 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
396 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
397 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
398 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
399
400 CONFIG_SYS_VXWORKS_ADD_PARAMS
401
402 Add it at the end of the bootline. E.g "u=username pw=secret"
403
404 Note: If a "bootargs" environment is defined, it will overwride
405 the defaults discussed just above.
406
wdenk6705d812004-08-02 23:22:59 +0000407- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200408 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000409
410 Define this if you want support for Amba PrimeCell PL010 UARTs.
411
Andreas Engel48d01922008-09-08 14:30:53 +0200412 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000413
414 Define this if you want support for Amba PrimeCell PL011 UARTs.
415
416 CONFIG_PL011_CLOCK
417
418 If you have Amba PrimeCell PL011 UARTs, set this variable to
419 the clock speed of the UARTs.
420
421 CONFIG_PL01x_PORTS
422
423 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
424 define this to a list of base addresses for each (supported)
425 port. See e.g. include/configs/versatile.h
426
427
wdenkc6097192002-11-03 00:24:07 +0000428- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000429 Depending on board, define exactly one serial port
430 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
431 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
432 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000433
434 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
435 port routines must be defined elsewhere
436 (i.e. serial_init(), serial_getc(), ...)
437
438 CONFIG_CFB_CONSOLE
439 Enables console device for a color framebuffer. Needs following
440 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
441 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
442 (default big endian)
443 VIDEO_HW_RECTFILL graphic chip supports
444 rectangle fill
445 (cf. smiLynxEM)
446 VIDEO_HW_BITBLT graphic chip supports
447 bit-blit (cf. smiLynxEM)
448 VIDEO_VISIBLE_COLS visible pixel columns
449 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000450 VIDEO_VISIBLE_ROWS visible pixel rows
451 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000452 VIDEO_DATA_FORMAT graphic data format
453 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000454 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000455 VIDEO_KBD_INIT_FCT keyboard int fct
456 (i.e. i8042_kbd_init())
457 VIDEO_TSTC_FCT test char fct
458 (i.e. i8042_tstc)
459 VIDEO_GETC_FCT get char fct
460 (i.e. i8042_getc)
461 CONFIG_CONSOLE_CURSOR cursor drawing on/off
462 (requires blink timer
463 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200464 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000465 CONFIG_CONSOLE_TIME display time/date info in
466 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500467 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000468 CONFIG_VIDEO_LOGO display Linux logo in
469 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000470 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
471 linux_logo.h for logo.
472 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000473 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200474 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000475 the logo
476
wdenk43d96162003-03-06 00:02:04 +0000477 When CONFIG_CFB_CONSOLE is defined, video console is
478 default i/o. Serial console can be forced with
479 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000480
wdenkd4ca31c2004-01-02 14:00:00 +0000481 When CONFIG_SILENT_CONSOLE is defined, all console
482 messages (by U-Boot and Linux!) can be silenced with
483 the "silent" environment variable. See
484 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000485
wdenkc6097192002-11-03 00:24:07 +0000486- Console Baudrate:
487 CONFIG_BAUDRATE - in bps
488 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200489 CONFIG_SYS_BAUDRATE_TABLE, see below.
490 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000491
Heiko Schocherc92fac92009-01-30 12:55:38 +0100492- Console Rx buffer length
493 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
494 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100495 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100496 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
497 must be defined, to setup the maximum idle timeout for
498 the SMC.
499
wdenkc6097192002-11-03 00:24:07 +0000500- Interrupt driven serial port input:
501 CONFIG_SERIAL_SOFTWARE_FIFO
502
503 PPC405GP only.
504 Use an interrupt handler for receiving data on the
505 serial port. It also enables using hardware handshake
506 (RTS/CTS) and UART's built-in FIFO. Set the number of
507 bytes the interrupt driven input buffer should have.
508
wdenk109c0e32004-03-23 21:43:07 +0000509 Leave undefined to disable this feature, including
510 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000511
stroese1d49b1f2003-05-23 11:39:05 +0000512- Console UART Number:
513 CONFIG_UART1_CONSOLE
514
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200515 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000516 If defined internal UART1 (and not UART0) is used
517 as default U-Boot console.
518
wdenkc6097192002-11-03 00:24:07 +0000519- Boot Delay: CONFIG_BOOTDELAY - in seconds
520 Delay before automatically booting the default image;
521 set to -1 to disable autoboot.
522
523 See doc/README.autoboot for these options that
524 work with CONFIG_BOOTDELAY. None are required.
525 CONFIG_BOOT_RETRY_TIME
526 CONFIG_BOOT_RETRY_MIN
527 CONFIG_AUTOBOOT_KEYED
528 CONFIG_AUTOBOOT_PROMPT
529 CONFIG_AUTOBOOT_DELAY_STR
530 CONFIG_AUTOBOOT_STOP_STR
531 CONFIG_AUTOBOOT_DELAY_STR2
532 CONFIG_AUTOBOOT_STOP_STR2
533 CONFIG_ZERO_BOOTDELAY_CHECK
534 CONFIG_RESET_TO_RETRY
535
536- Autoboot Command:
537 CONFIG_BOOTCOMMAND
538 Only needed when CONFIG_BOOTDELAY is enabled;
539 define a command string that is automatically executed
540 when no character is read on the console interface
541 within "Boot Delay" after reset.
542
543 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000544 This can be used to pass arguments to the bootm
545 command. The value of CONFIG_BOOTARGS goes into the
546 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000547
548 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000549 The value of these goes into the environment as
550 "ramboot" and "nfsboot" respectively, and can be used
551 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200552 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000553
554- Pre-Boot Commands:
555 CONFIG_PREBOOT
556
557 When this option is #defined, the existence of the
558 environment variable "preboot" will be checked
559 immediately before starting the CONFIG_BOOTDELAY
560 countdown and/or running the auto-boot command resp.
561 entering interactive mode.
562
563 This feature is especially useful when "preboot" is
564 automatically generated or modified. For an example
565 see the LWMON board specific code: here "preboot" is
566 modified when the user holds down a certain
567 combination of keys on the (special) keyboard when
568 booting the systems
569
570- Serial Download Echo Mode:
571 CONFIG_LOADS_ECHO
572 If defined to 1, all characters received during a
573 serial download (using the "loads" command) are
574 echoed back. This might be needed by some terminal
575 emulations (like "cu"), but may as well just take
576 time on others. This setting #define's the initial
577 value of the "loads_echo" environment variable.
578
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500579- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000580 CONFIG_KGDB_BAUDRATE
581 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200582 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000583
584- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500585 Monitor commands can be included or excluded
586 from the build by using the #include files
587 "config_cmd_all.h" and #undef'ing unwanted
588 commands, or using "config_cmd_default.h"
589 and augmenting with additional #define's
590 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000591
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500592 The default command configuration includes all commands
593 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000594
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500595 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500596 CONFIG_CMD_BDI bdinfo
597 CONFIG_CMD_BEDBUG * Include BedBug Debugger
598 CONFIG_CMD_BMP * BMP support
599 CONFIG_CMD_BSP * Board specific commands
600 CONFIG_CMD_BOOTD bootd
601 CONFIG_CMD_CACHE * icache, dcache
602 CONFIG_CMD_CONSOLE coninfo
603 CONFIG_CMD_DATE * support for RTC, date/time...
604 CONFIG_CMD_DHCP * DHCP support
605 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600606 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
607 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
608 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
609 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500610 CONFIG_CMD_DTT * Digital Therm and Thermostat
611 CONFIG_CMD_ECHO echo arguments
612 CONFIG_CMD_EEPROM * EEPROM read/write support
613 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500614 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500615 CONFIG_CMD_FDC * Floppy Disk Support
616 CONFIG_CMD_FAT * FAT partition support
617 CONFIG_CMD_FDOS * Dos diskette Support
618 CONFIG_CMD_FLASH flinfo, erase, protect
619 CONFIG_CMD_FPGA FPGA device initialization support
620 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
621 CONFIG_CMD_I2C * I2C serial bus support
622 CONFIG_CMD_IDE * IDE harddisk support
623 CONFIG_CMD_IMI iminfo
624 CONFIG_CMD_IMLS List all found images
625 CONFIG_CMD_IMMAP * IMMR dump support
626 CONFIG_CMD_IRQ * irqinfo
627 CONFIG_CMD_ITEST Integer/string test of 2 values
628 CONFIG_CMD_JFFS2 * JFFS2 Support
629 CONFIG_CMD_KGDB * kgdb
630 CONFIG_CMD_LOADB loadb
631 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400632 CONFIG_CMD_MD5SUM print md5 message digest
633 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500634 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
635 loop, loopw, mtest
636 CONFIG_CMD_MISC Misc functions like sleep etc
637 CONFIG_CMD_MMC * MMC memory mapped support
638 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100639 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500640 CONFIG_CMD_NAND * NAND support
641 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600642 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
643 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500644 CONFIG_CMD_PCI * pciinfo
645 CONFIG_CMD_PCMCIA * PCMCIA support
646 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
647 host
648 CONFIG_CMD_PORTIO * Port I/O
649 CONFIG_CMD_REGINFO * Register dump
650 CONFIG_CMD_RUN run command in env variable
651 CONFIG_CMD_SAVES * save S record dump
652 CONFIG_CMD_SCSI * SCSI Support
653 CONFIG_CMD_SDRAM * print SDRAM configuration information
654 (requires CONFIG_CMD_I2C)
655 CONFIG_CMD_SETGETDCR Support for DCR Register access
656 (4xx only)
Robin Getz02c9aa12009-07-27 00:07:59 -0400657 CONFIG_CMD_SHA1 print sha1 memory digest
658 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200659 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500660 CONFIG_CMD_SPI * SPI serial bus support
661 CONFIG_CMD_USB * USB support
662 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500663 CONFIG_CMD_CDP * Cisco Discover Protocol support
664 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000665
wdenkc6097192002-11-03 00:24:07 +0000666
667 EXAMPLE: If you want all functions except of network
668 support you can write:
669
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500670 #include "config_cmd_all.h"
671 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000672
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400673 Other Commands:
674 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000675
676 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500677 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000678 what you (and your U-Boot users) are doing. Data
679 cache cannot be enabled on systems like the 8xx or
680 8260 (where accesses to the IMMR region must be
681 uncached), and it cannot be disabled on all other
682 systems where we (mis-) use the data cache to hold an
683 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000684
685
686 XXX - this list needs to get updated!
687
688- Watchdog:
689 CONFIG_WATCHDOG
690 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000691 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000692 code for a watchdog. For the 8xx and 8260 CPUs, the
693 SIU Watchdog feature is enabled in the SYPCR
694 register.
695
stroesec1551ea2003-04-04 15:53:41 +0000696- U-Boot Version:
697 CONFIG_VERSION_VARIABLE
698 If this variable is defined, an environment variable
699 named "ver" is created by U-Boot showing the U-Boot
700 version as printed by the "version" command.
701 This variable is readonly.
702
wdenkc6097192002-11-03 00:24:07 +0000703- Real-Time Clock:
704
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500705 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000706 has to be selected, too. Define exactly one of the
707 following options:
708
709 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
710 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200711 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000712 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000713 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000714 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000715 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000716 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100717 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000718 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200719 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000720
wdenkb37c7e52003-06-30 16:24:52 +0000721 Note that if the RTC uses I2C, then the I2C interface
722 must also be configured. See I2C Support, below.
723
Peter Tysere92739d2008-12-17 16:36:21 -0600724- GPIO Support:
725 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
726 CONFIG_PCA953X_INFO - enable pca953x info command
727
728 Note that if the GPIO device uses I2C, then the I2C interface
729 must also be configured. See I2C Support, below.
730
wdenkc6097192002-11-03 00:24:07 +0000731- Timestamp Support:
732
wdenk43d96162003-03-06 00:02:04 +0000733 When CONFIG_TIMESTAMP is selected, the timestamp
734 (date and time) of an image is printed by image
735 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500736 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000737
738- Partition Support:
739 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400740 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000741
Wolfgang Denk218ca722008-03-26 10:40:12 +0100742 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
743 CONFIG_CMD_SCSI) you must configure support for at
744 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000745
746- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000747 CONFIG_IDE_RESET_ROUTINE - this is defined in several
748 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000749
wdenk4d13cba2004-03-14 14:09:05 +0000750 CONFIG_IDE_RESET - is this is defined, IDE Reset will
751 be performed by calling the function
752 ide_set_reset(int reset)
753 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000754
755- ATAPI Support:
756 CONFIG_ATAPI
757
758 Set this to enable ATAPI support.
759
wdenkc40b2952004-03-13 23:29:43 +0000760- LBA48 Support
761 CONFIG_LBA48
762
763 Set this to enable support for disks larger than 137GB
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200764 Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
wdenkc40b2952004-03-13 23:29:43 +0000765 Whithout these , LBA48 support uses 32bit variables and will 'only'
766 support disks up to 2.1TB.
767
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200768 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000769 When enabled, makes the IDE subsystem use 64bit sector addresses.
770 Default is 32bit.
771
wdenkc6097192002-11-03 00:24:07 +0000772- SCSI Support:
773 At the moment only there is only support for the
774 SYM53C8XX SCSI controller; define
775 CONFIG_SCSI_SYM53C8XX to enable it.
776
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200777 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
778 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
779 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000780 maximum numbers of LUNs, SCSI ID's and target
781 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200782 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000783
784- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000785 CONFIG_E1000
786 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000787
Andre Schwarzac3315c2008-03-06 16:45:44 +0100788 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200789 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100790
wdenkc6097192002-11-03 00:24:07 +0000791 CONFIG_EEPRO100
792 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200793 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000794 write routine for first time initialisation.
795
796 CONFIG_TULIP
797 Support for Digital 2114x chips.
798 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
799 modem chip initialisation (KS8761/QS6611).
800
801 CONFIG_NATSEMI
802 Support for National dp83815 chips.
803
804 CONFIG_NS8382X
805 Support for National dp8382[01] gigabit chips.
806
wdenk45219c42003-05-12 21:50:16 +0000807- NETWORK Support (other):
808
809 CONFIG_DRIVER_LAN91C96
810 Support for SMSC's LAN91C96 chips.
811
812 CONFIG_LAN91C96_BASE
813 Define this to hold the physical address
814 of the LAN91C96's I/O space
815
816 CONFIG_LAN91C96_USE_32_BIT
817 Define this to enable 32 bit addressing
818
wdenkf39748a2004-06-09 13:37:52 +0000819 CONFIG_DRIVER_SMC91111
820 Support for SMSC's LAN91C111 chip
821
822 CONFIG_SMC91111_BASE
823 Define this to hold the physical address
824 of the device (I/O space)
825
826 CONFIG_SMC_USE_32_BIT
827 Define this if data bus is 32 bits
828
829 CONFIG_SMC_USE_IOFUNCS
830 Define this to use i/o functions instead of macros
831 (some hardware wont work with macros)
832
Jens Gehrlein557b3772008-05-05 14:06:11 +0200833 CONFIG_DRIVER_SMC911X
834 Support for SMSC's LAN911x and LAN921x chips
835
836 CONFIG_DRIVER_SMC911X_BASE
837 Define this to hold the physical address
838 of the device (I/O space)
839
840 CONFIG_DRIVER_SMC911X_32_BIT
841 Define this if data bus is 32 bits
842
843 CONFIG_DRIVER_SMC911X_16_BIT
844 Define this if data bus is 16 bits. If your processor
845 automatically converts one 32 bit word to two 16 bit
846 words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
847
wdenkc6097192002-11-03 00:24:07 +0000848- USB Support:
849 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000850 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000851 CONFIG_USB_UHCI to enable it.
852 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000853 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000854 storage devices.
855 Note:
856 Supported are USB Keyboards and USB Floppy drives
857 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000858 MPC5200 USB requires additional defines:
859 CONFIG_USB_CLOCK
860 for 528 MHz Clock: 0x0001bbbb
861 CONFIG_USB_CONFIG
862 for differential drivers: 0x00001000
863 for single ended drivers: 0x00005000
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200864 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200865 May be defined to allow interrupt polling
866 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000867
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200868- USB Device:
869 Define the below if you wish to use the USB console.
870 Once firmware is rebuilt from a serial console issue the
871 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200872 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200873 it has found a new device. The environment variable usbtty
874 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200875 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200876 Common Device Class Abstract Control Model serial device.
877 If you select usbtty = gserial you should be able to enumerate
878 a Linux host by
879 # modprobe usbserial vendor=0xVendorID product=0xProductID
880 else if using cdc_acm, simply setting the environment
881 variable usbtty to be cdc_acm should suffice. The following
882 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200883
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200884 CONFIG_USB_DEVICE
885 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000886
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200887 CONFIG_USB_TTY
888 Define this to have a tty type of device available to
889 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200890
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200891 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200892 Define this if you want stdin, stdout &/or stderr to
893 be set to usbtty.
894
895 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200896 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200897 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200898 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200900 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200901 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200902 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200903
Wolfgang Denk386eda02006-06-14 18:14:56 +0200904 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200905 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200906 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200907 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
908 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
909 should pretend to be a Linux device to it's target host.
910
911 CONFIG_USBD_MANUFACTURER
912 Define this string as the name of your company for
913 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200914
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200915 CONFIG_USBD_PRODUCT_NAME
916 Define this string as the name of your product
917 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
918
919 CONFIG_USBD_VENDORID
920 Define this as your assigned Vendor ID from the USB
921 Implementors Forum. This *must* be a genuine Vendor ID
922 to avoid polluting the USB namespace.
923 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200924
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200925 CONFIG_USBD_PRODUCTID
926 Define this as the unique Product ID
927 for your device
928 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000929
930
931- MMC Support:
932 The MMC controller on the Intel PXA is supported. To
933 enable this define CONFIG_MMC. The MMC can be
934 accessed from the boot prompt by mapping the device
935 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500936 enabled with CONFIG_CMD_MMC. The MMC driver also works with
937 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000938
wdenk6705d812004-08-02 23:22:59 +0000939- Journaling Flash filesystem support:
940 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
941 CONFIG_JFFS2_NAND_DEV
942 Define these for a default partition on a NAND device
943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200944 CONFIG_SYS_JFFS2_FIRST_SECTOR,
945 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +0000946 Define these for a default partition on a NOR device
947
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200948 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +0000949 Define this to create an own partition. You have to provide a
950 function struct part_info* jffs2_part_info(int part_num)
951
952 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200953 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +0000954 to disable the command chpart. This is the default when you
955 have not defined a custom partition
956
wdenkc6097192002-11-03 00:24:07 +0000957- Keyboard Support:
958 CONFIG_ISA_KEYBOARD
959
960 Define this to enable standard (PC-Style) keyboard
961 support
962
963 CONFIG_I8042_KBD
964 Standard PC keyboard driver with US (is default) and
965 GERMAN key layout (switch via environment 'keymap=de') support.
966 Export function i8042_kbd_init, i8042_tstc and i8042_getc
967 for cfb_console. Supports cursor blinking.
968
969- Video support:
970 CONFIG_VIDEO
971
972 Define this to enable video support (for output to
973 video).
974
975 CONFIG_VIDEO_CT69000
976
977 Enable Chips & Technologies 69000 Video chip
978
979 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000980 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000981 video output is selected via environment 'videoout'
982 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
983 assumed.
wdenkc6097192002-11-03 00:24:07 +0000984
wdenkb79a11c2004-03-25 15:14:43 +0000985 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200986 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +0000987 are possible:
988 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000989 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000990
991 Colors 640x480 800x600 1024x768 1152x864 1280x1024
992 -------------+---------------------------------------------
993 8 bits | 0x301* 0x303 0x305 0x161 0x307
994 15 bits | 0x310 0x313 0x316 0x162 0x319
995 16 bits | 0x311 0x314 0x317 0x163 0x31A
996 24 bits | 0x312 0x315 0x318 ? 0x31B
997 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000998 (i.e. setenv videomode 317; saveenv; reset;)
999
wdenkb79a11c2004-03-25 15:14:43 +00001000 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001001 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001002
1003
stroesec1551ea2003-04-04 15:53:41 +00001004 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001005 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001006 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1007 or CONFIG_VIDEO_SED13806_16BPP
1008
wdenk682011f2003-06-03 23:54:09 +00001009- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001010 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001011
wdenk8bde7f72003-06-27 21:31:46 +00001012 Define this to enable a custom keyboard support.
1013 This simply calls drv_keyboard_init() which must be
1014 defined in your board-specific files.
1015 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001016
wdenkc6097192002-11-03 00:24:07 +00001017- LCD Support: CONFIG_LCD
1018
1019 Define this to enable LCD support (for output to LCD
1020 display); also select one of the supported displays
1021 by defining one of these:
1022
Stelian Pop39cf4802008-05-09 21:57:18 +02001023 CONFIG_ATMEL_LCD:
1024
1025 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1026
wdenkfd3103b2003-11-25 16:55:19 +00001027 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001028
wdenkfd3103b2003-11-25 16:55:19 +00001029 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001030
wdenkfd3103b2003-11-25 16:55:19 +00001031 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001032
wdenkfd3103b2003-11-25 16:55:19 +00001033 NEC NL6448BC20-08. 6.5", 640x480.
1034 Active, color, single scan.
1035
1036 CONFIG_NEC_NL6448BC33_54
1037
1038 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001039 Active, color, single scan.
1040
1041 CONFIG_SHARP_16x9
1042
1043 Sharp 320x240. Active, color, single scan.
1044 It isn't 16x9, and I am not sure what it is.
1045
1046 CONFIG_SHARP_LQ64D341
1047
1048 Sharp LQ64D341 display, 640x480.
1049 Active, color, single scan.
1050
1051 CONFIG_HLD1045
1052
1053 HLD1045 display, 640x480.
1054 Active, color, single scan.
1055
1056 CONFIG_OPTREX_BW
1057
1058 Optrex CBL50840-2 NF-FW 99 22 M5
1059 or
1060 Hitachi LMG6912RPFC-00T
1061 or
1062 Hitachi SP14Q002
1063
1064 320x240. Black & white.
1065
1066 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001067 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001068
wdenk7152b1d2003-09-05 23:19:14 +00001069- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001070
wdenk8bde7f72003-06-27 21:31:46 +00001071 If this option is set, the environment is checked for
1072 a variable "splashimage". If found, the usual display
1073 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001074 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001075 specified in "splashimage" is loaded instead. The
1076 console is redirected to the "nulldev", too. This
1077 allows for a "silent" boot where a splash screen is
1078 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001079
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001080 CONFIG_SPLASH_SCREEN_ALIGN
1081
1082 If this option is set the splash image can be freely positioned
1083 on the screen. Environment variable "splashpos" specifies the
1084 position as "x,y". If a positive number is given it is used as
1085 number of pixel from left/top. If a negative number is given it
1086 is used as number of pixel from right/bottom. You can also
1087 specify 'm' for centering the image.
1088
1089 Example:
1090 setenv splashpos m,m
1091 => image at center of screen
1092
1093 setenv splashpos 30,20
1094 => image at x = 30 and y = 20
1095
1096 setenv splashpos -10,m
1097 => vertically centered image
1098 at x = dspWidth - bmpWidth - 9
1099
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001100- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1101
1102 If this option is set, additionally to standard BMP
1103 images, gzipped BMP images can be displayed via the
1104 splashscreen support or the bmp command.
1105
wdenkc29fdfc2003-08-29 20:57:53 +00001106- Compression support:
1107 CONFIG_BZIP2
1108
1109 If this option is set, support for bzip2 compressed
1110 images is included. If not, only uncompressed and gzip
1111 compressed images are supported.
1112
wdenk42d1f032003-10-15 23:53:47 +00001113 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001114 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001115 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001116
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001117 CONFIG_LZMA
1118
1119 If this option is set, support for lzma compressed
1120 images is included.
1121
1122 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1123 requires an amount of dynamic memory that is given by the
1124 formula:
1125
1126 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1127
1128 Where lc and lp stand for, respectively, Literal context bits
1129 and Literal pos bits.
1130
1131 This value is upper-bounded by 14MB in the worst case. Anyway,
1132 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1133 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1134 a very small buffer.
1135
1136 Use the lzmainfo tool to determinate the lc and lp values and
1137 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001138 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001139
wdenk17ea1172004-06-06 21:51:03 +00001140- MII/PHY support:
1141 CONFIG_PHY_ADDR
1142
1143 The address of PHY on MII bus.
1144
1145 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1146
1147 The clock frequency of the MII bus
1148
1149 CONFIG_PHY_GIGE
1150
1151 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001152 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001153
1154 CONFIG_PHY_RESET_DELAY
1155
1156 Some PHY like Intel LXT971A need extra delay after
1157 reset before any MII register access is possible.
1158 For such PHY, set this option to the usec delay
1159 required. (minimum 300usec for LXT971A)
1160
1161 CONFIG_PHY_CMD_DELAY (ppc4xx)
1162
1163 Some PHY like Intel LXT971A need extra delay after
1164 command issued before MII status register can be read
1165
wdenkc6097192002-11-03 00:24:07 +00001166- Ethernet address:
1167 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001168 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001169 CONFIG_ETH2ADDR
1170 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001171 CONFIG_ETH4ADDR
1172 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001173
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001174 Define a default value for Ethernet address to use
1175 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001176 is not determined automatically.
1177
1178- IP address:
1179 CONFIG_IPADDR
1180
1181 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001182 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001183 determined through e.g. bootp.
1184
1185- Server IP address:
1186 CONFIG_SERVERIP
1187
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001188 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001189 server to contact when using the "tftboot" command.
1190
Robin Getz97cfe862009-07-21 12:15:28 -04001191 CONFIG_KEEP_SERVERADDR
1192
1193 Keeps the server's MAC address, in the env 'serveraddr'
1194 for passing to bootargs (like Linux's netconsole option)
1195
David Updegraff53a5c422007-06-11 10:41:07 -05001196- Multicast TFTP Mode:
1197 CONFIG_MCAST_TFTP
1198
1199 Defines whether you want to support multicast TFTP as per
1200 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001201 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001202 driver in use must provide a function: mcast() to join/leave a
1203 multicast group.
1204
1205 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001206- BOOTP Recovery Mode:
1207 CONFIG_BOOTP_RANDOM_DELAY
1208
1209 If you have many targets in a network that try to
1210 boot using BOOTP, you may want to avoid that all
1211 systems send out BOOTP requests at precisely the same
1212 moment (which would happen for instance at recovery
1213 from a power failure, when all systems will try to
1214 boot, thus flooding the BOOTP server. Defining
1215 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1216 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001217 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001218
1219 1st BOOTP request: delay 0 ... 1 sec
1220 2nd BOOTP request: delay 0 ... 2 sec
1221 3rd BOOTP request: delay 0 ... 4 sec
1222 4th and following
1223 BOOTP requests: delay 0 ... 8 sec
1224
stroesefe389a82003-08-28 14:17:32 +00001225- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001226 You can fine tune the DHCP functionality by defining
1227 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001228
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001229 CONFIG_BOOTP_SUBNETMASK
1230 CONFIG_BOOTP_GATEWAY
1231 CONFIG_BOOTP_HOSTNAME
1232 CONFIG_BOOTP_NISDOMAIN
1233 CONFIG_BOOTP_BOOTPATH
1234 CONFIG_BOOTP_BOOTFILESIZE
1235 CONFIG_BOOTP_DNS
1236 CONFIG_BOOTP_DNS2
1237 CONFIG_BOOTP_SEND_HOSTNAME
1238 CONFIG_BOOTP_NTPSERVER
1239 CONFIG_BOOTP_TIMEOFFSET
1240 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001241
Wilson Callan5d110f02007-07-28 10:56:13 -04001242 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1243 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001244
1245 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1246 serverip from a DHCP server, it is possible that more
1247 than one DNS serverip is offered to the client.
1248 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1249 serverip will be stored in the additional environment
1250 variable "dnsip2". The first DNS serverip is always
1251 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001252 is defined.
stroesefe389a82003-08-28 14:17:32 +00001253
1254 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1255 to do a dynamic update of a DNS server. To do this, they
1256 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001257 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001258 of the "hostname" environment variable is passed as
1259 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001260
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001261 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1262
1263 A 32bit value in microseconds for a delay between
1264 receiving a "DHCP Offer" and sending the "DHCP Request".
1265 This fixes a problem with certain DHCP servers that don't
1266 respond 100% of the time to a "DHCP request". E.g. On an
1267 AT91RM9200 processor running at 180MHz, this delay needed
1268 to be *at least* 15,000 usec before a Windows Server 2003
1269 DHCP server would reply 100% of the time. I recommend at
1270 least 50,000 usec to be safe. The alternative is to hope
1271 that one of the retries will be successful but note that
1272 the DHCP timeout and retry process takes a longer than
1273 this delay.
1274
wdenka3d991b2004-04-15 21:48:45 +00001275 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001276 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001277
1278 The device id used in CDP trigger frames.
1279
1280 CONFIG_CDP_DEVICE_ID_PREFIX
1281
1282 A two character string which is prefixed to the MAC address
1283 of the device.
1284
1285 CONFIG_CDP_PORT_ID
1286
1287 A printf format string which contains the ascii name of
1288 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001289 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001290
1291 CONFIG_CDP_CAPABILITIES
1292
1293 A 32bit integer which indicates the device capabilities;
1294 0x00000010 for a normal host which does not forwards.
1295
1296 CONFIG_CDP_VERSION
1297
1298 An ascii string containing the version of the software.
1299
1300 CONFIG_CDP_PLATFORM
1301
1302 An ascii string containing the name of the platform.
1303
1304 CONFIG_CDP_TRIGGER
1305
1306 A 32bit integer sent on the trigger.
1307
1308 CONFIG_CDP_POWER_CONSUMPTION
1309
1310 A 16bit integer containing the power consumption of the
1311 device in .1 of milliwatts.
1312
1313 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1314
1315 A byte containing the id of the VLAN.
1316
wdenkc6097192002-11-03 00:24:07 +00001317- Status LED: CONFIG_STATUS_LED
1318
1319 Several configurations allow to display the current
1320 status using a LED. For instance, the LED will blink
1321 fast while running U-Boot code, stop blinking as
1322 soon as a reply to a BOOTP request was received, and
1323 start blinking slow once the Linux kernel is running
1324 (supported by a status LED driver in the Linux
1325 kernel). Defining CONFIG_STATUS_LED enables this
1326 feature in U-Boot.
1327
1328- CAN Support: CONFIG_CAN_DRIVER
1329
1330 Defining CONFIG_CAN_DRIVER enables CAN driver support
1331 on those systems that support this (optional)
1332 feature, like the TQM8xxL modules.
1333
1334- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1335
wdenkb37c7e52003-06-30 16:24:52 +00001336 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001337 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001338 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001339
wdenk945af8d2003-07-16 21:53:01 +00001340 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001341 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001342 CONFIG_COMMANDS) and communicate with i2c based realtime
1343 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001344 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001345
Ben Warrenbb99ad62006-09-07 16:50:54 -04001346 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001347
wdenk945af8d2003-07-16 21:53:01 +00001348 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001349 bit-banging) driver instead of CPM or similar hardware
1350 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001351
wdenk945af8d2003-07-16 21:53:01 +00001352 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001353 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001355 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001356 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001357 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001358 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001359
wdenkb37c7e52003-06-30 16:24:52 +00001360 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001361 sets the CPU up as a master node and so its address should
wdenkb37c7e52003-06-30 16:24:52 +00001362 therefore be cleared to 0 (See, eg, MPC823e User's Manual
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001363 p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001364
wdenk945af8d2003-07-16 21:53:01 +00001365 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001366
1367 If you use the software i2c interface (CONFIG_SOFT_I2C)
1368 then the following macros need to be defined (examples are
1369 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001370
1371 I2C_INIT
1372
wdenkb37c7e52003-06-30 16:24:52 +00001373 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001374 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001375
wdenkba56f622004-02-06 23:19:44 +00001376 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001377
wdenkc6097192002-11-03 00:24:07 +00001378 I2C_PORT
1379
wdenk43d96162003-03-06 00:02:04 +00001380 (Only for MPC8260 CPU). The I/O port to use (the code
1381 assumes both bits are on the same port). Valid values
1382 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001383
1384 I2C_ACTIVE
1385
1386 The code necessary to make the I2C data line active
1387 (driven). If the data line is open collector, this
1388 define can be null.
1389
wdenkb37c7e52003-06-30 16:24:52 +00001390 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1391
wdenkc6097192002-11-03 00:24:07 +00001392 I2C_TRISTATE
1393
1394 The code necessary to make the I2C data line tri-stated
1395 (inactive). If the data line is open collector, this
1396 define can be null.
1397
wdenkb37c7e52003-06-30 16:24:52 +00001398 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1399
wdenkc6097192002-11-03 00:24:07 +00001400 I2C_READ
1401
1402 Code that returns TRUE if the I2C data line is high,
1403 FALSE if it is low.
1404
wdenkb37c7e52003-06-30 16:24:52 +00001405 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1406
wdenkc6097192002-11-03 00:24:07 +00001407 I2C_SDA(bit)
1408
1409 If <bit> is TRUE, sets the I2C data line high. If it
1410 is FALSE, it clears it (low).
1411
wdenkb37c7e52003-06-30 16:24:52 +00001412 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001413 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001414 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001415
wdenkc6097192002-11-03 00:24:07 +00001416 I2C_SCL(bit)
1417
1418 If <bit> is TRUE, sets the I2C clock line high. If it
1419 is FALSE, it clears it (low).
1420
wdenkb37c7e52003-06-30 16:24:52 +00001421 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001422 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001423 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001424
wdenkc6097192002-11-03 00:24:07 +00001425 I2C_DELAY
1426
1427 This delay is invoked four times per clock cycle so this
1428 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001429 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001430 like:
1431
wdenkb37c7e52003-06-30 16:24:52 +00001432 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001433
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001434 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001435
wdenk8bde7f72003-06-27 21:31:46 +00001436 When a board is reset during an i2c bus transfer
1437 chips might think that the current transfer is still
1438 in progress. On some boards it is possible to access
1439 the i2c SCLK line directly, either by using the
1440 processor pin as a GPIO or by having a second pin
1441 connected to the bus. If this option is defined a
1442 custom i2c_init_board() routine in boards/xxx/board.c
1443 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001444
wdenk17ea1172004-06-06 21:51:03 +00001445 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1446
1447 This option enables configuration of bi_iic_fast[] flags
1448 in u-boot bd_info structure based on u-boot environment
1449 variable "i2cfast". (see also i2cfast)
1450
Ben Warrenbb99ad62006-09-07 16:50:54 -04001451 CONFIG_I2C_MULTI_BUS
1452
1453 This option allows the use of multiple I2C buses, each of which
1454 must have a controller. At any point in time, only one bus is
1455 active. To switch to a different bus, use the 'i2c dev' command.
1456 Note that bus numbering is zero-based.
1457
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001458 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001459
1460 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001461 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1462 is set, specify a list of bus-device pairs. Otherwise, specify
1463 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001464
1465 e.g.
1466 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001467 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001468
1469 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1470
1471 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001472 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001473
1474 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1475
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001476 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001477
1478 If defined, then this indicates the I2C bus number for DDR SPD.
1479 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001481 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001482
1483 If defined, then this indicates the I2C bus number for the RTC.
1484 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1485
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001486 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001487
1488 If defined, then this indicates the I2C bus number for the DTT.
1489 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001491 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001492
1493 If defined, specifies the I2C address of the DTT device.
1494 If not defined, then U-Boot uses predefined value for
1495 specified DTT device.
1496
Timur Tabibe5e6182006-11-03 19:15:00 -06001497 CONFIG_FSL_I2C
1498
1499 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001500 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001501
Heiko Schocher67b23a32008-10-15 09:39:47 +02001502 CONFIG_I2C_MUX
1503
1504 Define this option if you have I2C devices reached over 1 .. n
1505 I2C Muxes like the pca9544a. This option addes a new I2C
1506 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1507 new I2C Bus to the existing I2C Busses. If you select the
1508 new Bus with "i2c dev", u-bbot sends first the commandos for
1509 the muxes to activate this new "bus".
1510
1511 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1512 feature!
1513
1514 Example:
1515 Adding a new I2C Bus reached over 2 pca9544a muxes
1516 The First mux with address 70 and channel 6
1517 The Second mux with address 71 and channel 4
1518
1519 => i2c bus pca9544a:70:6:pca9544a:71:4
1520
1521 Use the "i2c bus" command without parameter, to get a list
1522 of I2C Busses with muxes:
1523
1524 => i2c bus
1525 Busses reached over muxes:
1526 Bus ID: 2
1527 reached over Mux(es):
1528 pca9544a@70 ch: 4
1529 Bus ID: 3
1530 reached over Mux(es):
1531 pca9544a@70 ch: 6
1532 pca9544a@71 ch: 4
1533 =>
1534
1535 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1536 u-boot sends First the Commando to the mux@70 to enable
1537 channel 6, and then the Commando to the mux@71 to enable
1538 the channel 4.
1539
1540 After that, you can use the "normal" i2c commands as
1541 usual, to communicate with your I2C devices behind
1542 the 2 muxes.
1543
1544 This option is actually implemented for the bitbanging
1545 algorithm in common/soft_i2c.c and for the Hardware I2C
1546 Bus on the MPC8260. But it should be not so difficult
1547 to add this option to other architectures.
1548
Andrew Dyer2ac69852008-12-29 17:36:01 -06001549 CONFIG_SOFT_I2C_READ_REPEATED_START
1550
1551 defining this will force the i2c_read() function in
1552 the soft_i2c driver to perform an I2C repeated start
1553 between writing the address pointer and reading the
1554 data. If this define is omitted the default behaviour
1555 of doing a stop-start sequence will be used. Most I2C
1556 devices can use either method, but some require one or
1557 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001558
wdenkc6097192002-11-03 00:24:07 +00001559- SPI Support: CONFIG_SPI
1560
1561 Enables SPI driver (so far only tested with
1562 SPI EEPROM, also an instance works with Crystal A/D and
1563 D/As on the SACSng board)
1564
1565 CONFIG_SPI_X
1566
1567 Enables extended (16-bit) SPI EEPROM addressing.
1568 (symmetrical to CONFIG_I2C_X)
1569
1570 CONFIG_SOFT_SPI
1571
wdenk43d96162003-03-06 00:02:04 +00001572 Enables a software (bit-bang) SPI driver rather than
1573 using hardware support. This is a general purpose
1574 driver that only requires three general I/O port pins
1575 (two outputs, one input) to function. If this is
1576 defined, the board configuration must define several
1577 SPI configuration items (port pins to use, etc). For
1578 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001579
Ben Warren04a9e112008-01-16 22:37:35 -05001580 CONFIG_HARD_SPI
1581
1582 Enables a hardware SPI driver for general-purpose reads
1583 and writes. As with CONFIG_SOFT_SPI, the board configuration
1584 must define a list of chip-select function pointers.
1585 Currently supported on some MPC8xxx processors. For an
1586 example, see include/configs/mpc8349emds.h.
1587
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001588 CONFIG_MXC_SPI
1589
1590 Enables the driver for the SPI controllers on i.MX and MXC
1591 SoCs. Currently only i.MX31 is supported.
1592
Matthias Fuchs01335022007-12-27 17:12:34 +01001593- FPGA Support: CONFIG_FPGA
1594
1595 Enables FPGA subsystem.
1596
1597 CONFIG_FPGA_<vendor>
1598
1599 Enables support for specific chip vendors.
1600 (ALTERA, XILINX)
1601
1602 CONFIG_FPGA_<family>
1603
1604 Enables support for FPGA family.
1605 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1606
1607 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001608
wdenk43d96162003-03-06 00:02:04 +00001609 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001611 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001612
wdenk8bde7f72003-06-27 21:31:46 +00001613 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001615 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001616
wdenk43d96162003-03-06 00:02:04 +00001617 Enable checks on FPGA configuration interface busy
1618 status by the configuration function. This option
1619 will require a board or device specific function to
1620 be written.
wdenkc6097192002-11-03 00:24:07 +00001621
1622 CONFIG_FPGA_DELAY
1623
1624 If defined, a function that provides delays in the FPGA
1625 configuration driver.
1626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001627 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001628 Allow Control-C to interrupt FPGA configuration
1629
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001630 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001631
wdenk43d96162003-03-06 00:02:04 +00001632 Check for configuration errors during FPGA bitfile
1633 loading. For example, abort during Virtex II
1634 configuration if the INIT_B line goes low (which
1635 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001636
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001637 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001638
wdenk43d96162003-03-06 00:02:04 +00001639 Maximum time to wait for the INIT_B line to deassert
1640 after PROB_B has been deasserted during a Virtex II
1641 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001642 ms.
wdenkc6097192002-11-03 00:24:07 +00001643
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001644 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001645
wdenk43d96162003-03-06 00:02:04 +00001646 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001647 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001648
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001649 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001650
wdenk43d96162003-03-06 00:02:04 +00001651 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001652 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001653
1654- Configuration Management:
1655 CONFIG_IDENT_STRING
1656
wdenk43d96162003-03-06 00:02:04 +00001657 If defined, this string will be added to the U-Boot
1658 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001659
1660- Vendor Parameter Protection:
1661
wdenk43d96162003-03-06 00:02:04 +00001662 U-Boot considers the values of the environment
1663 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001664 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001665 are set once by the board vendor / manufacturer, and
1666 protects these variables from casual modification by
1667 the user. Once set, these variables are read-only,
1668 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001669 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001670
1671 If CONFIG_ENV_OVERWRITE is #defined in your config
1672 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001673 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001674 these parameters.
1675
1676 Alternatively, if you #define _both_ CONFIG_ETHADDR
1677 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001678 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001679 which can be changed exactly ONCE by the user. [The
1680 serial# is unaffected by this, i. e. it remains
1681 read-only.]
1682
1683- Protected RAM:
1684 CONFIG_PRAM
1685
1686 Define this variable to enable the reservation of
1687 "protected RAM", i. e. RAM which is not overwritten
1688 by U-Boot. Define CONFIG_PRAM to hold the number of
1689 kB you want to reserve for pRAM. You can overwrite
1690 this default value by defining an environment
1691 variable "pram" to the number of kB you want to
1692 reserve. Note that the board info structure will
1693 still show the full amount of RAM. If pRAM is
1694 reserved, a new environment variable "mem" will
1695 automatically be defined to hold the amount of
1696 remaining RAM in a form that can be passed as boot
1697 argument to Linux, for instance like that:
1698
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001699 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001700 saveenv
1701
1702 This way you can tell Linux not to use this memory,
1703 either, which results in a memory region that will
1704 not be affected by reboots.
1705
1706 *WARNING* If your board configuration uses automatic
1707 detection of the RAM size, you must make sure that
1708 this memory test is non-destructive. So far, the
1709 following board configurations are known to be
1710 "pRAM-clean":
1711
1712 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1713 HERMES, IP860, RPXlite, LWMON, LANTEC,
1714 PCU_E, FLAGADM, TQM8260
1715
1716- Error Recovery:
1717 CONFIG_PANIC_HANG
1718
1719 Define this variable to stop the system in case of a
1720 fatal error, so that you have to reset it manually.
1721 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001722 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001723 automatically as fast as possible, but it may be
1724 useful during development since you can try to debug
1725 the conditions that lead to the situation.
1726
1727 CONFIG_NET_RETRY_COUNT
1728
wdenk43d96162003-03-06 00:02:04 +00001729 This variable defines the number of retries for
1730 network operations like ARP, RARP, TFTP, or BOOTP
1731 before giving up the operation. If not defined, a
1732 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001733
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001734 CONFIG_ARP_TIMEOUT
1735
1736 Timeout waiting for an ARP reply in milliseconds.
1737
wdenkc6097192002-11-03 00:24:07 +00001738- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001739 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001740
1741 Enable auto completion of commands using TAB.
1742
Wolfgang Denka9398e02006-11-27 15:32:42 +01001743 Note that this feature has NOT been implemented yet
1744 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001745
1746
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001747 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001748
1749 Define this variable to enable the "hush" shell (from
1750 Busybox) as command line interpreter, thus enabling
1751 powerful command line syntax like
1752 if...then...else...fi conditionals or `&&' and '||'
1753 constructs ("shell scripts").
1754
1755 If undefined, you get the old, much simpler behaviour
1756 with a somewhat smaller memory footprint.
1757
1758
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001759 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001760
1761 This defines the secondary prompt string, which is
1762 printed when the command interpreter needs more input
1763 to complete a command. Usually "> ".
1764
1765 Note:
1766
wdenk8bde7f72003-06-27 21:31:46 +00001767 In the current implementation, the local variables
1768 space and global environment variables space are
1769 separated. Local variables are those you define by
1770 simply typing `name=value'. To access a local
1771 variable later on, you have write `$name' or
1772 `${name}'; to execute the contents of a variable
1773 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001774
wdenk43d96162003-03-06 00:02:04 +00001775 Global environment variables are those you use
1776 setenv/printenv to work with. To run a command stored
1777 in such a variable, you need to use the run command,
1778 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001779
1780 To store commands and special characters in a
1781 variable, please use double quotation marks
1782 surrounding the whole text of the variable, instead
1783 of the backslashes before semicolons and special
1784 symbols.
1785
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001786- Commandline Editing and History:
1787 CONFIG_CMDLINE_EDITING
1788
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001789 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001790 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001791
wdenka8c7c702003-12-06 19:49:23 +00001792- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001793 CONFIG_EXTRA_ENV_SETTINGS
1794
wdenk43d96162003-03-06 00:02:04 +00001795 Define this to contain any number of null terminated
1796 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001797 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001798
wdenk43d96162003-03-06 00:02:04 +00001799 For example, place something like this in your
1800 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001801
1802 #define CONFIG_EXTRA_ENV_SETTINGS \
1803 "myvar1=value1\0" \
1804 "myvar2=value2\0"
1805
wdenk43d96162003-03-06 00:02:04 +00001806 Warning: This method is based on knowledge about the
1807 internal format how the environment is stored by the
1808 U-Boot code. This is NOT an official, exported
1809 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001810 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001811 You better know what you are doing here.
1812
wdenk43d96162003-03-06 00:02:04 +00001813 Note: overly (ab)use of the default environment is
1814 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001815 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001816 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001817
wdenka8c7c702003-12-06 19:49:23 +00001818- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001819 CONFIG_HAS_DATAFLASH
1820
wdenk8bde7f72003-06-27 21:31:46 +00001821 Defining this option enables DataFlash features and
1822 allows to read/write in Dataflash via the standard
1823 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001824
wdenk3f85ce22004-02-23 16:11:30 +00001825- SystemACE Support:
1826 CONFIG_SYSTEMACE
1827
1828 Adding this option adds support for Xilinx SystemACE
1829 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001830 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001831 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001832
1833 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001834 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001835
1836 When SystemACE support is added, the "ace" device type
1837 becomes available to the fat commands, i.e. fatls.
1838
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001839- TFTP Fixed UDP Port:
1840 CONFIG_TFTP_PORT
1841
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001842 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001843 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001844 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001845 number generator is used.
1846
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001847 Also, the environment variable tftpdstp is used to supply
1848 the TFTP UDP destination port value. If tftpdstp isn't
1849 defined, the normal port 69 is used.
1850
1851 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001852 blindly start the TFTP transfer using the pre-configured
1853 target IP address and UDP port. This has the effect of
1854 "punching through" the (Windows XP) firewall, allowing
1855 the remainder of the TFTP transfer to proceed normally.
1856 A better solution is to properly configure the firewall,
1857 but sometimes that is not allowed.
1858
wdenka8c7c702003-12-06 19:49:23 +00001859- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001860 CONFIG_SHOW_BOOT_PROGRESS
1861
wdenk43d96162003-03-06 00:02:04 +00001862 Defining this option allows to add some board-
1863 specific code (calling a user-provided function
1864 "show_boot_progress(int)") that enables you to show
1865 the system's boot progress on some display (for
1866 example, some LED's) on your board. At the moment,
1867 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001868
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02001869- Automatic software updates via TFTP server
1870 CONFIG_UPDATE_TFTP
1871 CONFIG_UPDATE_TFTP_CNT_MAX
1872 CONFIG_UPDATE_TFTP_MSEC_MAX
1873
1874 These options enable and control the auto-update feature;
1875 for a more detailed description refer to doc/README.update.
1876
Stefan Roesed5581072009-05-12 14:31:18 +02001877- MTD Support (mtdparts command, UBI support)
1878 CONFIG_MTD_DEVICE
1879
1880 Adds the MTD device infrastructure from the Linux kernel.
1881 Needed for mtdparts command support.
1882
1883 CONFIG_MTD_PARTITIONS
1884
1885 Adds the MTD partitioning infrastructure from the Linux
1886 kernel. Needed for UBI support.
1887
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001888Legacy uImage format:
1889
wdenkc6097192002-11-03 00:24:07 +00001890 Arg Where When
1891 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001892 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001893 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001894 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001895 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001896 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001897 4 common/cmd_bootm.c Image data has correct checksum
1898 -4 common/cmd_bootm.c Image is for unsupported architecture
1899 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001900 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001901 6 common/cmd_bootm.c Image Type check OK
1902 -6 common/cmd_bootm.c gunzip uncompression error
1903 -7 common/cmd_bootm.c Unimplemented compression type
1904 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001905 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001906 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001907
1908 9 common/image.c Start initial ramdisk verification
1909 -10 common/image.c Ramdisk header has bad magic number
1910 -11 common/image.c Ramdisk header has bad checksum
1911 10 common/image.c Ramdisk header is OK
1912 -12 common/image.c Ramdisk data has bad checksum
1913 11 common/image.c Ramdisk data has correct checksum
1914 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001915 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001916 13 common/image.c Start multifile image verification
1917 14 common/image.c No initial ramdisk, no multifile, continue.
1918
1919 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001920
wdenk11dadd52004-02-27 00:07:27 +00001921 -30 lib_ppc/board.c Fatal error, hang the system
1922 -31 post/post.c POST test failed, detected by post_output_backlog()
1923 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001924
Heiko Schocher566a4942007-06-22 19:11:54 +02001925 34 common/cmd_doc.c before loading a Image from a DOC device
1926 -35 common/cmd_doc.c Bad usage of "doc" command
1927 35 common/cmd_doc.c correct usage of "doc" command
1928 -36 common/cmd_doc.c No boot device
1929 36 common/cmd_doc.c correct boot device
1930 -37 common/cmd_doc.c Unknown Chip ID on boot device
1931 37 common/cmd_doc.c correct chip ID found, device available
1932 -38 common/cmd_doc.c Read Error on boot device
1933 38 common/cmd_doc.c reading Image header from DOC device OK
1934 -39 common/cmd_doc.c Image header has bad magic number
1935 39 common/cmd_doc.c Image header has correct magic number
1936 -40 common/cmd_doc.c Error reading Image from DOC device
1937 40 common/cmd_doc.c Image header has correct magic number
1938 41 common/cmd_ide.c before loading a Image from a IDE device
1939 -42 common/cmd_ide.c Bad usage of "ide" command
1940 42 common/cmd_ide.c correct usage of "ide" command
1941 -43 common/cmd_ide.c No boot device
1942 43 common/cmd_ide.c boot device found
1943 -44 common/cmd_ide.c Device not available
1944 44 common/cmd_ide.c Device available
1945 -45 common/cmd_ide.c wrong partition selected
1946 45 common/cmd_ide.c partition selected
1947 -46 common/cmd_ide.c Unknown partition table
1948 46 common/cmd_ide.c valid partition table found
1949 -47 common/cmd_ide.c Invalid partition type
1950 47 common/cmd_ide.c correct partition type
1951 -48 common/cmd_ide.c Error reading Image Header on boot device
1952 48 common/cmd_ide.c reading Image Header from IDE device OK
1953 -49 common/cmd_ide.c Image header has bad magic number
1954 49 common/cmd_ide.c Image header has correct magic number
1955 -50 common/cmd_ide.c Image header has bad checksum
1956 50 common/cmd_ide.c Image header has correct checksum
1957 -51 common/cmd_ide.c Error reading Image from IDE device
1958 51 common/cmd_ide.c reading Image from IDE device OK
1959 52 common/cmd_nand.c before loading a Image from a NAND device
1960 -53 common/cmd_nand.c Bad usage of "nand" command
1961 53 common/cmd_nand.c correct usage of "nand" command
1962 -54 common/cmd_nand.c No boot device
1963 54 common/cmd_nand.c boot device found
1964 -55 common/cmd_nand.c Unknown Chip ID on boot device
1965 55 common/cmd_nand.c correct chip ID found, device available
1966 -56 common/cmd_nand.c Error reading Image Header on boot device
1967 56 common/cmd_nand.c reading Image Header from NAND device OK
1968 -57 common/cmd_nand.c Image header has bad magic number
1969 57 common/cmd_nand.c Image header has correct magic number
1970 -58 common/cmd_nand.c Error reading Image from NAND device
1971 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00001972
Heiko Schocher566a4942007-06-22 19:11:54 +02001973 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001974
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001975 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02001976 -64 net/eth.c no Ethernet found.
1977 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00001978
Heiko Schocher566a4942007-06-22 19:11:54 +02001979 -80 common/cmd_net.c usage wrong
1980 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001981 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02001982 81 common/cmd_net.c NetLoop() back without error
1983 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1984 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001985 83 common/cmd_net.c running "source" command
1986 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02001987 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00001988
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001989FIT uImage format:
1990
1991 Arg Where When
1992 100 common/cmd_bootm.c Kernel FIT Image has correct format
1993 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1994 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1995 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1996 102 common/cmd_bootm.c Kernel unit name specified
1997 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01001998 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001999 104 common/cmd_bootm.c Got kernel subimage node offset
2000 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2001 105 common/cmd_bootm.c Kernel subimage hash verification OK
2002 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2003 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002004 -106 common/cmd_bootm.c Kernel subimage has wrong type
2005 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002006 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2007 108 common/cmd_bootm.c Got kernel subimage data/size
2008 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2009 -109 common/cmd_bootm.c Can't get kernel subimage type
2010 -110 common/cmd_bootm.c Can't get kernel subimage comp
2011 -111 common/cmd_bootm.c Can't get kernel subimage os
2012 -112 common/cmd_bootm.c Can't get kernel subimage load address
2013 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2014
2015 120 common/image.c Start initial ramdisk verification
2016 -120 common/image.c Ramdisk FIT image has incorrect format
2017 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002018 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002019 -122 common/image.c Can't get configuration for ramdisk subimage
2020 123 common/image.c Ramdisk unit name specified
2021 -124 common/image.c Can't get ramdisk subimage node offset
2022 125 common/image.c Got ramdisk subimage node offset
2023 -125 common/image.c Ramdisk subimage hash verification failed
2024 126 common/image.c Ramdisk subimage hash verification OK
2025 -126 common/image.c Ramdisk subimage for unsupported architecture
2026 127 common/image.c Architecture check OK
2027 -127 common/image.c Can't get ramdisk subimage data/size
2028 128 common/image.c Got ramdisk subimage data/size
2029 129 common/image.c Can't get ramdisk load address
2030 -129 common/image.c Got ramdisk load address
2031
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002032 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002033 131 common/cmd_doc.c FIT image format OK
2034
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002035 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002036 141 common/cmd_ide.c FIT image format OK
2037
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002038 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002039 151 common/cmd_nand.c FIT image format OK
2040
2041
wdenkc6097192002-11-03 00:24:07 +00002042Modem Support:
2043--------------
2044
wdenk85ec0bc2003-03-31 16:34:49 +00002045[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002046
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002047- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002048 CONFIG_MODEM_SUPPORT
2049
2050- RTS/CTS Flow control enable:
2051 CONFIG_HWFLOW
2052
2053- Modem debug support:
2054 CONFIG_MODEM_SUPPORT_DEBUG
2055
wdenk43d96162003-03-06 00:02:04 +00002056 Enables debugging stuff (char screen[1024], dbg())
2057 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002058
wdenka8c7c702003-12-06 19:49:23 +00002059- Interrupt support (PPC):
2060
wdenkd4ca31c2004-01-02 14:00:00 +00002061 There are common interrupt_init() and timer_interrupt()
2062 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002063 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002064 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002065 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002066 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002067 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002068 specific handling. If board has watchdog / status_led
2069 / other_activity_monitor it works automatically from
2070 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002071
wdenkc6097192002-11-03 00:24:07 +00002072- General:
2073
wdenk43d96162003-03-06 00:02:04 +00002074 In the target system modem support is enabled when a
2075 specific key (key combination) is pressed during
2076 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002077 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002078 board_init(). Currently key_pressed() is a dummy
2079 function, returning 1 and thus enabling modem
2080 initialization.
wdenkc6097192002-11-03 00:24:07 +00002081
wdenk43d96162003-03-06 00:02:04 +00002082 If there are no modem init strings in the
2083 environment, U-Boot proceed to autoboot; the
2084 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002085 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002086
2087 See also: doc/README.Modem
2088
2089
wdenkc6097192002-11-03 00:24:07 +00002090Configuration Settings:
2091-----------------------
2092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002093- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002094 undefine this when you're short of memory.
2095
Peter Tyser2fb26042009-01-27 18:03:12 -06002096- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2097 width of the commands listed in the 'help' command output.
2098
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002099- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002100 prompt for user input.
2101
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002102- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002103
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002104- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002105
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002106- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002107
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002108- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002109 the application (usually a Linux kernel) when it is
2110 booted
2111
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002112- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002113 List of legal baudrate settings for this board.
2114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002115- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002116 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002118- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002119 If the board specific function
2120 extern int overwrite_console (void);
2121 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002122 serial port, else the settings in the environment are used.
2123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002124- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002125 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002127- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002128 Enable overwrite of previous console environment settings.
2129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002130- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002131 Begin and End addresses of the area used by the
2132 simple memory test.
2133
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002134- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002135 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002137- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002138 Scratch address used by the alternate memory test
2139 You only need to set this if address zero isn't writeable
2140
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002141- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2142 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002143 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002144 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002145 fixing up gd->ram_size the Linux kernel should gets passed
2146 the now "corrected" memory size and won't touch it either.
2147 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002148 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002149 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002150 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002151
2152 This option can be used as a workaround for the 440EPx/GRx
2153 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2154 be touched.
2155
2156 WARNING: Please make sure that this value is a multiple of
2157 the Linux page size (normally 4k). If this is not the case,
2158 then the end address of the Linux memory will be located at a
2159 non page size aligned address and this could cause major
2160 problems.
2161
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002162- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002163 Default load address for network file downloads
2164
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002165- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002166 Enable temporary baudrate change while serial download
2167
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002168- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002169 Physical start address of SDRAM. _Must_ be 0 here.
2170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002171- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002172 Physical start address of Motherboard I/O (if using a
2173 Cogent motherboard)
2174
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002175- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002176 Physical start address of Flash memory.
2177
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002178- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002179 Physical start address of boot monitor code (set by
2180 make config files to be same as the text base address
2181 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002182 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002183
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002184- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002185 Size of memory reserved for monitor code, used to
2186 determine _at_compile_time_ (!) if the environment is
2187 embedded within the U-Boot image, or in a separate
2188 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002189
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002190- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002191 Size of DRAM reserved for malloc() use.
2192
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002193- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002194 Normally compressed uImages are limited to an
2195 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002196 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002197 to adjust this setting to your needs.
2198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002199- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002200 Maximum size of memory mapped by the startup code of
2201 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002202 the Linux kernel (bd_info, boot arguments, FDT blob if
2203 used) must be put below this limit, unless "bootm_low"
2204 enviroment variable is defined and non-zero. In such case
2205 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002206 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002207
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002208- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002209 Max number of Flash memory banks
2210
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002211- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002212 Max number of sectors on a Flash chip
2213
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002214- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002215 Timeout for Flash erase operations (in ms)
2216
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002217- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002218 Timeout for Flash write operations (in ms)
2219
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002220- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002221 Timeout for Flash set sector lock bit operation (in ms)
2222
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002223- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002224 Timeout for Flash clear lock bits operation (in ms)
2225
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002226- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002227 If defined, hardware flash sectors protection is used
2228 instead of U-Boot software protection.
2229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002230- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002231
2232 Enable TFTP transfers directly to flash memory;
2233 without this option such a download has to be
2234 performed in two steps: (1) download to RAM, and (2)
2235 copy from RAM to flash.
2236
2237 The two-step approach is usually more reliable, since
2238 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002239 the flash, but in some situations (when system RAM is
2240 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002241 downloaded image) this option may be very useful.
2242
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002243- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002244 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002245 common flash structure for storing flash geometry.
2246
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002247- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002248 This option also enables the building of the cfi_flash driver
2249 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002250
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002251- CONFIG_FLASH_CFI_MTD
2252 This option enables the building of the cfi_mtd driver
2253 in the drivers directory. The driver exports CFI flash
2254 to the MTD layer.
2255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002256- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002257 Use buffered writes to flash.
2258
2259- CONFIG_FLASH_SPANSION_S29WS_N
2260 s29ws-n MirrorBit flash has non-standard addresses for buffered
2261 write commands.
2262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002263- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002264 If this option is defined, the common CFI flash doesn't
2265 print it's warning upon not recognized FLASH banks. This
2266 is useful, if some of the configured banks are only
2267 optionally available.
2268
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002269- CONFIG_FLASH_SHOW_PROGRESS
2270 If defined (must be an integer), print out countdown
2271 digits and dots. Recommended value: 45 (9..1) for 80
2272 column displays, 15 (3..1) for 40 column displays.
2273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002274- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002275 Defines the number of Ethernet receive buffers. On some
2276 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002277 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2278 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002279 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002280 Defaults to 4 if not defined.
2281
wdenkc6097192002-11-03 00:24:07 +00002282The following definitions that deal with the placement and management
2283of environment data (variable area); in general, we support the
2284following configurations:
2285
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002286- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002287
2288 Define this if the environment is in flash memory.
2289
2290 a) The environment occupies one whole flash sector, which is
2291 "embedded" in the text segment with the U-Boot code. This
2292 happens usually with "bottom boot sector" or "top boot
2293 sector" type flash chips, which have several smaller
2294 sectors at the start or the end. For instance, such a
2295 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2296 such a case you would place the environment in one of the
2297 4 kB sectors - with U-Boot code before and after it. With
2298 "top boot sector" type flash chips, you would put the
2299 environment in one of the last sectors, leaving a gap
2300 between U-Boot and the environment.
2301
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002302 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002303
2304 Offset of environment data (variable area) to the
2305 beginning of flash memory; for instance, with bottom boot
2306 type flash chips the second sector can be used: the offset
2307 for this sector is given here.
2308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002309 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002310
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002311 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002312
2313 This is just another way to specify the start address of
2314 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002315 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002316
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002317 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002318
2319 Size of the sector containing the environment.
2320
2321
2322 b) Sometimes flash chips have few, equal sized, BIG sectors.
2323 In such a case you don't want to spend a whole sector for
2324 the environment.
2325
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002326 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002327
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002328 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002329 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002330 of this flash sector for the environment. This saves
2331 memory for the RAM copy of the environment.
2332
2333 It may also save flash memory if you decide to use this
2334 when your environment is "embedded" within U-Boot code,
2335 since then the remainder of the flash sector could be used
2336 for U-Boot code. It should be pointed out that this is
2337 STRONGLY DISCOURAGED from a robustness point of view:
2338 updating the environment in flash makes it always
2339 necessary to erase the WHOLE sector. If something goes
2340 wrong before the contents has been restored from a copy in
2341 RAM, your target system will be dead.
2342
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002343 - CONFIG_ENV_ADDR_REDUND
2344 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002345
wdenk43d96162003-03-06 00:02:04 +00002346 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002347 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002348 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002349 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002350
2351BE CAREFUL! Any changes to the flash layout, and some changes to the
2352source code will make it necessary to adapt <board>/u-boot.lds*
2353accordingly!
2354
2355
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002356- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002357
2358 Define this if you have some non-volatile memory device
2359 (NVRAM, battery buffered SRAM) which you want to use for the
2360 environment.
2361
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002362 - CONFIG_ENV_ADDR:
2363 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002364
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002365 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002366 want to use for environment. It is assumed that this memory
2367 can just be read and written to, without any special
2368 provision.
2369
2370BE CAREFUL! The first access to the environment happens quite early
2371in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002372console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002373U-Boot will hang.
2374
2375Please note that even with NVRAM we still use a copy of the
2376environment in RAM: we could work on NVRAM directly, but we want to
2377keep settings there always unmodified except somebody uses "saveenv"
2378to save the current settings.
2379
2380
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002381- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002382
2383 Use this if you have an EEPROM or similar serial access
2384 device and a driver for it.
2385
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002386 - CONFIG_ENV_OFFSET:
2387 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002388
2389 These two #defines specify the offset and size of the
2390 environment area within the total memory of your EEPROM.
2391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002392 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002393 If defined, specified the chip address of the EEPROM device.
2394 The default address is zero.
2395
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002396 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002397 If defined, the number of bits used to address bytes in a
2398 single page in the EEPROM device. A 64 byte page, for example
2399 would require six bits.
2400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002401 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002402 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002403 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002405 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002406 The length in bytes of the EEPROM memory array address. Note
2407 that this is NOT the chip address length!
2408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002410 EEPROM chips that implement "address overflow" are ones
2411 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2412 address and the extra bits end up in the "chip address" bit
2413 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2414 byte chips.
2415
2416 Note that we consider the length of the address field to
2417 still be one byte because the extra address bits are hidden
2418 in the chip address.
2419
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002420 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002421 The size in bytes of the EEPROM device.
2422
wdenkc6097192002-11-03 00:24:07 +00002423
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002424- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002425
wdenkd4ca31c2004-01-02 14:00:00 +00002426 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002427 want to use for the environment.
2428
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002429 - CONFIG_ENV_OFFSET:
2430 - CONFIG_ENV_ADDR:
2431 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002432
2433 These three #defines specify the offset and size of the
2434 environment area within the total memory of your DataFlash placed
2435 at the specified address.
2436
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002437- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002438
2439 Define this if you have a NAND device which you want to use
2440 for the environment.
2441
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002442 - CONFIG_ENV_OFFSET:
2443 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002444
2445 These two #defines specify the offset and size of the environment
2446 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00002447
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002448 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002449
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002450 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002451 size used to hold a redundant copy of the environment data,
2452 so that there is a valid backup copy in case there is a
2453 power failure during a "saveenv" operation.
2454
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002455 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2456 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002457 the NAND devices block size.
2458
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002459- CONFIG_NAND_ENV_DST
2460
2461 Defines address in RAM to which the nand_spl code should copy the
2462 environment. If redundant environment is used, it will be copied to
2463 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2464
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002465- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002466
2467 Defines offset to the initial SPI buffer area in DPRAM. The
2468 area is used at an early stage (ROM part) if the environment
2469 is configured to reside in the SPI EEPROM: We need a 520 byte
2470 scratch DPRAM area. It is used between the two initialization
2471 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2472 to be a good choice since it makes it far enough from the
2473 start of the data area as well as from the stack pointer.
2474
Bruce Adlere881cb52007-11-02 13:15:42 -07002475Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002476has been relocated to RAM and a RAM copy of the environment has been
2477created; also, when using EEPROM you will have to use getenv_r()
2478until then to read environment variables.
2479
wdenk85ec0bc2003-03-31 16:34:49 +00002480The environment is protected by a CRC32 checksum. Before the monitor
2481is relocated into RAM, as a result of a bad CRC you will be working
2482with the compiled-in default environment - *silently*!!! [This is
2483necessary, because the first environment variable we need is the
2484"baudrate" setting for the console - if we have a bad CRC, we don't
2485have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002486
2487Note: once the monitor has been relocated, then it will complain if
2488the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002489use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002491- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002492 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002493
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002494 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002495 also needs to be defined.
2496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002497- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002498 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002500- CONFIG_SYS_64BIT_VSPRINTF:
wdenkc40b2952004-03-13 23:29:43 +00002501 Makes vsprintf (and all *printf functions) support printing
2502 of 64bit values by using the L quantifier
2503
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002504- CONFIG_SYS_64BIT_STRTOUL:
wdenkc40b2952004-03-13 23:29:43 +00002505 Adds simple_strtoull that returns a 64bit value
2506
Ron Madridf5675aa2009-02-18 14:30:44 -08002507- CONFIG_NS16550_MIN_FUNCTIONS:
2508 Define this if you desire to only have use of the NS16550_init
2509 and NS16550_putc functions for the serial driver located at
2510 drivers/serial/ns16550.c. This option is useful for saving
2511 space for already greatly restricted images, including but not
2512 limited to NAND_SPL configurations.
2513
wdenkc6097192002-11-03 00:24:07 +00002514Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002515---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002516
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002517- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002518 Cache Line Size of the CPU.
2519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002520- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002521 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002522
wdenk42d1f032003-10-15 23:53:47 +00002523 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2524 and RPXsuper) to be able to adjust the position of
2525 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002526
wdenk7f6c2cb2002-11-10 22:06:23 +00002527- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002528 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002529
2530 the default drive number (default value 0)
2531
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002532 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002533
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002534 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002535 (default value 1)
2536
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002537 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002538
wdenk43d96162003-03-06 00:02:04 +00002539 defines the offset of register from address. It
2540 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002541 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002543 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2544 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002545 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002546
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002547 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002548 fdc_hw_init() is called at the beginning of the FDC
2549 setup. fdc_hw_init() must be provided by the board
2550 source code. It is used to make hardware dependant
2551 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002553- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002554 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002555 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002556
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002557- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002558
wdenk7152b1d2003-09-05 23:19:14 +00002559 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002560 initial data and stack; please note that this must be
2561 writable memory that is working WITHOUT special
2562 initialization, i. e. you CANNOT use normal RAM which
2563 will become available only after programming the
2564 memory controller and running certain initialization
2565 sequences.
2566
2567 U-Boot uses the following memory types:
2568 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2569 - MPC824X: data cache
2570 - PPC4xx: data cache
2571
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002572- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002573
2574 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002575 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2576 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002577 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002578 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2579 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2580 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2581 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002582
2583 Note:
2584 On the MPC824X (or other systems that use the data
2585 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002586 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002587 point to an otherwise UNUSED address space between
2588 the top of RAM and the start of the PCI space.
2589
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002590- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002591
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002592- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002594- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002596- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002597
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002598- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002600- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002601
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002602- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002603 SDRAM timing
2604
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002605- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002606 periodic timer for refresh
2607
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002608- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002610- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2611 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2612 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2613 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002614 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2615
2616- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002617 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2618 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002619 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002621- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2622 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002623 Machine Mode Register and Memory Periodic Timer
2624 Prescaler definitions (SDRAM timing)
2625
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002626- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002627 enable I2C microcode relocation patch (MPC8xx);
2628 define relocation offset in DPRAM [DSP2]
2629
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002630- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002631 enable SMC microcode relocation patch (MPC8xx);
2632 define relocation offset in DPRAM [SMC1]
2633
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002634- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002635 enable SPI microcode relocation patch (MPC8xx);
2636 define relocation offset in DPRAM [SCC4]
2637
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002638- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002639 Use OSCM clock mode on MBX8xx board. Be careful,
2640 wrong setting might damage your board. Read
2641 doc/README.MBX before setting this variable!
2642
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002643- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002644 Offset of the bootmode word in DPRAM used by post
2645 (Power On Self Tests). This definition overrides
2646 #define'd default value in commproc.h resp.
2647 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002648
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002649- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2650 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2651 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2652 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2653 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2654 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2655 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2656 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
wdenk5d232d02003-05-22 22:52:13 +00002657 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2658
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002659- CONFIG_PCI_DISABLE_PCIE:
2660 Disable PCI-Express on systems where it is supported but not
2661 required.
2662
Ben Warrenbb99ad62006-09-07 16:50:54 -04002663- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002664 Get DDR timing information from an I2C EEPROM. Common
2665 with pluggable memory modules such as SODIMMs
2666
Ben Warrenbb99ad62006-09-07 16:50:54 -04002667 SPD_EEPROM_ADDRESS
2668 I2C address of the SPD EEPROM
2669
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002670- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002671 If SPD EEPROM is on an I2C bus other than the first
2672 one, specify here. Note that the value must resolve
2673 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002674
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002675- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002676 Only for 83xx systems. If specified, then DDR should
2677 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002678
wdenkc26e4542004-04-18 10:13:26 +00002679- CONFIG_ETHER_ON_FEC[12]
2680 Define to enable FEC[12] on a 8xx series processor.
2681
2682- CONFIG_FEC[12]_PHY
2683 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002684 to the given FEC; i. e.
2685 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002686 means that the PHY with address 4 is connected to FEC1
2687
2688 When set to -1, means to probe for first available.
2689
2690- CONFIG_FEC[12]_PHY_NORXERR
2691 The PHY does not have a RXERR line (RMII only).
2692 (so program the FEC to ignore it).
2693
2694- CONFIG_RMII
2695 Enable RMII mode for all FECs.
2696 Note that this is a global option, we can't
2697 have one FEC in standard MII mode and another in RMII mode.
2698
wdenk5cf91d62004-04-23 20:32:05 +00002699- CONFIG_CRC32_VERIFY
2700 Add a verify option to the crc32 command.
2701 The syntax is:
2702
2703 => crc32 -v <address> <count> <crc32>
2704
2705 Where address/count indicate a memory area
2706 and crc32 is the correct crc32 which the
2707 area should have.
2708
wdenk56523f12004-07-11 17:40:54 +00002709- CONFIG_LOOPW
2710 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002711 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002712
stroese7b466642004-12-16 18:46:55 +00002713- CONFIG_MX_CYCLIC
2714 Add the "mdc" and "mwc" memory commands. These are cyclic
2715 "md/mw" commands.
2716 Examples:
2717
wdenkefe2a4d2004-12-16 21:44:03 +00002718 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002719 This command will print 4 bytes (10,11,12,13) each 500 ms.
2720
wdenkefe2a4d2004-12-16 21:44:03 +00002721 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002722 This command will write 12345678 to address 100 all 10 ms.
2723
wdenkefe2a4d2004-12-16 21:44:03 +00002724 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002725 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002726
wdenk8aa1a2d2005-04-04 12:44:11 +00002727- CONFIG_SKIP_LOWLEVEL_INIT
2728- CONFIG_SKIP_RELOCATE_UBOOT
2729
wdenk3c2b3d42005-04-05 23:32:21 +00002730 [ARM only] If these variables are defined, then
2731 certain low level initializations (like setting up
2732 the memory controller) are omitted and/or U-Boot does
2733 not relocate itself into RAM.
2734 Normally these variables MUST NOT be defined. The
2735 only exception is when U-Boot is loaded (to RAM) by
2736 some other boot loader or by a debugger which
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002737 performs these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002738
Magnus Liljadf812382009-06-13 20:50:00 +02002739- CONFIG_PRELOADER
2740
2741 Modifies the behaviour of start.S when compiling a loader
2742 that is executed before the actual U-Boot. E.g. when
2743 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002744
wdenkc6097192002-11-03 00:24:07 +00002745Building the Software:
2746======================
2747
Wolfgang Denk218ca722008-03-26 10:40:12 +01002748Building U-Boot has been tested in several native build environments
2749and in many different cross environments. Of course we cannot support
2750all possibly existing versions of cross development tools in all
2751(potentially obsolete) versions. In case of tool chain problems we
2752recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2753which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002754
Wolfgang Denk218ca722008-03-26 10:40:12 +01002755If you are not using a native environment, it is assumed that you
2756have GNU cross compiling tools available in your path. In this case,
2757you must set the environment variable CROSS_COMPILE in your shell.
2758Note that no changes to the Makefile or any other source files are
2759necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002760
Wolfgang Denk218ca722008-03-26 10:40:12 +01002761 $ CROSS_COMPILE=ppc_4xx-
2762 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002763
Peter Tyser2f8d3962009-03-13 18:54:51 -05002764Note: If you wish to generate Windows versions of the utilities in
2765 the tools directory you can use the MinGW toolchain
2766 (http://www.mingw.org). Set your HOST tools to the MinGW
2767 toolchain and execute 'make tools'. For example:
2768
2769 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2770
2771 Binaries such as tools/mkimage.exe will be created which can
2772 be executed on computers running Windows.
2773
Wolfgang Denk218ca722008-03-26 10:40:12 +01002774U-Boot is intended to be simple to build. After installing the
2775sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002776is done by typing:
2777
2778 make NAME_config
2779
Wolfgang Denk218ca722008-03-26 10:40:12 +01002780where "NAME_config" is the name of one of the existing configu-
2781rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002782
wdenk2729af92004-05-03 20:45:30 +00002783Note: for some board special configuration names may exist; check if
2784 additional information is available from the board vendor; for
2785 instance, the TQM823L systems are available without (standard)
2786 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002787 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002788
wdenk2729af92004-05-03 20:45:30 +00002789 make TQM823L_config
2790 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002791
wdenk2729af92004-05-03 20:45:30 +00002792 make TQM823L_LCD_config
2793 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002794
wdenk2729af92004-05-03 20:45:30 +00002795 etc.
wdenkc6097192002-11-03 00:24:07 +00002796
wdenkc6097192002-11-03 00:24:07 +00002797
wdenk2729af92004-05-03 20:45:30 +00002798Finally, type "make all", and you should get some working U-Boot
2799images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002800
wdenk2729af92004-05-03 20:45:30 +00002801- "u-boot.bin" is a raw binary image
2802- "u-boot" is an image in ELF binary format
2803- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002804
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002805By default the build is performed locally and the objects are saved
2806in the source directory. One of the two methods can be used to change
2807this behavior and build U-Boot to some external directory:
2808
28091. Add O= to the make command line invocations:
2810
2811 make O=/tmp/build distclean
2812 make O=/tmp/build NAME_config
2813 make O=/tmp/build all
2814
28152. Set environment variable BUILD_DIR to point to the desired location:
2816
2817 export BUILD_DIR=/tmp/build
2818 make distclean
2819 make NAME_config
2820 make all
2821
2822Note that the command line "O=" setting overrides the BUILD_DIR environment
2823variable.
2824
wdenkc6097192002-11-03 00:24:07 +00002825
wdenk2729af92004-05-03 20:45:30 +00002826Please be aware that the Makefiles assume you are using GNU make, so
2827for instance on NetBSD you might need to use "gmake" instead of
2828native "make".
wdenkc6097192002-11-03 00:24:07 +00002829
wdenkc6097192002-11-03 00:24:07 +00002830
wdenk2729af92004-05-03 20:45:30 +00002831If the system board that you have is not listed, then you will need
2832to port U-Boot to your hardware platform. To do this, follow these
2833steps:
wdenkc6097192002-11-03 00:24:07 +00002834
wdenk2729af92004-05-03 20:45:30 +000028351. Add a new configuration option for your board to the toplevel
2836 "Makefile" and to the "MAKEALL" script, using the existing
2837 entries as examples. Note that here and at many other places
2838 boards and other names are listed in alphabetical sort order. Please
2839 keep this order.
28402. Create a new directory to hold your board specific code. Add any
2841 files you need. In your board directory, you will need at least
2842 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
28433. Create a new configuration file "include/configs/<board>.h" for
2844 your board
28453. If you're porting U-Boot to a new CPU, then also create a new
2846 directory to hold your CPU specific code. Add any files you need.
28474. Run "make <board>_config" with your new name.
28485. Type "make", and you should get a working "u-boot.srec" file
2849 to be installed on your target system.
28506. Debug and solve any problems that might arise.
2851 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002852
wdenkc6097192002-11-03 00:24:07 +00002853
wdenk2729af92004-05-03 20:45:30 +00002854Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2855==============================================================
wdenkc6097192002-11-03 00:24:07 +00002856
Wolfgang Denk218ca722008-03-26 10:40:12 +01002857If you have modified U-Boot sources (for instance added a new board
2858or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002859provide feedback to the other developers. The feedback normally takes
2860the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01002861official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002862
Wolfgang Denk218ca722008-03-26 10:40:12 +01002863But before you submit such a patch, please verify that your modifi-
2864cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00002865the supported boards compile WITHOUT ANY compiler warnings. To do so,
2866just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01002867for ALL supported system. Be warned, this will take a while. You can
2868select which (cross) compiler to use by passing a `CROSS_COMPILE'
2869environment variable to the script, i. e. to use the ELDK cross tools
2870you can type
wdenkc6097192002-11-03 00:24:07 +00002871
wdenk2729af92004-05-03 20:45:30 +00002872 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002873
wdenk2729af92004-05-03 20:45:30 +00002874or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002875
wdenk2729af92004-05-03 20:45:30 +00002876 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002877
Wolfgang Denk218ca722008-03-26 10:40:12 +01002878When using the MAKEALL script, the default behaviour is to build
2879U-Boot in the source directory. This location can be changed by
2880setting the BUILD_DIR environment variable. Also, for each target
2881built, the MAKEALL script saves two log files (<target>.ERR and
2882<target>.MAKEALL) in the <source dir>/LOG directory. This default
2883location can be changed by setting the MAKEALL_LOGDIR environment
2884variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002885
2886 export BUILD_DIR=/tmp/build
2887 export MAKEALL_LOGDIR=/tmp/log
2888 CROSS_COMPILE=ppc_8xx- MAKEALL
2889
Wolfgang Denk218ca722008-03-26 10:40:12 +01002890With the above settings build objects are saved in the /tmp/build,
2891log files are saved in the /tmp/log and the source tree remains clean
2892during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002893
2894
wdenk2729af92004-05-03 20:45:30 +00002895See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002896
wdenkc6097192002-11-03 00:24:07 +00002897
wdenk2729af92004-05-03 20:45:30 +00002898Monitor Commands - Overview:
2899============================
wdenkc6097192002-11-03 00:24:07 +00002900
wdenk2729af92004-05-03 20:45:30 +00002901go - start application at address 'addr'
2902run - run commands in an environment variable
2903bootm - boot application image from memory
2904bootp - boot image via network using BootP/TFTP protocol
2905tftpboot- boot image via network using TFTP protocol
2906 and env variables "ipaddr" and "serverip"
2907 (and eventually "gatewayip")
2908rarpboot- boot image via network using RARP/TFTP protocol
2909diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2910loads - load S-Record file over serial line
2911loadb - load binary file over serial line (kermit mode)
2912md - memory display
2913mm - memory modify (auto-incrementing)
2914nm - memory modify (constant address)
2915mw - memory write (fill)
2916cp - memory copy
2917cmp - memory compare
2918crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05002919i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00002920sspi - SPI utility commands
2921base - print or set address offset
2922printenv- print environment variables
2923setenv - set environment variables
2924saveenv - save environment variables to persistent storage
2925protect - enable or disable FLASH write protection
2926erase - erase FLASH memory
2927flinfo - print FLASH memory information
2928bdinfo - print Board Info structure
2929iminfo - print header information for application image
2930coninfo - print console devices and informations
2931ide - IDE sub-system
2932loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002933loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002934mtest - simple RAM test
2935icache - enable or disable instruction cache
2936dcache - enable or disable data cache
2937reset - Perform RESET of the CPU
2938echo - echo args to console
2939version - print monitor version
2940help - print online help
2941? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002942
wdenkc6097192002-11-03 00:24:07 +00002943
wdenk2729af92004-05-03 20:45:30 +00002944Monitor Commands - Detailed Description:
2945========================================
wdenkc6097192002-11-03 00:24:07 +00002946
wdenk2729af92004-05-03 20:45:30 +00002947TODO.
wdenkc6097192002-11-03 00:24:07 +00002948
wdenk2729af92004-05-03 20:45:30 +00002949For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002950
2951
wdenk2729af92004-05-03 20:45:30 +00002952Environment Variables:
2953======================
wdenkc6097192002-11-03 00:24:07 +00002954
wdenk2729af92004-05-03 20:45:30 +00002955U-Boot supports user configuration using Environment Variables which
2956can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002957
wdenk2729af92004-05-03 20:45:30 +00002958Environment Variables are set using "setenv", printed using
2959"printenv", and saved to Flash using "saveenv". Using "setenv"
2960without a value can be used to delete a variable from the
2961environment. As long as you don't save the environment you are
2962working with an in-memory copy. In case the Flash area containing the
2963environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002964
wdenk2729af92004-05-03 20:45:30 +00002965Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002966
wdenk2729af92004-05-03 20:45:30 +00002967 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002968
wdenk2729af92004-05-03 20:45:30 +00002969 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002970
wdenk2729af92004-05-03 20:45:30 +00002971 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002972
wdenk2729af92004-05-03 20:45:30 +00002973 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002974
wdenk2729af92004-05-03 20:45:30 +00002975 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002976
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002977 bootm_low - Memory range available for image processing in the bootm
2978 command can be restricted. This variable is given as
2979 a hexadecimal number and defines lowest address allowed
2980 for use by the bootm command. See also "bootm_size"
2981 environment variable. Address defined by "bootm_low" is
2982 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002983 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002984
2985 bootm_size - Memory range available for image processing in the bootm
2986 command can be restricted. This variable is given as
2987 a hexadecimal number and defines the size of the region
2988 allowed for use by the bootm command. See also "bootm_low"
2989 environment variable.
2990
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02002991 updatefile - Location of the software update file on a TFTP server, used
2992 by the automatic software update feature. Please refer to
2993 documentation in doc/README.update for more details.
2994
wdenk2729af92004-05-03 20:45:30 +00002995 autoload - if set to "no" (any string beginning with 'n'),
2996 "bootp" will just load perform a lookup of the
2997 configuration from the BOOTP server, but not try to
2998 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002999
Marian Balakowicz3310c542008-03-12 12:13:13 +01003000 autoscript - if set to "yes" commands like "loadb", "loady",
3001 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
3002 to automatically run script images (by internally
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003003 calling "source").
Marian Balakowicz3310c542008-03-12 12:13:13 +01003004
3005 autoscript_uname - if script image is in a format (FIT) this
3006 variable is used to get script subimage unit name.
3007
wdenk2729af92004-05-03 20:45:30 +00003008 autostart - if set to "yes", an image loaded using the "bootp",
3009 "rarpboot", "tftpboot" or "diskboot" commands will
3010 be automatically started (by internally calling
3011 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003012
wdenk2729af92004-05-03 20:45:30 +00003013 If set to "no", a standalone image passed to the
3014 "bootm" command will be copied to the load address
3015 (and eventually uncompressed), but NOT be started.
3016 This can be used to load and uncompress arbitrary
3017 data.
wdenkc6097192002-11-03 00:24:07 +00003018
wdenk17ea1172004-06-06 21:51:03 +00003019 i2cfast - (PPC405GP|PPC405EP only)
3020 if set to 'y' configures Linux I2C driver for fast
3021 mode (400kHZ). This environment variable is used in
3022 initialization code. So, for changes to be effective
3023 it must be saved and board must be reset.
3024
wdenk2729af92004-05-03 20:45:30 +00003025 initrd_high - restrict positioning of initrd images:
3026 If this variable is not set, initrd images will be
3027 copied to the highest possible address in RAM; this
3028 is usually what you want since it allows for
3029 maximum initrd size. If for some reason you want to
3030 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003031 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003032 variable to a value of "no" or "off" or "0".
3033 Alternatively, you can set it to a maximum upper
3034 address to use (U-Boot will still check that it
3035 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003036
wdenk2729af92004-05-03 20:45:30 +00003037 For instance, when you have a system with 16 MB
3038 RAM, and want to reserve 4 MB from use by Linux,
3039 you can do this by adding "mem=12M" to the value of
3040 the "bootargs" variable. However, now you must make
3041 sure that the initrd image is placed in the first
3042 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003043
wdenk2729af92004-05-03 20:45:30 +00003044 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003045
wdenk2729af92004-05-03 20:45:30 +00003046 If you set initrd_high to 0xFFFFFFFF, this is an
3047 indication to U-Boot that all addresses are legal
3048 for the Linux kernel, including addresses in flash
3049 memory. In this case U-Boot will NOT COPY the
3050 ramdisk at all. This may be useful to reduce the
3051 boot time on your system, but requires that this
3052 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003053
wdenk2729af92004-05-03 20:45:30 +00003054 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003055
wdenk2729af92004-05-03 20:45:30 +00003056 loadaddr - Default load address for commands like "bootp",
3057 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003058
wdenk2729af92004-05-03 20:45:30 +00003059 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003060
wdenk2729af92004-05-03 20:45:30 +00003061 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003062
wdenk2729af92004-05-03 20:45:30 +00003063 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003064
wdenk2729af92004-05-03 20:45:30 +00003065 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003066
wdenk2729af92004-05-03 20:45:30 +00003067 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003068
wdenk2729af92004-05-03 20:45:30 +00003069 ethprime - When CONFIG_NET_MULTI is enabled controls which
3070 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072 ethact - When CONFIG_NET_MULTI is enabled controls which
3073 interface is currently active. For example you
3074 can do the following
wdenkc6097192002-11-03 00:24:07 +00003075
wdenk2729af92004-05-03 20:45:30 +00003076 => setenv ethact FEC ETHERNET
3077 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3078 => setenv ethact SCC ETHERNET
3079 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00003080
Matthias Fuchse1692572008-01-17 07:45:05 +01003081 ethrotate - When set to "no" U-Boot does not go through all
3082 available network interfaces.
3083 It just stays at the currently selected interface.
3084
wdenk2729af92004-05-03 20:45:30 +00003085 netretry - When set to "no" each network operation will
3086 either succeed or fail without retrying.
3087 When set to "once" the network operation will
3088 fail when all the available network interfaces
3089 are tried once without success.
3090 Useful on scripts which control the retry operation
3091 themselves.
wdenkc6097192002-11-03 00:24:07 +00003092
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003093 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003094
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003095 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003096 UDP source port.
3097
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003098 tftpdstport - If this is set, the value is used for TFTP's UDP
3099 destination port instead of the Well Know Port 69.
3100
wdenk2729af92004-05-03 20:45:30 +00003101 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003102 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003103 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003104
wdenk2729af92004-05-03 20:45:30 +00003105The following environment variables may be used and automatically
3106updated by the network boot commands ("bootp" and "rarpboot"),
3107depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003108
wdenk2729af92004-05-03 20:45:30 +00003109 bootfile - see above
3110 dnsip - IP address of your Domain Name Server
3111 dnsip2 - IP address of your secondary Domain Name Server
3112 gatewayip - IP address of the Gateway (Router) to use
3113 hostname - Target hostname
3114 ipaddr - see above
3115 netmask - Subnet Mask
3116 rootpath - Pathname of the root filesystem on the NFS server
3117 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003118
wdenka3d991b2004-04-15 21:48:45 +00003119
wdenk2729af92004-05-03 20:45:30 +00003120There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003121
wdenk2729af92004-05-03 20:45:30 +00003122 serial# - contains hardware identification information such
3123 as type string and/or serial number
3124 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003125
wdenk2729af92004-05-03 20:45:30 +00003126These variables can be set only once (usually during manufacturing of
3127the board). U-Boot refuses to delete or overwrite these variables
3128once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003129
3130
wdenk2729af92004-05-03 20:45:30 +00003131Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003132
wdenk2729af92004-05-03 20:45:30 +00003133 ver - Contains the U-Boot version string as printed
3134 with the "version" command. This variable is
3135 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003136
wdenkc6097192002-11-03 00:24:07 +00003137
wdenk2729af92004-05-03 20:45:30 +00003138Please note that changes to some configuration parameters may take
3139only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003140
stroesec1551ea2003-04-04 15:53:41 +00003141
wdenk2729af92004-05-03 20:45:30 +00003142Command Line Parsing:
3143=====================
stroesec1551ea2003-04-04 15:53:41 +00003144
wdenk2729af92004-05-03 20:45:30 +00003145There are two different command line parsers available with U-Boot:
3146the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003147
wdenk2729af92004-05-03 20:45:30 +00003148Old, simple command line parser:
3149--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003150
wdenk2729af92004-05-03 20:45:30 +00003151- supports environment variables (through setenv / saveenv commands)
3152- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003153- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003154- special characters ('$', ';') can be escaped by prefixing with '\',
3155 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003156 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003157- You can also escape text by enclosing in single apostrophes, for example:
3158 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003159
wdenk2729af92004-05-03 20:45:30 +00003160Hush shell:
3161-----------
wdenkf07771c2003-05-28 08:06:31 +00003162
wdenk2729af92004-05-03 20:45:30 +00003163- similar to Bourne shell, with control structures like
3164 if...then...else...fi, for...do...done; while...do...done,
3165 until...do...done, ...
3166- supports environment ("global") variables (through setenv / saveenv
3167 commands) and local shell variables (through standard shell syntax
3168 "name=value"); only environment variables can be used with "run"
3169 command
wdenkf07771c2003-05-28 08:06:31 +00003170
wdenk2729af92004-05-03 20:45:30 +00003171General rules:
3172--------------
wdenkf07771c2003-05-28 08:06:31 +00003173
wdenk2729af92004-05-03 20:45:30 +00003174(1) If a command line (or an environment variable executed by a "run"
3175 command) contains several commands separated by semicolon, and
3176 one of these commands fails, then the remaining commands will be
3177 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003178
wdenk2729af92004-05-03 20:45:30 +00003179(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003180 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003181 command will cause "run" to terminate, i. e. the remaining
3182 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003183
wdenk2729af92004-05-03 20:45:30 +00003184Note for Redundant Ethernet Interfaces:
3185=======================================
wdenkf07771c2003-05-28 08:06:31 +00003186
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003187Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003188such configurations and is capable of automatic selection of a
3189"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003190
wdenk2729af92004-05-03 20:45:30 +00003191Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3192MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3193"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003194
wdenk2729af92004-05-03 20:45:30 +00003195If the network interface stores some valid MAC address (for instance
3196in SROM), this is used as default address if there is NO correspon-
3197ding setting in the environment; if the corresponding environment
3198variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003199
wdenk2729af92004-05-03 20:45:30 +00003200o If the SROM has a valid MAC address, and there is no address in the
3201 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003202
wdenk2729af92004-05-03 20:45:30 +00003203o If there is no valid address in the SROM, and a definition in the
3204 environment exists, then the value from the environment variable is
3205 used.
wdenkc6097192002-11-03 00:24:07 +00003206
wdenk2729af92004-05-03 20:45:30 +00003207o If both the SROM and the environment contain a MAC address, and
3208 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003209
wdenk2729af92004-05-03 20:45:30 +00003210o If both the SROM and the environment contain a MAC address, and the
3211 addresses differ, the value from the environment is used and a
3212 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003213
wdenk2729af92004-05-03 20:45:30 +00003214o If neither SROM nor the environment contain a MAC address, an error
3215 is raised.
wdenkc6097192002-11-03 00:24:07 +00003216
wdenkc6097192002-11-03 00:24:07 +00003217
wdenk2729af92004-05-03 20:45:30 +00003218Image Formats:
3219==============
wdenkc6097192002-11-03 00:24:07 +00003220
Marian Balakowicz3310c542008-03-12 12:13:13 +01003221U-Boot is capable of booting (and performing other auxiliary operations on)
3222images in two formats:
3223
3224New uImage format (FIT)
3225-----------------------
3226
3227Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3228to Flattened Device Tree). It allows the use of images with multiple
3229components (several kernels, ramdisks, etc.), with contents protected by
3230SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3231
3232
3233Old uImage format
3234-----------------
3235
3236Old image format is based on binary files which can be basically anything,
3237preceded by a special header; see the definitions in include/image.h for
3238details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003239
wdenk2729af92004-05-03 20:45:30 +00003240* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3241 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003242 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3243 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3244 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003245* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk2729af92004-05-03 20:45:30 +00003246 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003247 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003248* Compression Type (uncompressed, gzip, bzip2)
3249* Load Address
3250* Entry Point
3251* Image Name
3252* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003253
wdenk2729af92004-05-03 20:45:30 +00003254The header is marked by a special Magic Number, and both the header
3255and the data portions of the image are secured against corruption by
3256CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003257
wdenkc6097192002-11-03 00:24:07 +00003258
wdenk2729af92004-05-03 20:45:30 +00003259Linux Support:
3260==============
wdenkc6097192002-11-03 00:24:07 +00003261
wdenk2729af92004-05-03 20:45:30 +00003262Although U-Boot should support any OS or standalone application
3263easily, the main focus has always been on Linux during the design of
3264U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003265
wdenk2729af92004-05-03 20:45:30 +00003266U-Boot includes many features that so far have been part of some
3267special "boot loader" code within the Linux kernel. Also, any
3268"initrd" images to be used are no longer part of one big Linux image;
3269instead, kernel and "initrd" are separate images. This implementation
3270serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003271
wdenk2729af92004-05-03 20:45:30 +00003272- the same features can be used for other OS or standalone
3273 applications (for instance: using compressed images to reduce the
3274 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003275
wdenk2729af92004-05-03 20:45:30 +00003276- it becomes much easier to port new Linux kernel versions because
3277 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003278
wdenk2729af92004-05-03 20:45:30 +00003279- the same Linux kernel image can now be used with different "initrd"
3280 images; of course this also means that different kernel images can
3281 be run with the same "initrd". This makes testing easier (you don't
3282 have to build a new "zImage.initrd" Linux image when you just
3283 change a file in your "initrd"). Also, a field-upgrade of the
3284 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003285
wdenkc6097192002-11-03 00:24:07 +00003286
wdenk2729af92004-05-03 20:45:30 +00003287Linux HOWTO:
3288============
wdenkc6097192002-11-03 00:24:07 +00003289
wdenk2729af92004-05-03 20:45:30 +00003290Porting Linux to U-Boot based systems:
3291---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk2729af92004-05-03 20:45:30 +00003293U-Boot cannot save you from doing all the necessary modifications to
3294configure the Linux device drivers for use with your target hardware
3295(no, we don't intend to provide a full virtual machine interface to
3296Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003297
wdenk2729af92004-05-03 20:45:30 +00003298But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003299
wdenk2729af92004-05-03 20:45:30 +00003300Just make sure your machine specific header file (for instance
3301include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003302Information structure as we define in include/asm-<arch>/u-boot.h,
3303and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003304as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003305
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307Configuring the Linux kernel:
3308-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003309
wdenk2729af92004-05-03 20:45:30 +00003310No specific requirements for U-Boot. Make sure you have some root
3311device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003312
wdenkc6097192002-11-03 00:24:07 +00003313
wdenk2729af92004-05-03 20:45:30 +00003314Building a Linux Image:
3315-----------------------
wdenkc6097192002-11-03 00:24:07 +00003316
wdenk2729af92004-05-03 20:45:30 +00003317With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3318not used. If you use recent kernel source, a new build target
3319"uImage" will exist which automatically builds an image usable by
3320U-Boot. Most older kernels also have support for a "pImage" target,
3321which was introduced for our predecessor project PPCBoot and uses a
3322100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003323
wdenk2729af92004-05-03 20:45:30 +00003324Example:
wdenkc6097192002-11-03 00:24:07 +00003325
wdenk2729af92004-05-03 20:45:30 +00003326 make TQM850L_config
3327 make oldconfig
3328 make dep
3329 make uImage
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk2729af92004-05-03 20:45:30 +00003331The "uImage" build target uses a special tool (in 'tools/mkimage') to
3332encapsulate a compressed Linux kernel image with header information,
3333CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003334
wdenk2729af92004-05-03 20:45:30 +00003335* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003336
wdenk2729af92004-05-03 20:45:30 +00003337* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003338
wdenk2729af92004-05-03 20:45:30 +00003339 ${CROSS_COMPILE}-objcopy -O binary \
3340 -R .note -R .comment \
3341 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003342
wdenk2729af92004-05-03 20:45:30 +00003343* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003344
wdenk2729af92004-05-03 20:45:30 +00003345 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003346
wdenk2729af92004-05-03 20:45:30 +00003347* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003348
wdenk2729af92004-05-03 20:45:30 +00003349 mkimage -A ppc -O linux -T kernel -C gzip \
3350 -a 0 -e 0 -n "Linux Kernel Image" \
3351 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003352
wdenk24ee89b2002-11-03 17:56:27 +00003353
wdenk2729af92004-05-03 20:45:30 +00003354The "mkimage" tool can also be used to create ramdisk images for use
3355with U-Boot, either separated from the Linux kernel image, or
3356combined into one file. "mkimage" encapsulates the images with a 64
3357byte header containing information about target architecture,
3358operating system, image type, compression method, entry points, time
3359stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003360
wdenk2729af92004-05-03 20:45:30 +00003361"mkimage" can be called in two ways: to verify existing images and
3362print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003363
wdenk2729af92004-05-03 20:45:30 +00003364In the first form (with "-l" option) mkimage lists the information
3365contained in the header of an existing U-Boot image; this includes
3366checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003367
wdenk2729af92004-05-03 20:45:30 +00003368 tools/mkimage -l image
3369 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003370
wdenk2729af92004-05-03 20:45:30 +00003371The second form (with "-d" option) is used to build a U-Boot image
3372from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003373
wdenk2729af92004-05-03 20:45:30 +00003374 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3375 -n name -d data_file image
3376 -A ==> set architecture to 'arch'
3377 -O ==> set operating system to 'os'
3378 -T ==> set image type to 'type'
3379 -C ==> set compression type 'comp'
3380 -a ==> set load address to 'addr' (hex)
3381 -e ==> set entry point to 'ep' (hex)
3382 -n ==> set image name to 'name'
3383 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003384
wdenk69459792004-05-29 16:53:29 +00003385Right now, all Linux kernels for PowerPC systems use the same load
3386address (0x00000000), but the entry point address depends on the
3387kernel version:
wdenkc6097192002-11-03 00:24:07 +00003388
wdenk2729af92004-05-03 20:45:30 +00003389- 2.2.x kernels have the entry point at 0x0000000C,
3390- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003391
wdenk2729af92004-05-03 20:45:30 +00003392So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003393
wdenk2729af92004-05-03 20:45:30 +00003394 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3395 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3396 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3397 > examples/uImage.TQM850L
3398 Image Name: 2.4.4 kernel for TQM850L
3399 Created: Wed Jul 19 02:34:59 2000
3400 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3401 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3402 Load Address: 0x00000000
3403 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003404
wdenk2729af92004-05-03 20:45:30 +00003405To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003406
wdenk2729af92004-05-03 20:45:30 +00003407 -> tools/mkimage -l examples/uImage.TQM850L
3408 Image Name: 2.4.4 kernel for TQM850L
3409 Created: Wed Jul 19 02:34:59 2000
3410 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3411 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3412 Load Address: 0x00000000
3413 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003414
wdenk2729af92004-05-03 20:45:30 +00003415NOTE: for embedded systems where boot time is critical you can trade
3416speed for memory and install an UNCOMPRESSED image instead: this
3417needs more space in Flash, but boots much faster since it does not
3418need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003419
wdenk2729af92004-05-03 20:45:30 +00003420 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3421 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3422 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3423 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3424 > examples/uImage.TQM850L-uncompressed
3425 Image Name: 2.4.4 kernel for TQM850L
3426 Created: Wed Jul 19 02:34:59 2000
3427 Image Type: PowerPC Linux Kernel Image (uncompressed)
3428 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3429 Load Address: 0x00000000
3430 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003431
wdenkc6097192002-11-03 00:24:07 +00003432
wdenk2729af92004-05-03 20:45:30 +00003433Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3434when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003435
wdenk2729af92004-05-03 20:45:30 +00003436 -> tools/mkimage -n 'Simple Ramdisk Image' \
3437 > -A ppc -O linux -T ramdisk -C gzip \
3438 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3439 Image Name: Simple Ramdisk Image
3440 Created: Wed Jan 12 14:01:50 2000
3441 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3442 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3443 Load Address: 0x00000000
3444 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003445
wdenkdb01a2e2004-04-15 23:14:49 +00003446
wdenk2729af92004-05-03 20:45:30 +00003447Installing a Linux Image:
3448-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003449
wdenk2729af92004-05-03 20:45:30 +00003450To downloading a U-Boot image over the serial (console) interface,
3451you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003452
wdenk2729af92004-05-03 20:45:30 +00003453 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003454
wdenk2729af92004-05-03 20:45:30 +00003455The 'objcopy' does not understand the information in the U-Boot
3456image header, so the resulting S-Record file will be relative to
3457address 0x00000000. To load it to a given address, you need to
3458specify the target address as 'offset' parameter with the 'loads'
3459command.
wdenkc6097192002-11-03 00:24:07 +00003460
wdenk2729af92004-05-03 20:45:30 +00003461Example: install the image to address 0x40100000 (which on the
3462TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003463
wdenk2729af92004-05-03 20:45:30 +00003464 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003465
wdenk2729af92004-05-03 20:45:30 +00003466 .......... done
3467 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003468
wdenk2729af92004-05-03 20:45:30 +00003469 => loads 40100000
3470 ## Ready for S-Record download ...
3471 ~>examples/image.srec
3472 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3473 ...
3474 15989 15990 15991 15992
3475 [file transfer complete]
3476 [connected]
3477 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003478
3479
wdenk2729af92004-05-03 20:45:30 +00003480You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003481this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003482corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003485
wdenk2729af92004-05-03 20:45:30 +00003486 ## Checking Image at 40100000 ...
3487 Image Name: 2.2.13 for initrd on TQM850L
3488 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3489 Data Size: 335725 Bytes = 327 kB = 0 MB
3490 Load Address: 00000000
3491 Entry Point: 0000000c
3492 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003493
3494
wdenk2729af92004-05-03 20:45:30 +00003495Boot Linux:
3496-----------
wdenkc6097192002-11-03 00:24:07 +00003497
wdenk2729af92004-05-03 20:45:30 +00003498The "bootm" command is used to boot an application that is stored in
3499memory (RAM or Flash). In case of a Linux kernel image, the contents
3500of the "bootargs" environment variable is passed to the kernel as
3501parameters. You can check and modify this variable using the
3502"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003503
3504
wdenk2729af92004-05-03 20:45:30 +00003505 => printenv bootargs
3506 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk2729af92004-05-03 20:45:30 +00003508 => 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 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510 => printenv bootargs
3511 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 +00003512
wdenk2729af92004-05-03 20:45:30 +00003513 => bootm 40020000
3514 ## Booting Linux kernel at 40020000 ...
3515 Image Name: 2.2.13 for NFS on TQM850L
3516 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3517 Data Size: 381681 Bytes = 372 kB = 0 MB
3518 Load Address: 00000000
3519 Entry Point: 0000000c
3520 Verifying Checksum ... OK
3521 Uncompressing Kernel Image ... OK
3522 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
3523 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3524 time_init: decrementer frequency = 187500000/60
3525 Calibrating delay loop... 49.77 BogoMIPS
3526 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3527 ...
wdenkc6097192002-11-03 00:24:07 +00003528
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003529If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003530the memory addresses of both the kernel and the initrd image (PPBCOOT
3531format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003532
wdenk2729af92004-05-03 20:45:30 +00003533 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003534
wdenk2729af92004-05-03 20:45:30 +00003535 ## Checking Image at 40100000 ...
3536 Image Name: 2.2.13 for initrd on TQM850L
3537 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3538 Data Size: 335725 Bytes = 327 kB = 0 MB
3539 Load Address: 00000000
3540 Entry Point: 0000000c
3541 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543 ## Checking Image at 40200000 ...
3544 Image Name: Simple Ramdisk Image
3545 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3546 Data Size: 566530 Bytes = 553 kB = 0 MB
3547 Load Address: 00000000
3548 Entry Point: 00000000
3549 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003550
wdenk2729af92004-05-03 20:45:30 +00003551 => bootm 40100000 40200000
3552 ## Booting Linux kernel at 40100000 ...
3553 Image Name: 2.2.13 for initrd on TQM850L
3554 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3555 Data Size: 335725 Bytes = 327 kB = 0 MB
3556 Load Address: 00000000
3557 Entry Point: 0000000c
3558 Verifying Checksum ... OK
3559 Uncompressing Kernel Image ... OK
3560 ## Loading RAMDisk Image at 40200000 ...
3561 Image Name: Simple Ramdisk Image
3562 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3563 Data Size: 566530 Bytes = 553 kB = 0 MB
3564 Load Address: 00000000
3565 Entry Point: 00000000
3566 Verifying Checksum ... OK
3567 Loading Ramdisk ... OK
3568 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
3569 Boot arguments: root=/dev/ram
3570 time_init: decrementer frequency = 187500000/60
3571 Calibrating delay loop... 49.77 BogoMIPS
3572 ...
3573 RAMDISK: Compressed image found at block 0
3574 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003575
wdenk2729af92004-05-03 20:45:30 +00003576 bash#
wdenkc6097192002-11-03 00:24:07 +00003577
Matthew McClintock02677682006-06-28 10:41:37 -05003578Boot Linux and pass a flat device tree:
3579-----------
3580
3581First, U-Boot must be compiled with the appropriate defines. See the section
3582titled "Linux Kernel Interface" above for a more in depth explanation. The
3583following is an example of how to start a kernel and pass an updated
3584flat device tree:
3585
3586=> print oftaddr
3587oftaddr=0x300000
3588=> print oft
3589oft=oftrees/mpc8540ads.dtb
3590=> tftp $oftaddr $oft
3591Speed: 1000, full duplex
3592Using TSEC0 device
3593TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3594Filename 'oftrees/mpc8540ads.dtb'.
3595Load address: 0x300000
3596Loading: #
3597done
3598Bytes transferred = 4106 (100a hex)
3599=> tftp $loadaddr $bootfile
3600Speed: 1000, full duplex
3601Using TSEC0 device
3602TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3603Filename 'uImage'.
3604Load address: 0x200000
3605Loading:############
3606done
3607Bytes transferred = 1029407 (fb51f hex)
3608=> print loadaddr
3609loadaddr=200000
3610=> print oftaddr
3611oftaddr=0x300000
3612=> bootm $loadaddr - $oftaddr
3613## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003614 Image Name: Linux-2.6.17-dirty
3615 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3616 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003617 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003618 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003619 Verifying Checksum ... OK
3620 Uncompressing Kernel Image ... OK
3621Booting using flat device tree at 0x300000
3622Using MPC85xx ADS machine description
3623Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3624[snip]
3625
3626
wdenk2729af92004-05-03 20:45:30 +00003627More About U-Boot Image Types:
3628------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003629
wdenk2729af92004-05-03 20:45:30 +00003630U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003631
wdenk2729af92004-05-03 20:45:30 +00003632 "Standalone Programs" are directly runnable in the environment
3633 provided by U-Boot; it is expected that (if they behave
3634 well) you can continue to work in U-Boot after return from
3635 the Standalone Program.
3636 "OS Kernel Images" are usually images of some Embedded OS which
3637 will take over control completely. Usually these programs
3638 will install their own set of exception handlers, device
3639 drivers, set up the MMU, etc. - this means, that you cannot
3640 expect to re-enter U-Boot except by resetting the CPU.
3641 "RAMDisk Images" are more or less just data blocks, and their
3642 parameters (address, size) are passed to an OS kernel that is
3643 being started.
3644 "Multi-File Images" contain several images, typically an OS
3645 (Linux) kernel image and one or more data images like
3646 RAMDisks. This construct is useful for instance when you want
3647 to boot over the network using BOOTP etc., where the boot
3648 server provides just a single image file, but you want to get
3649 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003650
wdenk2729af92004-05-03 20:45:30 +00003651 "Multi-File Images" start with a list of image sizes, each
3652 image size (in bytes) specified by an "uint32_t" in network
3653 byte order. This list is terminated by an "(uint32_t)0".
3654 Immediately after the terminating 0 follow the images, one by
3655 one, all aligned on "uint32_t" boundaries (size rounded up to
3656 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003657
wdenk2729af92004-05-03 20:45:30 +00003658 "Firmware Images" are binary images containing firmware (like
3659 U-Boot or FPGA images) which usually will be programmed to
3660 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662 "Script files" are command sequences that will be executed by
3663 U-Boot's command interpreter; this feature is especially
3664 useful when you configure U-Boot to use a real shell (hush)
3665 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003666
wdenkc6097192002-11-03 00:24:07 +00003667
wdenk2729af92004-05-03 20:45:30 +00003668Standalone HOWTO:
3669=================
wdenkc6097192002-11-03 00:24:07 +00003670
wdenk2729af92004-05-03 20:45:30 +00003671One of the features of U-Boot is that you can dynamically load and
3672run "standalone" applications, which can use some resources of
3673U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003674
wdenk2729af92004-05-03 20:45:30 +00003675Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003676
wdenk2729af92004-05-03 20:45:30 +00003677"Hello World" Demo:
3678-------------------
wdenkc6097192002-11-03 00:24:07 +00003679
wdenk2729af92004-05-03 20:45:30 +00003680'examples/hello_world.c' contains a small "Hello World" Demo
3681application; it is automatically compiled when you build U-Boot.
3682It's configured to run at address 0x00040004, so you can play with it
3683like that:
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk2729af92004-05-03 20:45:30 +00003685 => loads
3686 ## Ready for S-Record download ...
3687 ~>examples/hello_world.srec
3688 1 2 3 4 5 6 7 8 9 10 11 ...
3689 [file transfer complete]
3690 [connected]
3691 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003692
wdenk2729af92004-05-03 20:45:30 +00003693 => go 40004 Hello World! This is a test.
3694 ## Starting application at 0x00040004 ...
3695 Hello World
3696 argc = 7
3697 argv[0] = "40004"
3698 argv[1] = "Hello"
3699 argv[2] = "World!"
3700 argv[3] = "This"
3701 argv[4] = "is"
3702 argv[5] = "a"
3703 argv[6] = "test."
3704 argv[7] = "<NULL>"
3705 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003706
wdenk2729af92004-05-03 20:45:30 +00003707 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003708
wdenk2729af92004-05-03 20:45:30 +00003709Another example, which demonstrates how to register a CPM interrupt
3710handler with the U-Boot code, can be found in 'examples/timer.c'.
3711Here, a CPM timer is set up to generate an interrupt every second.
3712The interrupt service routine is trivial, just printing a '.'
3713character, but this is just a demo program. The application can be
3714controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003715
wdenk2729af92004-05-03 20:45:30 +00003716 ? - print current values og the CPM Timer registers
3717 b - enable interrupts and start timer
3718 e - stop timer and disable interrupts
3719 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003720
wdenk2729af92004-05-03 20:45:30 +00003721 => loads
3722 ## Ready for S-Record download ...
3723 ~>examples/timer.srec
3724 1 2 3 4 5 6 7 8 9 10 11 ...
3725 [file transfer complete]
3726 [connected]
3727 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003728
wdenk2729af92004-05-03 20:45:30 +00003729 => go 40004
3730 ## Starting application at 0x00040004 ...
3731 TIMERS=0xfff00980
3732 Using timer 1
3733 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003734
wdenk2729af92004-05-03 20:45:30 +00003735Hit 'b':
3736 [q, b, e, ?] Set interval 1000000 us
3737 Enabling timer
3738Hit '?':
3739 [q, b, e, ?] ........
3740 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3741Hit '?':
3742 [q, b, e, ?] .
3743 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3744Hit '?':
3745 [q, b, e, ?] .
3746 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3747Hit '?':
3748 [q, b, e, ?] .
3749 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3750Hit 'e':
3751 [q, b, e, ?] ...Stopping timer
3752Hit 'q':
3753 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003754
3755
wdenk2729af92004-05-03 20:45:30 +00003756Minicom warning:
3757================
wdenk85ec0bc2003-03-31 16:34:49 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759Over time, many people have reported problems when trying to use the
3760"minicom" terminal emulation program for serial download. I (wd)
3761consider minicom to be broken, and recommend not to use it. Under
3762Unix, I recommend to use C-Kermit for general purpose use (and
3763especially for kermit binary protocol download ("loadb" command), and
3764use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003765
wdenk2729af92004-05-03 20:45:30 +00003766Nevertheless, if you absolutely want to use it try adding this
3767configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003768
wdenk2729af92004-05-03 20:45:30 +00003769 Name Program Name U/D FullScr IO-Red. Multi
3770 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3771 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003772
3773
wdenk2729af92004-05-03 20:45:30 +00003774NetBSD Notes:
3775=============
wdenkc6097192002-11-03 00:24:07 +00003776
wdenk2729af92004-05-03 20:45:30 +00003777Starting at version 0.9.2, U-Boot supports NetBSD both as host
3778(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003779
wdenk2729af92004-05-03 20:45:30 +00003780Building requires a cross environment; it is known to work on
3781NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3782need gmake since the Makefiles are not compatible with BSD make).
3783Note that the cross-powerpc package does not install include files;
3784attempting to build U-Boot will fail because <machine/ansi.h> is
3785missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003786
wdenk2729af92004-05-03 20:45:30 +00003787 # cd /usr/pkg/cross/powerpc-netbsd/include
3788 # mkdir powerpc
3789 # ln -s powerpc machine
3790 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3791 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003792
wdenk2729af92004-05-03 20:45:30 +00003793Native builds *don't* work due to incompatibilities between native
3794and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003795
wdenk2729af92004-05-03 20:45:30 +00003796Booting assumes that (the first part of) the image booted is a
3797stage-2 loader which in turn loads and then invokes the kernel
3798proper. Loader sources will eventually appear in the NetBSD source
3799tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003800meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003801
3802
wdenk2729af92004-05-03 20:45:30 +00003803Implementation Internals:
3804=========================
wdenkc6097192002-11-03 00:24:07 +00003805
wdenk2729af92004-05-03 20:45:30 +00003806The following is not intended to be a complete description of every
3807implementation detail. However, it should help to understand the
3808inner workings of U-Boot and make it easier to port it to custom
3809hardware.
wdenkc6097192002-11-03 00:24:07 +00003810
3811
wdenk2729af92004-05-03 20:45:30 +00003812Initial Stack, Global Data:
3813---------------------------
wdenkc6097192002-11-03 00:24:07 +00003814
wdenk2729af92004-05-03 20:45:30 +00003815The implementation of U-Boot is complicated by the fact that U-Boot
3816starts running out of ROM (flash memory), usually without access to
3817system RAM (because the memory controller is not initialized yet).
3818This means that we don't have writable Data or BSS segments, and BSS
3819is not initialized as zero. To be able to get a C environment working
3820at all, we have to allocate at least a minimal stack. Implementation
3821options for this are defined and restricted by the CPU used: Some CPU
3822models provide on-chip memory (like the IMMR area on MPC8xx and
3823MPC826x processors), on others (parts of) the data cache can be
3824locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003825
Wolfgang Denk218ca722008-03-26 10:40:12 +01003826 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01003827 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00003828
wdenk2729af92004-05-03 20:45:30 +00003829 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3830 From: "Chris Hallinan" <clh@net1plus.com>
3831 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3832 ...
wdenk43d96162003-03-06 00:02:04 +00003833
wdenk2729af92004-05-03 20:45:30 +00003834 Correct me if I'm wrong, folks, but the way I understand it
3835 is this: Using DCACHE as initial RAM for Stack, etc, does not
3836 require any physical RAM backing up the cache. The cleverness
3837 is that the cache is being used as a temporary supply of
3838 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003839 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00003840 can see how this works by studying the cache architecture and
3841 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003842
wdenk2729af92004-05-03 20:45:30 +00003843 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3844 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003845 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00003846 option should work for you. Using CS 4 should be fine if your
3847 board designers haven't used it for something that would
3848 cause you grief during the initial boot! It is frequently not
3849 used.
wdenk43d96162003-03-06 00:02:04 +00003850
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003851 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00003852 with your processor/board/system design. The default value
3853 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003854 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003855 than your SDRAM module. If you have a 64MB SDRAM module, set
3856 it above 400_0000. Just make sure your board has no resources
3857 that are supposed to respond to that address! That code in
3858 start.S has been around a while and should work as is when
3859 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003860
wdenk2729af92004-05-03 20:45:30 +00003861 -Chris Hallinan
3862 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864It is essential to remember this, since it has some impact on the C
3865code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003866
wdenk2729af92004-05-03 20:45:30 +00003867* Initialized global data (data segment) is read-only. Do not attempt
3868 to write it.
wdenkc6097192002-11-03 00:24:07 +00003869
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003870* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00003871 as zero data - BSS segment) at all - this is undefined, initiali-
3872 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874* Stack space is very limited. Avoid big data buffers or things like
3875 that.
wdenkc6097192002-11-03 00:24:07 +00003876
wdenk2729af92004-05-03 20:45:30 +00003877Having only the stack as writable memory limits means we cannot use
3878normal global data to share information beween the code. But it
3879turned out that the implementation of U-Boot can be greatly
3880simplified by making a global data structure (gd_t) available to all
3881functions. We could pass a pointer to this data as argument to _all_
3882functions, but this would bloat the code. Instead we use a feature of
3883the GCC compiler (Global Register Variables) to share the data: we
3884place a pointer (gd) to the global data into a register which we
3885reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003886
wdenk2729af92004-05-03 20:45:30 +00003887When choosing a register for such a purpose we are restricted by the
3888relevant (E)ABI specifications for the current architecture, and by
3889GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003890
wdenk2729af92004-05-03 20:45:30 +00003891For PowerPC, the following registers have specific use:
3892 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01003893 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00003894 R3-R4: parameter passing and return values
3895 R5-R10: parameter passing
3896 R13: small data area pointer
3897 R30: GOT pointer
3898 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003899
wdenk2729af92004-05-03 20:45:30 +00003900 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003901
Wolfgang Denke7670f62008-02-14 22:43:22 +01003902 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003903
wdenk2729af92004-05-03 20:45:30 +00003904 Note: on PPC, we could use a static initializer (since the
3905 address of the global data structure is known at compile time),
3906 but it turned out that reserving a register results in somewhat
3907 smaller code - although the code savings are not that big (on
3908 average for all boards 752 bytes for the whole U-Boot image,
3909 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003910
Mike Frysinger4c58eb52008-02-04 19:26:54 -05003911On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3912 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3913
3914 ==> U-Boot will use P5 to hold a pointer to the global data
3915
wdenk2729af92004-05-03 20:45:30 +00003916On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003917
wdenk2729af92004-05-03 20:45:30 +00003918 R0: function argument word/integer result
3919 R1-R3: function argument word
3920 R9: GOT pointer
3921 R10: stack limit (used only if stack checking if enabled)
3922 R11: argument (frame) pointer
3923 R12: temporary workspace
3924 R13: stack pointer
3925 R14: link register
3926 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk2729af92004-05-03 20:45:30 +00003928 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003929
Wolfgang Denkd87080b2006-03-31 18:32:53 +02003930NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3931or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk2729af92004-05-03 20:45:30 +00003933Memory Management:
3934------------------
wdenkc6097192002-11-03 00:24:07 +00003935
wdenk2729af92004-05-03 20:45:30 +00003936U-Boot runs in system state and uses physical addresses, i.e. the
3937MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003938
wdenk2729af92004-05-03 20:45:30 +00003939The available memory is mapped to fixed addresses using the memory
3940controller. In this process, a contiguous block is formed for each
3941memory type (Flash, SDRAM, SRAM), even when it consists of several
3942physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk2729af92004-05-03 20:45:30 +00003944U-Boot is installed in the first 128 kB of the first Flash bank (on
3945TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3946booting and sizing and initializing DRAM, the code relocates itself
3947to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003948memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00003949configuration setting]. Below that, a structure with global Board
3950Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003951
wdenk2729af92004-05-03 20:45:30 +00003952Additionally, some exception handler code is copied to the low 8 kB
3953of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003954
wdenk2729af92004-05-03 20:45:30 +00003955So a typical memory configuration with 16 MB of DRAM could look like
3956this:
wdenkc6097192002-11-03 00:24:07 +00003957
wdenk2729af92004-05-03 20:45:30 +00003958 0x0000 0000 Exception Vector code
3959 :
3960 0x0000 1FFF
3961 0x0000 2000 Free for Application Use
3962 :
3963 :
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk2729af92004-05-03 20:45:30 +00003965 :
3966 :
3967 0x00FB FF20 Monitor Stack (Growing downward)
3968 0x00FB FFAC Board Info Data and permanent copy of global data
3969 0x00FC 0000 Malloc Arena
3970 :
3971 0x00FD FFFF
3972 0x00FE 0000 RAM Copy of Monitor Code
3973 ... eventually: LCD or video framebuffer
3974 ... eventually: pRAM (Protected RAM - unchanged by reset)
3975 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003976
3977
wdenk2729af92004-05-03 20:45:30 +00003978System Initialization:
3979----------------------
wdenkc6097192002-11-03 00:24:07 +00003980
wdenk2729af92004-05-03 20:45:30 +00003981In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003982(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00003983configuration for CS0# this is a mirror of the onboard Flash memory.
3984To be able to re-map memory U-Boot then jumps to its link address.
3985To be able to implement the initialization code in C, a (small!)
3986initial stack is set up in the internal Dual Ported RAM (in case CPUs
3987which provide such a feature like MPC8xx or MPC8260), or in a locked
3988part of the data cache. After that, U-Boot initializes the CPU core,
3989the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003990
wdenk2729af92004-05-03 20:45:30 +00003991Next, all (potentially) available memory banks are mapped using a
3992preliminary mapping. For example, we put them on 512 MB boundaries
3993(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3994on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3995programmed for SDRAM access. Using the temporary configuration, a
3996simple memory test is run that determines the size of the SDRAM
3997banks.
wdenkc6097192002-11-03 00:24:07 +00003998
wdenk2729af92004-05-03 20:45:30 +00003999When there is more than one SDRAM bank, and the banks are of
4000different size, the largest is mapped first. For equal size, the first
4001bank (CS2#) is mapped first. The first mapping is always for address
40020x00000000, with any additional banks following immediately to create
4003contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk2729af92004-05-03 20:45:30 +00004005Then, the monitor installs itself at the upper end of the SDRAM area
4006and allocates memory for use by malloc() and for the global Board
4007Info data; also, the exception vector code is copied to the low RAM
4008pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk2729af92004-05-03 20:45:30 +00004010Only after this relocation will you have a "normal" C environment;
4011until that you are restricted in several ways, mostly because you are
4012running from ROM, and because the code will have to be relocated to a
4013new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004014
4015
wdenk2729af92004-05-03 20:45:30 +00004016U-Boot Porting Guide:
4017----------------------
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk2729af92004-05-03 20:45:30 +00004019[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4020list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004021
4022
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004023int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004024{
4025 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004026
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004027 signal(SIGALRM, no_more_time);
4028 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004029
wdenk2729af92004-05-03 20:45:30 +00004030 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004031 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004032 return 0;
4033 }
4034
wdenk2729af92004-05-03 20:45:30 +00004035 Download latest U-Boot source;
4036
Wolfgang Denk06682362008-12-30 22:56:11 +01004037 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004038
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004039 if (clueless)
4040 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004041
wdenk2729af92004-05-03 20:45:30 +00004042 while (learning) {
4043 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004044 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4045 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004046 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004047 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004048 }
wdenkc6097192002-11-03 00:24:07 +00004049
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004050 if (available_money > toLocalCurrency ($2500))
4051 Buy a BDI3000;
4052 else
wdenk2729af92004-05-03 20:45:30 +00004053 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004054
4055 if (a similar board exists) { /* hopefully... */
4056 cp -a board/<similar> board/<myboard>
4057 cp include/configs/<similar>.h include/configs/<myboard>.h
4058 } else {
4059 Create your own board support subdirectory;
4060 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004061 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004062 Edit new board/<myboard> files
4063 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004064
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004065 while (!accepted) {
4066 while (!running) {
4067 do {
4068 Add / modify source code;
4069 } until (compiles);
4070 Debug;
4071 if (clueless)
4072 email("Hi, I am having problems...");
4073 }
4074 Send patch file to the U-Boot email list;
4075 if (reasonable critiques)
4076 Incorporate improvements from email list code review;
4077 else
4078 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004079 }
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081 return 0;
4082}
4083
4084void no_more_time (int sig)
4085{
4086 hire_a_guru();
4087}
wdenkc6097192002-11-03 00:24:07 +00004088
4089
wdenk2729af92004-05-03 20:45:30 +00004090Coding Standards:
4091-----------------
wdenkc6097192002-11-03 00:24:07 +00004092
wdenk2729af92004-05-03 20:45:30 +00004093All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004094coding style; see the file "Documentation/CodingStyle" and the script
4095"scripts/Lindent" in your Linux kernel source directory. In sources
4096originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4097spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004098
Detlev Zundel2c051652006-09-01 15:39:02 +02004099Source files originating from a different project (for example the
4100MTD subsystem) are generally exempt from these guidelines and are not
4101reformated to ease subsequent migration to newer versions of those
4102sources.
4103
4104Please note that U-Boot is implemented in C (and to some small parts in
4105Assembler); no C++ is used, so please do not use C++ style comments (//)
4106in your code.
wdenk2729af92004-05-03 20:45:30 +00004107
4108Please also stick to the following formatting rules:
4109- remove any trailing white space
4110- use TAB characters for indentation, not spaces
4111- make sure NOT to use DOS '\r\n' line feeds
4112- do not add more than 2 empty lines to source files
4113- do not add trailing empty lines to source files
4114
4115Submissions which do not conform to the standards may be returned
4116with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004117
4118
wdenk2729af92004-05-03 20:45:30 +00004119Submitting Patches:
4120-------------------
wdenkc6097192002-11-03 00:24:07 +00004121
wdenk2729af92004-05-03 20:45:30 +00004122Since the number of patches for U-Boot is growing, we need to
4123establish some rules. Submissions which do not conform to these rules
4124may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004125
Magnus Lilja0d28f342008-08-06 19:32:33 +02004126Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004127
Wolfgang Denk06682362008-12-30 22:56:11 +01004128Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4129see http://lists.denx.de/mailman/listinfo/u-boot
4130
wdenk2729af92004-05-03 20:45:30 +00004131When you send a patch, please include the following information with
4132it:
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134* For bug fixes: a description of the bug and how your patch fixes
4135 this bug. Please try to include a way of demonstrating that the
4136 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk2729af92004-05-03 20:45:30 +00004138* For new features: a description of the feature and your
4139 implementation.
wdenkc6097192002-11-03 00:24:07 +00004140
wdenk2729af92004-05-03 20:45:30 +00004141* A CHANGELOG entry as plaintext (separate from the patch)
4142
4143* For major contributions, your entry to the CREDITS file
4144
4145* When you add support for a new board, don't forget to add this
4146 board to the MAKEALL script, too.
4147
4148* If your patch adds new configuration options, don't forget to
4149 document these in the README file.
4150
Wolfgang Denk218ca722008-03-26 10:40:12 +01004151* The patch itself. If you are using git (which is *strongly*
4152 recommended) you can easily generate the patch using the
4153 "git-format-patch". If you then use "git-send-email" to send it to
4154 the U-Boot mailing list, you will avoid most of the common problems
4155 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004156
Wolfgang Denk218ca722008-03-26 10:40:12 +01004157 If you cannot use git, use "diff -purN OLD NEW". If your version of
4158 diff does not support these options, then get the latest version of
4159 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004160
Wolfgang Denk218ca722008-03-26 10:40:12 +01004161 The current directory when running this command shall be the parent
4162 directory of the U-Boot source tree (i. e. please make sure that
4163 your patch includes sufficient directory information for the
4164 affected files).
4165
4166 We prefer patches as plain text. MIME attachments are discouraged,
4167 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004168
4169* If one logical set of modifications affects or creates several
4170 files, all these changes shall be submitted in a SINGLE patch file.
4171
4172* Changesets that contain different, unrelated modifications shall be
4173 submitted as SEPARATE patches, one patch per changeset.
4174
4175
4176Notes:
4177
4178* Before sending the patch, run the MAKEALL script on your patched
4179 source tree and make sure that no errors or warnings are reported
4180 for any of the boards.
4181
4182* Keep your modifications to the necessary minimum: A patch
4183 containing several unrelated changes or arbitrary reformats will be
4184 returned with a request to re-formatting / split it.
4185
4186* If you modify existing code, make sure that your new code does not
4187 add to the memory footprint of the code ;-) Small is beautiful!
4188 When adding new features, these should compile conditionally only
4189 (using #ifdef), and the resulting code with the new feature
4190 disabled must not need more memory than the old code without your
4191 modification.
wdenk90dc6702005-05-03 14:12:25 +00004192
Wolfgang Denk06682362008-12-30 22:56:11 +01004193* Remember that there is a size limit of 100 kB per message on the
4194 u-boot mailing list. Bigger patches will be moderated. If they are
4195 reasonable and not too big, they will be acknowledged. But patches
4196 bigger than the size limit should be avoided.