blob: 556bf59c15b67d0bee34fca7873923e94792bfff [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002# (C) Copyright 2000 - 2009
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
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Wolfgang Denka9046b92010-06-13 17:48:15 +0200150 /at91rm9200 Files specific to Atmel AT91RM9200 CPU
151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
167 /i386 Files generic to i386 architecture
168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
183 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /nios2 Files generic to Altera NIOS2 architecture
185 /cpu CPU specific files
186 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200187 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /cpu CPU specific files
189 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
190 /mpc5xx Files specific to Freescale MPC5xx CPUs
191 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
192 /mpc8xx Files specific to Freescale MPC8xx CPUs
193 /mpc8220 Files specific to Freescale MPC8220 CPUs
194 /mpc824x Files specific to Freescale MPC824x CPUs
195 /mpc8260 Files specific to Freescale MPC8260 CPUs
196 /mpc85xx Files specific to Freescale MPC85xx CPUs
197 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
198 /lib Architecture specific library files
199 /sh Files generic to SH architecture
200 /cpu CPU specific files
201 /sh2 Files specific to sh2 CPUs
202 /sh3 Files specific to sh3 CPUs
203 /sh4 Files specific to sh4 CPUs
204 /lib Architecture specific library files
205 /sparc Files generic to SPARC architecture
206 /cpu CPU specific files
207 /leon2 Files specific to Gaisler LEON2 SPARC CPU
208 /leon3 Files specific to Gaisler LEON3 SPARC CPU
209 /lib Architecture specific library files
210/api Machine/arch independent API for external apps
211/board Board dependent files
212/common Misc architecture independent functions
213/disk Code for disk drive partition handling
214/doc Documentation (don't expect too much)
215/drivers Commonly used device drivers
216/examples Example code for standalone applications, etc.
217/fs Filesystem code (cramfs, ext2, jffs2, etc.)
218/include Header Files
219/lib Files generic to all architectures
220 /libfdt Library files to support flattened device trees
221 /lzma Library files to support LZMA decompression
222 /lzo Library files to support LZO decompression
223/net Networking code
224/post Power On Self Test
225/rtc Real Time Clock drivers
226/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000227
wdenkc6097192002-11-03 00:24:07 +0000228Software Configuration:
229=======================
230
231Configuration is usually done using C preprocessor defines; the
232rationale behind that is to avoid dead code whenever possible.
233
234There are two classes of configuration variables:
235
236* Configuration _OPTIONS_:
237 These are selectable by the user and have names beginning with
238 "CONFIG_".
239
240* Configuration _SETTINGS_:
241 These depend on the hardware etc. and should not be meddled with if
242 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200243 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000244
245Later we will add a configuration tool - probably similar to or even
246identical to what's used for the Linux kernel. Right now, we have to
247do the configuration by hand, which means creating some symbolic
248links and editing some configuration files. We use the TQM8xxL boards
249as an example here.
250
251
252Selection of Processor Architecture and Board Type:
253---------------------------------------------------
254
255For all supported boards there are ready-to-use default
256configurations available; just type "make <board_name>_config".
257
258Example: For a TQM823L module type:
259
260 cd u-boot
261 make TQM823L_config
262
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200263For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000264e.g. "make cogent_mpc8xx_config". And also configure the cogent
265directory according to the instructions in cogent/README.
266
267
268Configuration Options:
269----------------------
270
271Configuration depends on the combination of board and CPU type; all
272such information is kept in a configuration file
273"include/configs/<board_name>.h".
274
275Example: For a TQM823L module, all configuration settings are in
276"include/configs/TQM823L.h".
277
278
wdenk7f6c2cb2002-11-10 22:06:23 +0000279Many of the options are named exactly as the corresponding Linux
280kernel configuration options. The intention is to make it easier to
281build a config tool - later.
282
283
wdenkc6097192002-11-03 00:24:07 +0000284The following options need to be configured:
285
Kim Phillips26281142007-08-10 13:28:25 -0500286- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000287
Kim Phillips26281142007-08-10 13:28:25 -0500288- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200289
290- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100291 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000292
293- CPU Module Type: (if CONFIG_COGENT is defined)
294 Define exactly one of
295 CONFIG_CMA286_60_OLD
296--- FIXME --- not tested yet:
297 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298 CONFIG_CMA287_23, CONFIG_CMA287_50
299
300- Motherboard Type: (if CONFIG_COGENT is defined)
301 Define exactly one of
302 CONFIG_CMA101, CONFIG_CMA102
303
304- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305 Define one or more of
306 CONFIG_CMA302
307
308- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309 Define one or more of
310 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200311 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000312 a "rotator" |\-/|\-/
313
wdenk2535d602003-07-17 23:16:40 +0000314- Board flavour: (if CONFIG_MPC8260ADS is defined)
315 CONFIG_ADSTYPE
316 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200317 CONFIG_SYS_8260ADS - original MPC8260ADS
318 CONFIG_SYS_8266ADS - MPC8266ADS
319 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
320 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000321
wdenkc6097192002-11-03 00:24:07 +0000322- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000323 Define exactly one of
324 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000325
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200326- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000327 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
328 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000329 e.g. if there is no 32KHz
330 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000331 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
332 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000333
wdenk66ca92a2004-09-28 17:59:53 +0000334- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200335 CONFIG_SYS_8xx_CPUCLK_MIN
336 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000337 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000338 See doc/README.MPC866
339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000341
wdenkba56f622004-02-06 23:19:44 +0000342 Define this to measure the actual CPU clock instead
343 of relying on the correctness of the configured
344 values. Mostly useful for board bringup to make sure
345 the PLL is locked at the intended frequency. Note
346 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000348
Heiko Schocher506f3912009-03-12 07:37:15 +0100349 CONFIG_SYS_DELAYED_ICACHE
350
351 Define this option if you want to enable the
352 ICache only when Code runs from RAM.
353
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100354- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200355 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100356
357 Defines the Monahans run mode to oscillator
358 ratio. Valid values are 8, 16, 24, 31. The core
359 frequency is this value multiplied by 13 MHz.
360
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200361 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200362
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100363 Defines the Monahans turbo mode to oscillator
364 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200365 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100366 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200367
wdenk5da627a2003-10-09 20:09:04 +0000368- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000369 CONFIG_CLOCKS_IN_MHZ
370
371 U-Boot stores all clock information in Hz
372 internally. For binary compatibility with older Linux
373 kernels (which expect the clocks passed in the
374 bd_info data to be in MHz) the environment variable
375 "clocks_in_mhz" can be defined so that U-Boot
376 converts clock data to MHZ before passing it to the
377 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000378 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100379 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000380 default environment.
381
wdenk5da627a2003-10-09 20:09:04 +0000382 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
383
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200384 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000385 expect it to be in bytes, others in MB.
386 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
387
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400388 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200389
390 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400391 passed using flattened device trees (based on open firmware
392 concepts).
393
394 CONFIG_OF_LIBFDT
395 * New libfdt-based support
396 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500397 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400398
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200399 OF_CPU - The proper name of the cpus node (only required for
400 MPC512X and MPC5xxx based boards).
401 OF_SOC - The proper name of the soc node (only required for
402 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200403 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600404 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200405
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200406 boards with QUICC Engines require OF_QE to set UCC MAC
407 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500408
Kumar Gala4e253132006-01-11 13:54:17 -0600409 CONFIG_OF_BOARD_SETUP
410
411 Board code has addition modification that it wants to make
412 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000413
Matthew McClintock02677682006-06-28 10:41:37 -0500414 CONFIG_OF_BOOT_CPU
415
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200416 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500417 param header, the default value is zero if undefined.
418
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200419 CONFIG_OF_IDE_FIXUP
420
421 U-Boot can detect if an IDE device is present or not.
422 If not, and this new config option is activated, U-Boot
423 removes the ATA node from the DTS before booting Linux,
424 so the Linux IDE driver does not probe the device and
425 crash. This is needed for buggy hardware (uc101) where
426 no pull down resistor is connected to the signal IDE5V_DD7.
427
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100428- vxWorks boot parameters:
429
430 bootvx constructs a valid bootline using the following
431 environments variables: bootfile, ipaddr, serverip, hostname.
432 It loads the vxWorks image pointed bootfile.
433
434 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
435 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
436 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
437 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
438
439 CONFIG_SYS_VXWORKS_ADD_PARAMS
440
441 Add it at the end of the bootline. E.g "u=username pw=secret"
442
443 Note: If a "bootargs" environment is defined, it will overwride
444 the defaults discussed just above.
445
wdenk6705d812004-08-02 23:22:59 +0000446- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200447 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000448
449 Define this if you want support for Amba PrimeCell PL010 UARTs.
450
Andreas Engel48d01922008-09-08 14:30:53 +0200451 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000452
453 Define this if you want support for Amba PrimeCell PL011 UARTs.
454
455 CONFIG_PL011_CLOCK
456
457 If you have Amba PrimeCell PL011 UARTs, set this variable to
458 the clock speed of the UARTs.
459
460 CONFIG_PL01x_PORTS
461
462 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
463 define this to a list of base addresses for each (supported)
464 port. See e.g. include/configs/versatile.h
465
466
wdenkc6097192002-11-03 00:24:07 +0000467- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000468 Depending on board, define exactly one serial port
469 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
470 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
471 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000472
473 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
474 port routines must be defined elsewhere
475 (i.e. serial_init(), serial_getc(), ...)
476
477 CONFIG_CFB_CONSOLE
478 Enables console device for a color framebuffer. Needs following
479 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
480 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
481 (default big endian)
482 VIDEO_HW_RECTFILL graphic chip supports
483 rectangle fill
484 (cf. smiLynxEM)
485 VIDEO_HW_BITBLT graphic chip supports
486 bit-blit (cf. smiLynxEM)
487 VIDEO_VISIBLE_COLS visible pixel columns
488 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000489 VIDEO_VISIBLE_ROWS visible pixel rows
490 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000491 VIDEO_DATA_FORMAT graphic data format
492 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000493 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000494 VIDEO_KBD_INIT_FCT keyboard int fct
495 (i.e. i8042_kbd_init())
496 VIDEO_TSTC_FCT test char fct
497 (i.e. i8042_tstc)
498 VIDEO_GETC_FCT get char fct
499 (i.e. i8042_getc)
500 CONFIG_CONSOLE_CURSOR cursor drawing on/off
501 (requires blink timer
502 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200503 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000504 CONFIG_CONSOLE_TIME display time/date info in
505 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500506 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000507 CONFIG_VIDEO_LOGO display Linux logo in
508 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000509 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
510 linux_logo.h for logo.
511 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000512 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200513 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000514 the logo
515
wdenk43d96162003-03-06 00:02:04 +0000516 When CONFIG_CFB_CONSOLE is defined, video console is
517 default i/o. Serial console can be forced with
518 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000519
wdenkd4ca31c2004-01-02 14:00:00 +0000520 When CONFIG_SILENT_CONSOLE is defined, all console
521 messages (by U-Boot and Linux!) can be silenced with
522 the "silent" environment variable. See
523 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000524
wdenkc6097192002-11-03 00:24:07 +0000525- Console Baudrate:
526 CONFIG_BAUDRATE - in bps
527 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200528 CONFIG_SYS_BAUDRATE_TABLE, see below.
529 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000530
Heiko Schocherc92fac92009-01-30 12:55:38 +0100531- Console Rx buffer length
532 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
533 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100534 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100535 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
536 must be defined, to setup the maximum idle timeout for
537 the SMC.
538
wdenkc6097192002-11-03 00:24:07 +0000539- Boot Delay: CONFIG_BOOTDELAY - in seconds
540 Delay before automatically booting the default image;
541 set to -1 to disable autoboot.
542
543 See doc/README.autoboot for these options that
544 work with CONFIG_BOOTDELAY. None are required.
545 CONFIG_BOOT_RETRY_TIME
546 CONFIG_BOOT_RETRY_MIN
547 CONFIG_AUTOBOOT_KEYED
548 CONFIG_AUTOBOOT_PROMPT
549 CONFIG_AUTOBOOT_DELAY_STR
550 CONFIG_AUTOBOOT_STOP_STR
551 CONFIG_AUTOBOOT_DELAY_STR2
552 CONFIG_AUTOBOOT_STOP_STR2
553 CONFIG_ZERO_BOOTDELAY_CHECK
554 CONFIG_RESET_TO_RETRY
555
556- Autoboot Command:
557 CONFIG_BOOTCOMMAND
558 Only needed when CONFIG_BOOTDELAY is enabled;
559 define a command string that is automatically executed
560 when no character is read on the console interface
561 within "Boot Delay" after reset.
562
563 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000564 This can be used to pass arguments to the bootm
565 command. The value of CONFIG_BOOTARGS goes into the
566 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000567
568 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000569 The value of these goes into the environment as
570 "ramboot" and "nfsboot" respectively, and can be used
571 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200572 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000573
574- Pre-Boot Commands:
575 CONFIG_PREBOOT
576
577 When this option is #defined, the existence of the
578 environment variable "preboot" will be checked
579 immediately before starting the CONFIG_BOOTDELAY
580 countdown and/or running the auto-boot command resp.
581 entering interactive mode.
582
583 This feature is especially useful when "preboot" is
584 automatically generated or modified. For an example
585 see the LWMON board specific code: here "preboot" is
586 modified when the user holds down a certain
587 combination of keys on the (special) keyboard when
588 booting the systems
589
590- Serial Download Echo Mode:
591 CONFIG_LOADS_ECHO
592 If defined to 1, all characters received during a
593 serial download (using the "loads" command) are
594 echoed back. This might be needed by some terminal
595 emulations (like "cu"), but may as well just take
596 time on others. This setting #define's the initial
597 value of the "loads_echo" environment variable.
598
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500599- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000600 CONFIG_KGDB_BAUDRATE
601 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200602 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000603
604- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500605 Monitor commands can be included or excluded
606 from the build by using the #include files
607 "config_cmd_all.h" and #undef'ing unwanted
608 commands, or using "config_cmd_default.h"
609 and augmenting with additional #define's
610 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000611
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500612 The default command configuration includes all commands
613 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000614
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500615 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500616 CONFIG_CMD_BDI bdinfo
617 CONFIG_CMD_BEDBUG * Include BedBug Debugger
618 CONFIG_CMD_BMP * BMP support
619 CONFIG_CMD_BSP * Board specific commands
620 CONFIG_CMD_BOOTD bootd
621 CONFIG_CMD_CACHE * icache, dcache
622 CONFIG_CMD_CONSOLE coninfo
623 CONFIG_CMD_DATE * support for RTC, date/time...
624 CONFIG_CMD_DHCP * DHCP support
625 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600626 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
627 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
628 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
629 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500630 CONFIG_CMD_DTT * Digital Therm and Thermostat
631 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500632 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500633 CONFIG_CMD_EEPROM * EEPROM read/write support
634 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500635 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500636 CONFIG_CMD_FDC * Floppy Disk Support
637 CONFIG_CMD_FAT * FAT partition support
638 CONFIG_CMD_FDOS * Dos diskette Support
639 CONFIG_CMD_FLASH flinfo, erase, protect
640 CONFIG_CMD_FPGA FPGA device initialization support
641 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
642 CONFIG_CMD_I2C * I2C serial bus support
643 CONFIG_CMD_IDE * IDE harddisk support
644 CONFIG_CMD_IMI iminfo
645 CONFIG_CMD_IMLS List all found images
646 CONFIG_CMD_IMMAP * IMMR dump support
647 CONFIG_CMD_IRQ * irqinfo
648 CONFIG_CMD_ITEST Integer/string test of 2 values
649 CONFIG_CMD_JFFS2 * JFFS2 Support
650 CONFIG_CMD_KGDB * kgdb
651 CONFIG_CMD_LOADB loadb
652 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400653 CONFIG_CMD_MD5SUM print md5 message digest
654 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500655 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
656 loop, loopw, mtest
657 CONFIG_CMD_MISC Misc functions like sleep etc
658 CONFIG_CMD_MMC * MMC memory mapped support
659 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100660 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500661 CONFIG_CMD_NAND * NAND support
662 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600663 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
664 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500665 CONFIG_CMD_PCI * pciinfo
666 CONFIG_CMD_PCMCIA * PCMCIA support
667 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
668 host
669 CONFIG_CMD_PORTIO * Port I/O
670 CONFIG_CMD_REGINFO * Register dump
671 CONFIG_CMD_RUN run command in env variable
672 CONFIG_CMD_SAVES * save S record dump
673 CONFIG_CMD_SCSI * SCSI Support
674 CONFIG_CMD_SDRAM * print SDRAM configuration information
675 (requires CONFIG_CMD_I2C)
676 CONFIG_CMD_SETGETDCR Support for DCR Register access
677 (4xx only)
Robin Getz02c9aa12009-07-27 00:07:59 -0400678 CONFIG_CMD_SHA1 print sha1 memory digest
679 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200680 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500681 CONFIG_CMD_SPI * SPI serial bus support
682 CONFIG_CMD_USB * USB support
683 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500684 CONFIG_CMD_CDP * Cisco Discover Protocol support
685 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000686
wdenkc6097192002-11-03 00:24:07 +0000687
688 EXAMPLE: If you want all functions except of network
689 support you can write:
690
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500691 #include "config_cmd_all.h"
692 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000693
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400694 Other Commands:
695 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000696
697 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500698 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000699 what you (and your U-Boot users) are doing. Data
700 cache cannot be enabled on systems like the 8xx or
701 8260 (where accesses to the IMMR region must be
702 uncached), and it cannot be disabled on all other
703 systems where we (mis-) use the data cache to hold an
704 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000705
706
707 XXX - this list needs to get updated!
708
709- Watchdog:
710 CONFIG_WATCHDOG
711 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000712 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000713 code for a watchdog. For the 8xx and 8260 CPUs, the
714 SIU Watchdog feature is enabled in the SYPCR
715 register.
716
stroesec1551ea2003-04-04 15:53:41 +0000717- U-Boot Version:
718 CONFIG_VERSION_VARIABLE
719 If this variable is defined, an environment variable
720 named "ver" is created by U-Boot showing the U-Boot
721 version as printed by the "version" command.
722 This variable is readonly.
723
wdenkc6097192002-11-03 00:24:07 +0000724- Real-Time Clock:
725
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500726 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000727 has to be selected, too. Define exactly one of the
728 following options:
729
730 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
731 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200732 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000733 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000734 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000735 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000736 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000737 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100738 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000739 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200740 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000741
wdenkb37c7e52003-06-30 16:24:52 +0000742 Note that if the RTC uses I2C, then the I2C interface
743 must also be configured. See I2C Support, below.
744
Peter Tysere92739d2008-12-17 16:36:21 -0600745- GPIO Support:
746 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
747 CONFIG_PCA953X_INFO - enable pca953x info command
748
749 Note that if the GPIO device uses I2C, then the I2C interface
750 must also be configured. See I2C Support, below.
751
wdenkc6097192002-11-03 00:24:07 +0000752- Timestamp Support:
753
wdenk43d96162003-03-06 00:02:04 +0000754 When CONFIG_TIMESTAMP is selected, the timestamp
755 (date and time) of an image is printed by image
756 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500757 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000758
759- Partition Support:
760 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400761 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000762
Wolfgang Denk218ca722008-03-26 10:40:12 +0100763 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
764 CONFIG_CMD_SCSI) you must configure support for at
765 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000766
767- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000768 CONFIG_IDE_RESET_ROUTINE - this is defined in several
769 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000770
wdenk4d13cba2004-03-14 14:09:05 +0000771 CONFIG_IDE_RESET - is this is defined, IDE Reset will
772 be performed by calling the function
773 ide_set_reset(int reset)
774 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000775
776- ATAPI Support:
777 CONFIG_ATAPI
778
779 Set this to enable ATAPI support.
780
wdenkc40b2952004-03-13 23:29:43 +0000781- LBA48 Support
782 CONFIG_LBA48
783
784 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100785 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000786 Whithout these , LBA48 support uses 32bit variables and will 'only'
787 support disks up to 2.1TB.
788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200789 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000790 When enabled, makes the IDE subsystem use 64bit sector addresses.
791 Default is 32bit.
792
wdenkc6097192002-11-03 00:24:07 +0000793- SCSI Support:
794 At the moment only there is only support for the
795 SYM53C8XX SCSI controller; define
796 CONFIG_SCSI_SYM53C8XX to enable it.
797
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200798 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
799 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
800 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000801 maximum numbers of LUNs, SCSI ID's and target
802 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200803 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000804
805- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000806 CONFIG_E1000
807 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000808
Andre Schwarzac3315c2008-03-06 16:45:44 +0100809 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200810 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100811
wdenkc6097192002-11-03 00:24:07 +0000812 CONFIG_EEPRO100
813 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200814 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000815 write routine for first time initialisation.
816
817 CONFIG_TULIP
818 Support for Digital 2114x chips.
819 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
820 modem chip initialisation (KS8761/QS6611).
821
822 CONFIG_NATSEMI
823 Support for National dp83815 chips.
824
825 CONFIG_NS8382X
826 Support for National dp8382[01] gigabit chips.
827
wdenk45219c42003-05-12 21:50:16 +0000828- NETWORK Support (other):
829
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100830 CONFIG_DRIVER_AT91EMAC
831 Support for AT91RM9200 EMAC.
832
833 CONFIG_RMII
834 Define this to use reduced MII inteface
835
836 CONFIG_DRIVER_AT91EMAC_QUIET
837 If this defined, the driver is quiet.
838 The driver doen't show link status messages.
839
wdenk45219c42003-05-12 21:50:16 +0000840 CONFIG_DRIVER_LAN91C96
841 Support for SMSC's LAN91C96 chips.
842
843 CONFIG_LAN91C96_BASE
844 Define this to hold the physical address
845 of the LAN91C96's I/O space
846
847 CONFIG_LAN91C96_USE_32_BIT
848 Define this to enable 32 bit addressing
849
wdenkf39748a2004-06-09 13:37:52 +0000850 CONFIG_DRIVER_SMC91111
851 Support for SMSC's LAN91C111 chip
852
853 CONFIG_SMC91111_BASE
854 Define this to hold the physical address
855 of the device (I/O space)
856
857 CONFIG_SMC_USE_32_BIT
858 Define this if data bus is 32 bits
859
860 CONFIG_SMC_USE_IOFUNCS
861 Define this to use i/o functions instead of macros
862 (some hardware wont work with macros)
863
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800864 CONFIG_FTGMAC100
865 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
866
867 CONFIG_FTGMAC100_EGIGA
868 Define this to use GE link update with gigabit PHY.
869 Define this if FTGMAC100 is connected to gigabit PHY.
870 If your system has 10/100 PHY only, it might not occur
871 wrong behavior. Because PHY usually return timeout or
872 useless data when polling gigabit status and gigabit
873 control registers. This behavior won't affect the
874 correctnessof 10/100 link speed update.
875
Mike Rapoportc2fff332009-11-11 10:03:03 +0200876 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200877 Support for SMSC's LAN911x and LAN921x chips
878
Mike Rapoportc2fff332009-11-11 10:03:03 +0200879 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200880 Define this to hold the physical address
881 of the device (I/O space)
882
Mike Rapoportc2fff332009-11-11 10:03:03 +0200883 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200884 Define this if data bus is 32 bits
885
Mike Rapoportc2fff332009-11-11 10:03:03 +0200886 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200887 Define this if data bus is 16 bits. If your processor
888 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200889 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200890
wdenkc6097192002-11-03 00:24:07 +0000891- USB Support:
892 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000893 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000894 CONFIG_USB_UHCI to enable it.
895 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000896 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000897 storage devices.
898 Note:
899 Supported are USB Keyboards and USB Floppy drives
900 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000901 MPC5200 USB requires additional defines:
902 CONFIG_USB_CLOCK
903 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500904 CONFIG_PSC3_USB
905 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000906 CONFIG_USB_CONFIG
907 for differential drivers: 0x00001000
908 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500909 for differential drivers on PSC3: 0x00000100
910 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200911 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200912 May be defined to allow interrupt polling
913 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000914
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200915- USB Device:
916 Define the below if you wish to use the USB console.
917 Once firmware is rebuilt from a serial console issue the
918 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200919 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200920 it has found a new device. The environment variable usbtty
921 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200922 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200923 Common Device Class Abstract Control Model serial device.
924 If you select usbtty = gserial you should be able to enumerate
925 a Linux host by
926 # modprobe usbserial vendor=0xVendorID product=0xProductID
927 else if using cdc_acm, simply setting the environment
928 variable usbtty to be cdc_acm should suffice. The following
929 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200930
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200931 CONFIG_USB_DEVICE
932 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000933
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200934 CONFIG_USB_TTY
935 Define this to have a tty type of device available to
936 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200937
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200938 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200939 Define this if you want stdin, stdout &/or stderr to
940 be set to usbtty.
941
942 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200943 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200944 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200945 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200947 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200948 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200949 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200950
Wolfgang Denk386eda02006-06-14 18:14:56 +0200951 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200952 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200953 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200954 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
955 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
956 should pretend to be a Linux device to it's target host.
957
958 CONFIG_USBD_MANUFACTURER
959 Define this string as the name of your company for
960 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200961
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200962 CONFIG_USBD_PRODUCT_NAME
963 Define this string as the name of your product
964 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
965
966 CONFIG_USBD_VENDORID
967 Define this as your assigned Vendor ID from the USB
968 Implementors Forum. This *must* be a genuine Vendor ID
969 to avoid polluting the USB namespace.
970 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200971
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200972 CONFIG_USBD_PRODUCTID
973 Define this as the unique Product ID
974 for your device
975 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000976
977
978- MMC Support:
979 The MMC controller on the Intel PXA is supported. To
980 enable this define CONFIG_MMC. The MMC can be
981 accessed from the boot prompt by mapping the device
982 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500983 enabled with CONFIG_CMD_MMC. The MMC driver also works with
984 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000985
wdenk6705d812004-08-02 23:22:59 +0000986- Journaling Flash filesystem support:
987 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
988 CONFIG_JFFS2_NAND_DEV
989 Define these for a default partition on a NAND device
990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200991 CONFIG_SYS_JFFS2_FIRST_SECTOR,
992 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +0000993 Define these for a default partition on a NOR device
994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200995 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +0000996 Define this to create an own partition. You have to provide a
997 function struct part_info* jffs2_part_info(int part_num)
998
999 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001000 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001001 to disable the command chpart. This is the default when you
1002 have not defined a custom partition
1003
wdenkc6097192002-11-03 00:24:07 +00001004- Keyboard Support:
1005 CONFIG_ISA_KEYBOARD
1006
1007 Define this to enable standard (PC-Style) keyboard
1008 support
1009
1010 CONFIG_I8042_KBD
1011 Standard PC keyboard driver with US (is default) and
1012 GERMAN key layout (switch via environment 'keymap=de') support.
1013 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1014 for cfb_console. Supports cursor blinking.
1015
1016- Video support:
1017 CONFIG_VIDEO
1018
1019 Define this to enable video support (for output to
1020 video).
1021
1022 CONFIG_VIDEO_CT69000
1023
1024 Enable Chips & Technologies 69000 Video chip
1025
1026 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001027 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001028 video output is selected via environment 'videoout'
1029 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1030 assumed.
wdenkc6097192002-11-03 00:24:07 +00001031
wdenkb79a11c2004-03-25 15:14:43 +00001032 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001033 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001034 are possible:
1035 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001036 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001037
1038 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1039 -------------+---------------------------------------------
1040 8 bits | 0x301* 0x303 0x305 0x161 0x307
1041 15 bits | 0x310 0x313 0x316 0x162 0x319
1042 16 bits | 0x311 0x314 0x317 0x163 0x31A
1043 24 bits | 0x312 0x315 0x318 ? 0x31B
1044 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001045 (i.e. setenv videomode 317; saveenv; reset;)
1046
wdenkb79a11c2004-03-25 15:14:43 +00001047 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001048 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001049
1050
stroesec1551ea2003-04-04 15:53:41 +00001051 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001052 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001053 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1054 or CONFIG_VIDEO_SED13806_16BPP
1055
wdenk682011f2003-06-03 23:54:09 +00001056- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001057 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001058
wdenk8bde7f72003-06-27 21:31:46 +00001059 Define this to enable a custom keyboard support.
1060 This simply calls drv_keyboard_init() which must be
1061 defined in your board-specific files.
1062 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001063
wdenkc6097192002-11-03 00:24:07 +00001064- LCD Support: CONFIG_LCD
1065
1066 Define this to enable LCD support (for output to LCD
1067 display); also select one of the supported displays
1068 by defining one of these:
1069
Stelian Pop39cf4802008-05-09 21:57:18 +02001070 CONFIG_ATMEL_LCD:
1071
1072 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1073
wdenkfd3103b2003-11-25 16:55:19 +00001074 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001075
wdenkfd3103b2003-11-25 16:55:19 +00001076 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001077
wdenkfd3103b2003-11-25 16:55:19 +00001078 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001079
wdenkfd3103b2003-11-25 16:55:19 +00001080 NEC NL6448BC20-08. 6.5", 640x480.
1081 Active, color, single scan.
1082
1083 CONFIG_NEC_NL6448BC33_54
1084
1085 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001086 Active, color, single scan.
1087
1088 CONFIG_SHARP_16x9
1089
1090 Sharp 320x240. Active, color, single scan.
1091 It isn't 16x9, and I am not sure what it is.
1092
1093 CONFIG_SHARP_LQ64D341
1094
1095 Sharp LQ64D341 display, 640x480.
1096 Active, color, single scan.
1097
1098 CONFIG_HLD1045
1099
1100 HLD1045 display, 640x480.
1101 Active, color, single scan.
1102
1103 CONFIG_OPTREX_BW
1104
1105 Optrex CBL50840-2 NF-FW 99 22 M5
1106 or
1107 Hitachi LMG6912RPFC-00T
1108 or
1109 Hitachi SP14Q002
1110
1111 320x240. Black & white.
1112
1113 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001114 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001115
wdenk7152b1d2003-09-05 23:19:14 +00001116- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001117
wdenk8bde7f72003-06-27 21:31:46 +00001118 If this option is set, the environment is checked for
1119 a variable "splashimage". If found, the usual display
1120 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001121 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001122 specified in "splashimage" is loaded instead. The
1123 console is redirected to the "nulldev", too. This
1124 allows for a "silent" boot where a splash screen is
1125 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001126
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001127 CONFIG_SPLASH_SCREEN_ALIGN
1128
1129 If this option is set the splash image can be freely positioned
1130 on the screen. Environment variable "splashpos" specifies the
1131 position as "x,y". If a positive number is given it is used as
1132 number of pixel from left/top. If a negative number is given it
1133 is used as number of pixel from right/bottom. You can also
1134 specify 'm' for centering the image.
1135
1136 Example:
1137 setenv splashpos m,m
1138 => image at center of screen
1139
1140 setenv splashpos 30,20
1141 => image at x = 30 and y = 20
1142
1143 setenv splashpos -10,m
1144 => vertically centered image
1145 at x = dspWidth - bmpWidth - 9
1146
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001147- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1148
1149 If this option is set, additionally to standard BMP
1150 images, gzipped BMP images can be displayed via the
1151 splashscreen support or the bmp command.
1152
Anatolij Gustschind5011762010-03-15 14:50:25 +01001153- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1154
1155 If this option is set, 8-bit RLE compressed BMP images
1156 can be displayed via the splashscreen support or the
1157 bmp command.
1158
wdenkc29fdfc2003-08-29 20:57:53 +00001159- Compression support:
1160 CONFIG_BZIP2
1161
1162 If this option is set, support for bzip2 compressed
1163 images is included. If not, only uncompressed and gzip
1164 compressed images are supported.
1165
wdenk42d1f032003-10-15 23:53:47 +00001166 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001167 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001168 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001169
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001170 CONFIG_LZMA
1171
1172 If this option is set, support for lzma compressed
1173 images is included.
1174
1175 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1176 requires an amount of dynamic memory that is given by the
1177 formula:
1178
1179 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1180
1181 Where lc and lp stand for, respectively, Literal context bits
1182 and Literal pos bits.
1183
1184 This value is upper-bounded by 14MB in the worst case. Anyway,
1185 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1186 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1187 a very small buffer.
1188
1189 Use the lzmainfo tool to determinate the lc and lp values and
1190 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001191 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001192
wdenk17ea1172004-06-06 21:51:03 +00001193- MII/PHY support:
1194 CONFIG_PHY_ADDR
1195
1196 The address of PHY on MII bus.
1197
1198 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1199
1200 The clock frequency of the MII bus
1201
1202 CONFIG_PHY_GIGE
1203
1204 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001205 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001206
1207 CONFIG_PHY_RESET_DELAY
1208
1209 Some PHY like Intel LXT971A need extra delay after
1210 reset before any MII register access is possible.
1211 For such PHY, set this option to the usec delay
1212 required. (minimum 300usec for LXT971A)
1213
1214 CONFIG_PHY_CMD_DELAY (ppc4xx)
1215
1216 Some PHY like Intel LXT971A need extra delay after
1217 command issued before MII status register can be read
1218
wdenkc6097192002-11-03 00:24:07 +00001219- Ethernet address:
1220 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001221 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001222 CONFIG_ETH2ADDR
1223 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001224 CONFIG_ETH4ADDR
1225 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001226
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001227 Define a default value for Ethernet address to use
1228 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001229 is not determined automatically.
1230
1231- IP address:
1232 CONFIG_IPADDR
1233
1234 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001235 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001236 determined through e.g. bootp.
1237
1238- Server IP address:
1239 CONFIG_SERVERIP
1240
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001241 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001242 server to contact when using the "tftboot" command.
1243
Robin Getz97cfe862009-07-21 12:15:28 -04001244 CONFIG_KEEP_SERVERADDR
1245
1246 Keeps the server's MAC address, in the env 'serveraddr'
1247 for passing to bootargs (like Linux's netconsole option)
1248
David Updegraff53a5c422007-06-11 10:41:07 -05001249- Multicast TFTP Mode:
1250 CONFIG_MCAST_TFTP
1251
1252 Defines whether you want to support multicast TFTP as per
1253 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001254 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001255 driver in use must provide a function: mcast() to join/leave a
1256 multicast group.
1257
1258 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001259- BOOTP Recovery Mode:
1260 CONFIG_BOOTP_RANDOM_DELAY
1261
1262 If you have many targets in a network that try to
1263 boot using BOOTP, you may want to avoid that all
1264 systems send out BOOTP requests at precisely the same
1265 moment (which would happen for instance at recovery
1266 from a power failure, when all systems will try to
1267 boot, thus flooding the BOOTP server. Defining
1268 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1269 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001270 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001271
1272 1st BOOTP request: delay 0 ... 1 sec
1273 2nd BOOTP request: delay 0 ... 2 sec
1274 3rd BOOTP request: delay 0 ... 4 sec
1275 4th and following
1276 BOOTP requests: delay 0 ... 8 sec
1277
stroesefe389a82003-08-28 14:17:32 +00001278- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001279 You can fine tune the DHCP functionality by defining
1280 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001281
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001282 CONFIG_BOOTP_SUBNETMASK
1283 CONFIG_BOOTP_GATEWAY
1284 CONFIG_BOOTP_HOSTNAME
1285 CONFIG_BOOTP_NISDOMAIN
1286 CONFIG_BOOTP_BOOTPATH
1287 CONFIG_BOOTP_BOOTFILESIZE
1288 CONFIG_BOOTP_DNS
1289 CONFIG_BOOTP_DNS2
1290 CONFIG_BOOTP_SEND_HOSTNAME
1291 CONFIG_BOOTP_NTPSERVER
1292 CONFIG_BOOTP_TIMEOFFSET
1293 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001294
Wilson Callan5d110f02007-07-28 10:56:13 -04001295 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1296 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001297
1298 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1299 serverip from a DHCP server, it is possible that more
1300 than one DNS serverip is offered to the client.
1301 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1302 serverip will be stored in the additional environment
1303 variable "dnsip2". The first DNS serverip is always
1304 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001305 is defined.
stroesefe389a82003-08-28 14:17:32 +00001306
1307 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1308 to do a dynamic update of a DNS server. To do this, they
1309 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001310 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001311 of the "hostname" environment variable is passed as
1312 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001313
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001314 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1315
1316 A 32bit value in microseconds for a delay between
1317 receiving a "DHCP Offer" and sending the "DHCP Request".
1318 This fixes a problem with certain DHCP servers that don't
1319 respond 100% of the time to a "DHCP request". E.g. On an
1320 AT91RM9200 processor running at 180MHz, this delay needed
1321 to be *at least* 15,000 usec before a Windows Server 2003
1322 DHCP server would reply 100% of the time. I recommend at
1323 least 50,000 usec to be safe. The alternative is to hope
1324 that one of the retries will be successful but note that
1325 the DHCP timeout and retry process takes a longer than
1326 this delay.
1327
wdenka3d991b2004-04-15 21:48:45 +00001328 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001329 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001330
1331 The device id used in CDP trigger frames.
1332
1333 CONFIG_CDP_DEVICE_ID_PREFIX
1334
1335 A two character string which is prefixed to the MAC address
1336 of the device.
1337
1338 CONFIG_CDP_PORT_ID
1339
1340 A printf format string which contains the ascii name of
1341 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001342 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001343
1344 CONFIG_CDP_CAPABILITIES
1345
1346 A 32bit integer which indicates the device capabilities;
1347 0x00000010 for a normal host which does not forwards.
1348
1349 CONFIG_CDP_VERSION
1350
1351 An ascii string containing the version of the software.
1352
1353 CONFIG_CDP_PLATFORM
1354
1355 An ascii string containing the name of the platform.
1356
1357 CONFIG_CDP_TRIGGER
1358
1359 A 32bit integer sent on the trigger.
1360
1361 CONFIG_CDP_POWER_CONSUMPTION
1362
1363 A 16bit integer containing the power consumption of the
1364 device in .1 of milliwatts.
1365
1366 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1367
1368 A byte containing the id of the VLAN.
1369
wdenkc6097192002-11-03 00:24:07 +00001370- Status LED: CONFIG_STATUS_LED
1371
1372 Several configurations allow to display the current
1373 status using a LED. For instance, the LED will blink
1374 fast while running U-Boot code, stop blinking as
1375 soon as a reply to a BOOTP request was received, and
1376 start blinking slow once the Linux kernel is running
1377 (supported by a status LED driver in the Linux
1378 kernel). Defining CONFIG_STATUS_LED enables this
1379 feature in U-Boot.
1380
1381- CAN Support: CONFIG_CAN_DRIVER
1382
1383 Defining CONFIG_CAN_DRIVER enables CAN driver support
1384 on those systems that support this (optional)
1385 feature, like the TQM8xxL modules.
1386
1387- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1388
wdenkb37c7e52003-06-30 16:24:52 +00001389 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001390 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001391 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001392
wdenk945af8d2003-07-16 21:53:01 +00001393 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001394 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001395 CONFIG_COMMANDS) and communicate with i2c based realtime
1396 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001397 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001398
Ben Warrenbb99ad62006-09-07 16:50:54 -04001399 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001400
wdenk945af8d2003-07-16 21:53:01 +00001401 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001402 bit-banging) driver instead of CPM or similar hardware
1403 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001404
wdenk945af8d2003-07-16 21:53:01 +00001405 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001406 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001407
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001408 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001409 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001410 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001411 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001412
Peter Tyser8d321b82010-04-12 22:28:21 -05001413 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001414 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001415 and so its address should therefore be cleared to 0 (See,
1416 eg, MPC823e User's Manual p.16-473). So, set
1417 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001418
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001419 CONFIG_SYS_I2C_INIT_MPC5XXX
1420
1421 When a board is reset during an i2c bus transfer
1422 chips might think that the current transfer is still
1423 in progress. Reset the slave devices by sending start
1424 commands until the slave device responds.
1425
wdenk945af8d2003-07-16 21:53:01 +00001426 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001427
1428 If you use the software i2c interface (CONFIG_SOFT_I2C)
1429 then the following macros need to be defined (examples are
1430 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001431
1432 I2C_INIT
1433
wdenkb37c7e52003-06-30 16:24:52 +00001434 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001435 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001436
wdenkba56f622004-02-06 23:19:44 +00001437 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001438
wdenkc6097192002-11-03 00:24:07 +00001439 I2C_PORT
1440
wdenk43d96162003-03-06 00:02:04 +00001441 (Only for MPC8260 CPU). The I/O port to use (the code
1442 assumes both bits are on the same port). Valid values
1443 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001444
1445 I2C_ACTIVE
1446
1447 The code necessary to make the I2C data line active
1448 (driven). If the data line is open collector, this
1449 define can be null.
1450
wdenkb37c7e52003-06-30 16:24:52 +00001451 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1452
wdenkc6097192002-11-03 00:24:07 +00001453 I2C_TRISTATE
1454
1455 The code necessary to make the I2C data line tri-stated
1456 (inactive). If the data line is open collector, this
1457 define can be null.
1458
wdenkb37c7e52003-06-30 16:24:52 +00001459 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1460
wdenkc6097192002-11-03 00:24:07 +00001461 I2C_READ
1462
1463 Code that returns TRUE if the I2C data line is high,
1464 FALSE if it is low.
1465
wdenkb37c7e52003-06-30 16:24:52 +00001466 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1467
wdenkc6097192002-11-03 00:24:07 +00001468 I2C_SDA(bit)
1469
1470 If <bit> is TRUE, sets the I2C data line high. If it
1471 is FALSE, it clears it (low).
1472
wdenkb37c7e52003-06-30 16:24:52 +00001473 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001474 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001475 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001476
wdenkc6097192002-11-03 00:24:07 +00001477 I2C_SCL(bit)
1478
1479 If <bit> is TRUE, sets the I2C clock line high. If it
1480 is FALSE, it clears it (low).
1481
wdenkb37c7e52003-06-30 16:24:52 +00001482 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001483 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001484 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001485
wdenkc6097192002-11-03 00:24:07 +00001486 I2C_DELAY
1487
1488 This delay is invoked four times per clock cycle so this
1489 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001490 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001491 like:
1492
wdenkb37c7e52003-06-30 16:24:52 +00001493 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001494
Mike Frysinger793b5722010-07-21 13:38:02 -04001495 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1496
1497 If your arch supports the generic GPIO framework (asm/gpio.h),
1498 then you may alternatively define the two GPIOs that are to be
1499 used as SCL / SDA. Any of the previous I2C_xxx macros will
1500 have GPIO-based defaults assigned to them as appropriate.
1501
1502 You should define these to the GPIO value as given directly to
1503 the generic GPIO functions.
1504
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001505 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001506
wdenk8bde7f72003-06-27 21:31:46 +00001507 When a board is reset during an i2c bus transfer
1508 chips might think that the current transfer is still
1509 in progress. On some boards it is possible to access
1510 the i2c SCLK line directly, either by using the
1511 processor pin as a GPIO or by having a second pin
1512 connected to the bus. If this option is defined a
1513 custom i2c_init_board() routine in boards/xxx/board.c
1514 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001515
Richard Retanubun26a33502010-04-12 15:08:17 -04001516 CONFIG_SYS_I2C_BOARD_LATE_INIT
1517
1518 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1519 defined a custom i2c_board_late_init() routine in
1520 boards/xxx/board.c is run AFTER the operations in i2c_init()
1521 is completed. This callpoint can be used to unreset i2c bus
1522 using CPU i2c controller register accesses for CPUs whose i2c
1523 controller provide such a method. It is called at the end of
1524 i2c_init() to allow i2c_init operations to setup the i2c bus
1525 controller on the CPU (e.g. setting bus speed & slave address).
1526
wdenk17ea1172004-06-06 21:51:03 +00001527 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1528
1529 This option enables configuration of bi_iic_fast[] flags
1530 in u-boot bd_info structure based on u-boot environment
1531 variable "i2cfast". (see also i2cfast)
1532
Ben Warrenbb99ad62006-09-07 16:50:54 -04001533 CONFIG_I2C_MULTI_BUS
1534
1535 This option allows the use of multiple I2C buses, each of which
1536 must have a controller. At any point in time, only one bus is
1537 active. To switch to a different bus, use the 'i2c dev' command.
1538 Note that bus numbering is zero-based.
1539
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001540 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001541
1542 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001543 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1544 is set, specify a list of bus-device pairs. Otherwise, specify
1545 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001546
1547 e.g.
1548 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001549 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001550
1551 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1552
1553 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001554 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001555
1556 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001558 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001559
1560 If defined, then this indicates the I2C bus number for DDR SPD.
1561 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1562
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001563 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001564
1565 If defined, then this indicates the I2C bus number for the RTC.
1566 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1567
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001568 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001569
1570 If defined, then this indicates the I2C bus number for the DTT.
1571 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001573 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001574
1575 If defined, specifies the I2C address of the DTT device.
1576 If not defined, then U-Boot uses predefined value for
1577 specified DTT device.
1578
Timur Tabibe5e6182006-11-03 19:15:00 -06001579 CONFIG_FSL_I2C
1580
1581 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001582 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001583
Heiko Schocher67b23a32008-10-15 09:39:47 +02001584 CONFIG_I2C_MUX
1585
1586 Define this option if you have I2C devices reached over 1 .. n
1587 I2C Muxes like the pca9544a. This option addes a new I2C
1588 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1589 new I2C Bus to the existing I2C Busses. If you select the
1590 new Bus with "i2c dev", u-bbot sends first the commandos for
1591 the muxes to activate this new "bus".
1592
1593 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1594 feature!
1595
1596 Example:
1597 Adding a new I2C Bus reached over 2 pca9544a muxes
1598 The First mux with address 70 and channel 6
1599 The Second mux with address 71 and channel 4
1600
1601 => i2c bus pca9544a:70:6:pca9544a:71:4
1602
1603 Use the "i2c bus" command without parameter, to get a list
1604 of I2C Busses with muxes:
1605
1606 => i2c bus
1607 Busses reached over muxes:
1608 Bus ID: 2
1609 reached over Mux(es):
1610 pca9544a@70 ch: 4
1611 Bus ID: 3
1612 reached over Mux(es):
1613 pca9544a@70 ch: 6
1614 pca9544a@71 ch: 4
1615 =>
1616
1617 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1618 u-boot sends First the Commando to the mux@70 to enable
1619 channel 6, and then the Commando to the mux@71 to enable
1620 the channel 4.
1621
1622 After that, you can use the "normal" i2c commands as
1623 usual, to communicate with your I2C devices behind
1624 the 2 muxes.
1625
1626 This option is actually implemented for the bitbanging
1627 algorithm in common/soft_i2c.c and for the Hardware I2C
1628 Bus on the MPC8260. But it should be not so difficult
1629 to add this option to other architectures.
1630
Andrew Dyer2ac69852008-12-29 17:36:01 -06001631 CONFIG_SOFT_I2C_READ_REPEATED_START
1632
1633 defining this will force the i2c_read() function in
1634 the soft_i2c driver to perform an I2C repeated start
1635 between writing the address pointer and reading the
1636 data. If this define is omitted the default behaviour
1637 of doing a stop-start sequence will be used. Most I2C
1638 devices can use either method, but some require one or
1639 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001640
wdenkc6097192002-11-03 00:24:07 +00001641- SPI Support: CONFIG_SPI
1642
1643 Enables SPI driver (so far only tested with
1644 SPI EEPROM, also an instance works with Crystal A/D and
1645 D/As on the SACSng board)
1646
1647 CONFIG_SPI_X
1648
1649 Enables extended (16-bit) SPI EEPROM addressing.
1650 (symmetrical to CONFIG_I2C_X)
1651
1652 CONFIG_SOFT_SPI
1653
wdenk43d96162003-03-06 00:02:04 +00001654 Enables a software (bit-bang) SPI driver rather than
1655 using hardware support. This is a general purpose
1656 driver that only requires three general I/O port pins
1657 (two outputs, one input) to function. If this is
1658 defined, the board configuration must define several
1659 SPI configuration items (port pins to use, etc). For
1660 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001661
Ben Warren04a9e112008-01-16 22:37:35 -05001662 CONFIG_HARD_SPI
1663
1664 Enables a hardware SPI driver for general-purpose reads
1665 and writes. As with CONFIG_SOFT_SPI, the board configuration
1666 must define a list of chip-select function pointers.
1667 Currently supported on some MPC8xxx processors. For an
1668 example, see include/configs/mpc8349emds.h.
1669
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001670 CONFIG_MXC_SPI
1671
1672 Enables the driver for the SPI controllers on i.MX and MXC
1673 SoCs. Currently only i.MX31 is supported.
1674
Matthias Fuchs01335022007-12-27 17:12:34 +01001675- FPGA Support: CONFIG_FPGA
1676
1677 Enables FPGA subsystem.
1678
1679 CONFIG_FPGA_<vendor>
1680
1681 Enables support for specific chip vendors.
1682 (ALTERA, XILINX)
1683
1684 CONFIG_FPGA_<family>
1685
1686 Enables support for FPGA family.
1687 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1688
1689 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001690
wdenk43d96162003-03-06 00:02:04 +00001691 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001692
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001693 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001694
wdenk8bde7f72003-06-27 21:31:46 +00001695 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001696
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001697 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001698
wdenk43d96162003-03-06 00:02:04 +00001699 Enable checks on FPGA configuration interface busy
1700 status by the configuration function. This option
1701 will require a board or device specific function to
1702 be written.
wdenkc6097192002-11-03 00:24:07 +00001703
1704 CONFIG_FPGA_DELAY
1705
1706 If defined, a function that provides delays in the FPGA
1707 configuration driver.
1708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001709 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001710 Allow Control-C to interrupt FPGA configuration
1711
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001712 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001713
wdenk43d96162003-03-06 00:02:04 +00001714 Check for configuration errors during FPGA bitfile
1715 loading. For example, abort during Virtex II
1716 configuration if the INIT_B line goes low (which
1717 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001719 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001720
wdenk43d96162003-03-06 00:02:04 +00001721 Maximum time to wait for the INIT_B line to deassert
1722 after PROB_B has been deasserted during a Virtex II
1723 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001724 ms.
wdenkc6097192002-11-03 00:24:07 +00001725
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001726 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001727
wdenk43d96162003-03-06 00:02:04 +00001728 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001729 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001731 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001732
wdenk43d96162003-03-06 00:02:04 +00001733 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001734 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001735
1736- Configuration Management:
1737 CONFIG_IDENT_STRING
1738
wdenk43d96162003-03-06 00:02:04 +00001739 If defined, this string will be added to the U-Boot
1740 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001741
1742- Vendor Parameter Protection:
1743
wdenk43d96162003-03-06 00:02:04 +00001744 U-Boot considers the values of the environment
1745 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001746 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001747 are set once by the board vendor / manufacturer, and
1748 protects these variables from casual modification by
1749 the user. Once set, these variables are read-only,
1750 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001751 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001752
1753 If CONFIG_ENV_OVERWRITE is #defined in your config
1754 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001755 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001756 these parameters.
1757
1758 Alternatively, if you #define _both_ CONFIG_ETHADDR
1759 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001760 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001761 which can be changed exactly ONCE by the user. [The
1762 serial# is unaffected by this, i. e. it remains
1763 read-only.]
1764
1765- Protected RAM:
1766 CONFIG_PRAM
1767
1768 Define this variable to enable the reservation of
1769 "protected RAM", i. e. RAM which is not overwritten
1770 by U-Boot. Define CONFIG_PRAM to hold the number of
1771 kB you want to reserve for pRAM. You can overwrite
1772 this default value by defining an environment
1773 variable "pram" to the number of kB you want to
1774 reserve. Note that the board info structure will
1775 still show the full amount of RAM. If pRAM is
1776 reserved, a new environment variable "mem" will
1777 automatically be defined to hold the amount of
1778 remaining RAM in a form that can be passed as boot
1779 argument to Linux, for instance like that:
1780
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001781 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001782 saveenv
1783
1784 This way you can tell Linux not to use this memory,
1785 either, which results in a memory region that will
1786 not be affected by reboots.
1787
1788 *WARNING* If your board configuration uses automatic
1789 detection of the RAM size, you must make sure that
1790 this memory test is non-destructive. So far, the
1791 following board configurations are known to be
1792 "pRAM-clean":
1793
1794 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1795 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001796 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001797
1798- Error Recovery:
1799 CONFIG_PANIC_HANG
1800
1801 Define this variable to stop the system in case of a
1802 fatal error, so that you have to reset it manually.
1803 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001804 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001805 automatically as fast as possible, but it may be
1806 useful during development since you can try to debug
1807 the conditions that lead to the situation.
1808
1809 CONFIG_NET_RETRY_COUNT
1810
wdenk43d96162003-03-06 00:02:04 +00001811 This variable defines the number of retries for
1812 network operations like ARP, RARP, TFTP, or BOOTP
1813 before giving up the operation. If not defined, a
1814 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001815
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001816 CONFIG_ARP_TIMEOUT
1817
1818 Timeout waiting for an ARP reply in milliseconds.
1819
wdenkc6097192002-11-03 00:24:07 +00001820- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001821 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001822
1823 Enable auto completion of commands using TAB.
1824
Wolfgang Denka9398e02006-11-27 15:32:42 +01001825 Note that this feature has NOT been implemented yet
1826 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001827
1828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001829 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001830
1831 Define this variable to enable the "hush" shell (from
1832 Busybox) as command line interpreter, thus enabling
1833 powerful command line syntax like
1834 if...then...else...fi conditionals or `&&' and '||'
1835 constructs ("shell scripts").
1836
1837 If undefined, you get the old, much simpler behaviour
1838 with a somewhat smaller memory footprint.
1839
1840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001841 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001842
1843 This defines the secondary prompt string, which is
1844 printed when the command interpreter needs more input
1845 to complete a command. Usually "> ".
1846
1847 Note:
1848
wdenk8bde7f72003-06-27 21:31:46 +00001849 In the current implementation, the local variables
1850 space and global environment variables space are
1851 separated. Local variables are those you define by
1852 simply typing `name=value'. To access a local
1853 variable later on, you have write `$name' or
1854 `${name}'; to execute the contents of a variable
1855 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001856
wdenk43d96162003-03-06 00:02:04 +00001857 Global environment variables are those you use
1858 setenv/printenv to work with. To run a command stored
1859 in such a variable, you need to use the run command,
1860 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001861
1862 To store commands and special characters in a
1863 variable, please use double quotation marks
1864 surrounding the whole text of the variable, instead
1865 of the backslashes before semicolons and special
1866 symbols.
1867
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001868- Commandline Editing and History:
1869 CONFIG_CMDLINE_EDITING
1870
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001871 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001872 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001873
wdenka8c7c702003-12-06 19:49:23 +00001874- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001875 CONFIG_EXTRA_ENV_SETTINGS
1876
wdenk43d96162003-03-06 00:02:04 +00001877 Define this to contain any number of null terminated
1878 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001879 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001880
wdenk43d96162003-03-06 00:02:04 +00001881 For example, place something like this in your
1882 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001883
1884 #define CONFIG_EXTRA_ENV_SETTINGS \
1885 "myvar1=value1\0" \
1886 "myvar2=value2\0"
1887
wdenk43d96162003-03-06 00:02:04 +00001888 Warning: This method is based on knowledge about the
1889 internal format how the environment is stored by the
1890 U-Boot code. This is NOT an official, exported
1891 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001892 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001893 You better know what you are doing here.
1894
wdenk43d96162003-03-06 00:02:04 +00001895 Note: overly (ab)use of the default environment is
1896 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001897 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001898 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001899
wdenka8c7c702003-12-06 19:49:23 +00001900- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001901 CONFIG_HAS_DATAFLASH
1902
wdenk8bde7f72003-06-27 21:31:46 +00001903 Defining this option enables DataFlash features and
1904 allows to read/write in Dataflash via the standard
1905 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001906
wdenk3f85ce22004-02-23 16:11:30 +00001907- SystemACE Support:
1908 CONFIG_SYSTEMACE
1909
1910 Adding this option adds support for Xilinx SystemACE
1911 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001912 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001913 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001914
1915 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001916 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001917
1918 When SystemACE support is added, the "ace" device type
1919 becomes available to the fat commands, i.e. fatls.
1920
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001921- TFTP Fixed UDP Port:
1922 CONFIG_TFTP_PORT
1923
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001924 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001925 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001926 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001927 number generator is used.
1928
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001929 Also, the environment variable tftpdstp is used to supply
1930 the TFTP UDP destination port value. If tftpdstp isn't
1931 defined, the normal port 69 is used.
1932
1933 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001934 blindly start the TFTP transfer using the pre-configured
1935 target IP address and UDP port. This has the effect of
1936 "punching through" the (Windows XP) firewall, allowing
1937 the remainder of the TFTP transfer to proceed normally.
1938 A better solution is to properly configure the firewall,
1939 but sometimes that is not allowed.
1940
wdenka8c7c702003-12-06 19:49:23 +00001941- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001942 CONFIG_SHOW_BOOT_PROGRESS
1943
wdenk43d96162003-03-06 00:02:04 +00001944 Defining this option allows to add some board-
1945 specific code (calling a user-provided function
1946 "show_boot_progress(int)") that enables you to show
1947 the system's boot progress on some display (for
1948 example, some LED's) on your board. At the moment,
1949 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001950
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001951Legacy uImage format:
1952
wdenkc6097192002-11-03 00:24:07 +00001953 Arg Where When
1954 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001955 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001956 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001957 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001958 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001959 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001960 4 common/cmd_bootm.c Image data has correct checksum
1961 -4 common/cmd_bootm.c Image is for unsupported architecture
1962 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001963 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001964 6 common/cmd_bootm.c Image Type check OK
1965 -6 common/cmd_bootm.c gunzip uncompression error
1966 -7 common/cmd_bootm.c Unimplemented compression type
1967 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001968 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001969 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001970
1971 9 common/image.c Start initial ramdisk verification
1972 -10 common/image.c Ramdisk header has bad magic number
1973 -11 common/image.c Ramdisk header has bad checksum
1974 10 common/image.c Ramdisk header is OK
1975 -12 common/image.c Ramdisk data has bad checksum
1976 11 common/image.c Ramdisk data has correct checksum
1977 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001978 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001979 13 common/image.c Start multifile image verification
1980 14 common/image.c No initial ramdisk, no multifile, continue.
1981
Peter Tyserea0364f2010-04-12 22:28:04 -05001982 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001983
Stefan Roesea47a12b2010-04-15 16:07:28 +02001984 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00001985 -31 post/post.c POST test failed, detected by post_output_backlog()
1986 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001987
Heiko Schocher566a4942007-06-22 19:11:54 +02001988 34 common/cmd_doc.c before loading a Image from a DOC device
1989 -35 common/cmd_doc.c Bad usage of "doc" command
1990 35 common/cmd_doc.c correct usage of "doc" command
1991 -36 common/cmd_doc.c No boot device
1992 36 common/cmd_doc.c correct boot device
1993 -37 common/cmd_doc.c Unknown Chip ID on boot device
1994 37 common/cmd_doc.c correct chip ID found, device available
1995 -38 common/cmd_doc.c Read Error on boot device
1996 38 common/cmd_doc.c reading Image header from DOC device OK
1997 -39 common/cmd_doc.c Image header has bad magic number
1998 39 common/cmd_doc.c Image header has correct magic number
1999 -40 common/cmd_doc.c Error reading Image from DOC device
2000 40 common/cmd_doc.c Image header has correct magic number
2001 41 common/cmd_ide.c before loading a Image from a IDE device
2002 -42 common/cmd_ide.c Bad usage of "ide" command
2003 42 common/cmd_ide.c correct usage of "ide" command
2004 -43 common/cmd_ide.c No boot device
2005 43 common/cmd_ide.c boot device found
2006 -44 common/cmd_ide.c Device not available
2007 44 common/cmd_ide.c Device available
2008 -45 common/cmd_ide.c wrong partition selected
2009 45 common/cmd_ide.c partition selected
2010 -46 common/cmd_ide.c Unknown partition table
2011 46 common/cmd_ide.c valid partition table found
2012 -47 common/cmd_ide.c Invalid partition type
2013 47 common/cmd_ide.c correct partition type
2014 -48 common/cmd_ide.c Error reading Image Header on boot device
2015 48 common/cmd_ide.c reading Image Header from IDE device OK
2016 -49 common/cmd_ide.c Image header has bad magic number
2017 49 common/cmd_ide.c Image header has correct magic number
2018 -50 common/cmd_ide.c Image header has bad checksum
2019 50 common/cmd_ide.c Image header has correct checksum
2020 -51 common/cmd_ide.c Error reading Image from IDE device
2021 51 common/cmd_ide.c reading Image from IDE device OK
2022 52 common/cmd_nand.c before loading a Image from a NAND device
2023 -53 common/cmd_nand.c Bad usage of "nand" command
2024 53 common/cmd_nand.c correct usage of "nand" command
2025 -54 common/cmd_nand.c No boot device
2026 54 common/cmd_nand.c boot device found
2027 -55 common/cmd_nand.c Unknown Chip ID on boot device
2028 55 common/cmd_nand.c correct chip ID found, device available
2029 -56 common/cmd_nand.c Error reading Image Header on boot device
2030 56 common/cmd_nand.c reading Image Header from NAND device OK
2031 -57 common/cmd_nand.c Image header has bad magic number
2032 57 common/cmd_nand.c Image header has correct magic number
2033 -58 common/cmd_nand.c Error reading Image from NAND device
2034 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002035
Heiko Schocher566a4942007-06-22 19:11:54 +02002036 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002037
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002038 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002039 -64 net/eth.c no Ethernet found.
2040 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002041
Heiko Schocher566a4942007-06-22 19:11:54 +02002042 -80 common/cmd_net.c usage wrong
2043 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002044 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002045 81 common/cmd_net.c NetLoop() back without error
2046 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2047 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002048 83 common/cmd_net.c running "source" command
2049 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002050 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002051
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002052FIT uImage format:
2053
2054 Arg Where When
2055 100 common/cmd_bootm.c Kernel FIT Image has correct format
2056 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2057 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2058 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2059 102 common/cmd_bootm.c Kernel unit name specified
2060 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002061 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002062 104 common/cmd_bootm.c Got kernel subimage node offset
2063 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2064 105 common/cmd_bootm.c Kernel subimage hash verification OK
2065 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2066 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002067 -106 common/cmd_bootm.c Kernel subimage has wrong type
2068 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002069 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2070 108 common/cmd_bootm.c Got kernel subimage data/size
2071 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2072 -109 common/cmd_bootm.c Can't get kernel subimage type
2073 -110 common/cmd_bootm.c Can't get kernel subimage comp
2074 -111 common/cmd_bootm.c Can't get kernel subimage os
2075 -112 common/cmd_bootm.c Can't get kernel subimage load address
2076 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2077
2078 120 common/image.c Start initial ramdisk verification
2079 -120 common/image.c Ramdisk FIT image has incorrect format
2080 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002081 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002082 -122 common/image.c Can't get configuration for ramdisk subimage
2083 123 common/image.c Ramdisk unit name specified
2084 -124 common/image.c Can't get ramdisk subimage node offset
2085 125 common/image.c Got ramdisk subimage node offset
2086 -125 common/image.c Ramdisk subimage hash verification failed
2087 126 common/image.c Ramdisk subimage hash verification OK
2088 -126 common/image.c Ramdisk subimage for unsupported architecture
2089 127 common/image.c Architecture check OK
2090 -127 common/image.c Can't get ramdisk subimage data/size
2091 128 common/image.c Got ramdisk subimage data/size
2092 129 common/image.c Can't get ramdisk load address
2093 -129 common/image.c Got ramdisk load address
2094
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002095 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002096 131 common/cmd_doc.c FIT image format OK
2097
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002098 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002099 141 common/cmd_ide.c FIT image format OK
2100
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002101 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002102 151 common/cmd_nand.c FIT image format OK
2103
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002104- Automatic software updates via TFTP server
2105 CONFIG_UPDATE_TFTP
2106 CONFIG_UPDATE_TFTP_CNT_MAX
2107 CONFIG_UPDATE_TFTP_MSEC_MAX
2108
2109 These options enable and control the auto-update feature;
2110 for a more detailed description refer to doc/README.update.
2111
2112- MTD Support (mtdparts command, UBI support)
2113 CONFIG_MTD_DEVICE
2114
2115 Adds the MTD device infrastructure from the Linux kernel.
2116 Needed for mtdparts command support.
2117
2118 CONFIG_MTD_PARTITIONS
2119
2120 Adds the MTD partitioning infrastructure from the Linux
2121 kernel. Needed for UBI support.
2122
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002123
wdenkc6097192002-11-03 00:24:07 +00002124Modem Support:
2125--------------
2126
wdenk85ec0bc2003-03-31 16:34:49 +00002127[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002128
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002129- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002130 CONFIG_MODEM_SUPPORT
2131
2132- RTS/CTS Flow control enable:
2133 CONFIG_HWFLOW
2134
2135- Modem debug support:
2136 CONFIG_MODEM_SUPPORT_DEBUG
2137
wdenk43d96162003-03-06 00:02:04 +00002138 Enables debugging stuff (char screen[1024], dbg())
2139 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002140
wdenka8c7c702003-12-06 19:49:23 +00002141- Interrupt support (PPC):
2142
wdenkd4ca31c2004-01-02 14:00:00 +00002143 There are common interrupt_init() and timer_interrupt()
2144 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002145 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002146 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002147 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002148 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002149 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002150 specific handling. If board has watchdog / status_led
2151 / other_activity_monitor it works automatically from
2152 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002153
wdenkc6097192002-11-03 00:24:07 +00002154- General:
2155
wdenk43d96162003-03-06 00:02:04 +00002156 In the target system modem support is enabled when a
2157 specific key (key combination) is pressed during
2158 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002159 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002160 board_init(). Currently key_pressed() is a dummy
2161 function, returning 1 and thus enabling modem
2162 initialization.
wdenkc6097192002-11-03 00:24:07 +00002163
wdenk43d96162003-03-06 00:02:04 +00002164 If there are no modem init strings in the
2165 environment, U-Boot proceed to autoboot; the
2166 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002167 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002168
2169 See also: doc/README.Modem
2170
2171
wdenkc6097192002-11-03 00:24:07 +00002172Configuration Settings:
2173-----------------------
2174
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002175- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002176 undefine this when you're short of memory.
2177
Peter Tyser2fb26042009-01-27 18:03:12 -06002178- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2179 width of the commands listed in the 'help' command output.
2180
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002181- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002182 prompt for user input.
2183
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002184- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002185
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002186- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002187
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002188- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002189
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002190- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002191 the application (usually a Linux kernel) when it is
2192 booted
2193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002194- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002195 List of legal baudrate settings for this board.
2196
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002197- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002198 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002199
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002200- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002201 If the board specific function
2202 extern int overwrite_console (void);
2203 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002204 serial port, else the settings in the environment are used.
2205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002206- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002207 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002208
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002209- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002210 Enable overwrite of previous console environment settings.
2211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002212- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002213 Begin and End addresses of the area used by the
2214 simple memory test.
2215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002216- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002217 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002218
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002219- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002220 Scratch address used by the alternate memory test
2221 You only need to set this if address zero isn't writeable
2222
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002223- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2224 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002225 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002226 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002227 fixing up gd->ram_size the Linux kernel should gets passed
2228 the now "corrected" memory size and won't touch it either.
2229 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002230 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002231 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002232 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002233
2234 This option can be used as a workaround for the 440EPx/GRx
2235 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2236 be touched.
2237
2238 WARNING: Please make sure that this value is a multiple of
2239 the Linux page size (normally 4k). If this is not the case,
2240 then the end address of the Linux memory will be located at a
2241 non page size aligned address and this could cause major
2242 problems.
2243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002244- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002245 Default load address for network file downloads
2246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002247- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002248 Enable temporary baudrate change while serial download
2249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002250- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002251 Physical start address of SDRAM. _Must_ be 0 here.
2252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002253- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002254 Physical start address of Motherboard I/O (if using a
2255 Cogent motherboard)
2256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002257- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002258 Physical start address of Flash memory.
2259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002260- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002261 Physical start address of boot monitor code (set by
2262 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002263 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002264 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002266- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002267 Size of memory reserved for monitor code, used to
2268 determine _at_compile_time_ (!) if the environment is
2269 embedded within the U-Boot image, or in a separate
2270 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002272- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002273 Size of DRAM reserved for malloc() use.
2274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002275- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002276 Normally compressed uImages are limited to an
2277 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002278 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002279 to adjust this setting to your needs.
2280
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002281- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002282 Maximum size of memory mapped by the startup code of
2283 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002284 the Linux kernel (bd_info, boot arguments, FDT blob if
2285 used) must be put below this limit, unless "bootm_low"
2286 enviroment variable is defined and non-zero. In such case
2287 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002288 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002289
John Rigbyfca43cc2010-10-13 13:57:35 -06002290- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2291 Enable initrd_high functionality. If defined then the
2292 initrd_high feature is enabled and the bootm ramdisk subcommand
2293 is enabled.
2294
2295- CONFIG_SYS_BOOT_GET_CMDLINE:
2296 Enables allocating and saving kernel cmdline in space between
2297 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2298
2299- CONFIG_SYS_BOOT_GET_KBD:
2300 Enables allocating and saving a kernel copy of the bd_info in
2301 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2302
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002303- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002304 Max number of Flash memory banks
2305
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002306- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002307 Max number of sectors on a Flash chip
2308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002309- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002310 Timeout for Flash erase operations (in ms)
2311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002312- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002313 Timeout for Flash write operations (in ms)
2314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002315- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002316 Timeout for Flash set sector lock bit operation (in ms)
2317
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002318- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002319 Timeout for Flash clear lock bits operation (in ms)
2320
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002321- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002322 If defined, hardware flash sectors protection is used
2323 instead of U-Boot software protection.
2324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002325- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002326
2327 Enable TFTP transfers directly to flash memory;
2328 without this option such a download has to be
2329 performed in two steps: (1) download to RAM, and (2)
2330 copy from RAM to flash.
2331
2332 The two-step approach is usually more reliable, since
2333 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002334 the flash, but in some situations (when system RAM is
2335 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002336 downloaded image) this option may be very useful.
2337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002338- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002339 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002340 common flash structure for storing flash geometry.
2341
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002342- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002343 This option also enables the building of the cfi_flash driver
2344 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002345
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002346- CONFIG_FLASH_CFI_MTD
2347 This option enables the building of the cfi_mtd driver
2348 in the drivers directory. The driver exports CFI flash
2349 to the MTD layer.
2350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002351- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002352 Use buffered writes to flash.
2353
2354- CONFIG_FLASH_SPANSION_S29WS_N
2355 s29ws-n MirrorBit flash has non-standard addresses for buffered
2356 write commands.
2357
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002358- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002359 If this option is defined, the common CFI flash doesn't
2360 print it's warning upon not recognized FLASH banks. This
2361 is useful, if some of the configured banks are only
2362 optionally available.
2363
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002364- CONFIG_FLASH_SHOW_PROGRESS
2365 If defined (must be an integer), print out countdown
2366 digits and dots. Recommended value: 45 (9..1) for 80
2367 column displays, 15 (3..1) for 40 column displays.
2368
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002369- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002370 Defines the number of Ethernet receive buffers. On some
2371 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002372 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2373 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002374 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002375 Defaults to 4 if not defined.
2376
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002377- CONFIG_ENV_MAX_ENTRIES
2378
Wolfgang Denk071bc922010-10-27 22:48:30 +02002379 Maximum number of entries in the hash table that is used
2380 internally to store the environment settings. The default
2381 setting is supposed to be generous and should work in most
2382 cases. This setting can be used to tune behaviour; see
2383 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002384
wdenkc6097192002-11-03 00:24:07 +00002385The following definitions that deal with the placement and management
2386of environment data (variable area); in general, we support the
2387following configurations:
2388
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002389- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002390
2391 Define this if the environment is in flash memory.
2392
2393 a) The environment occupies one whole flash sector, which is
2394 "embedded" in the text segment with the U-Boot code. This
2395 happens usually with "bottom boot sector" or "top boot
2396 sector" type flash chips, which have several smaller
2397 sectors at the start or the end. For instance, such a
2398 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2399 such a case you would place the environment in one of the
2400 4 kB sectors - with U-Boot code before and after it. With
2401 "top boot sector" type flash chips, you would put the
2402 environment in one of the last sectors, leaving a gap
2403 between U-Boot and the environment.
2404
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002405 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002406
2407 Offset of environment data (variable area) to the
2408 beginning of flash memory; for instance, with bottom boot
2409 type flash chips the second sector can be used: the offset
2410 for this sector is given here.
2411
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002412 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002413
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002414 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002415
2416 This is just another way to specify the start address of
2417 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002418 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002419
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002420 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002421
2422 Size of the sector containing the environment.
2423
2424
2425 b) Sometimes flash chips have few, equal sized, BIG sectors.
2426 In such a case you don't want to spend a whole sector for
2427 the environment.
2428
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002429 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002430
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002431 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002432 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002433 of this flash sector for the environment. This saves
2434 memory for the RAM copy of the environment.
2435
2436 It may also save flash memory if you decide to use this
2437 when your environment is "embedded" within U-Boot code,
2438 since then the remainder of the flash sector could be used
2439 for U-Boot code. It should be pointed out that this is
2440 STRONGLY DISCOURAGED from a robustness point of view:
2441 updating the environment in flash makes it always
2442 necessary to erase the WHOLE sector. If something goes
2443 wrong before the contents has been restored from a copy in
2444 RAM, your target system will be dead.
2445
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002446 - CONFIG_ENV_ADDR_REDUND
2447 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002448
wdenk43d96162003-03-06 00:02:04 +00002449 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002450 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002451 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002452 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002453
2454BE CAREFUL! Any changes to the flash layout, and some changes to the
2455source code will make it necessary to adapt <board>/u-boot.lds*
2456accordingly!
2457
2458
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002459- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002460
2461 Define this if you have some non-volatile memory device
2462 (NVRAM, battery buffered SRAM) which you want to use for the
2463 environment.
2464
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002465 - CONFIG_ENV_ADDR:
2466 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002467
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002468 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002469 want to use for environment. It is assumed that this memory
2470 can just be read and written to, without any special
2471 provision.
2472
2473BE CAREFUL! The first access to the environment happens quite early
2474in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002475console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002476U-Boot will hang.
2477
2478Please note that even with NVRAM we still use a copy of the
2479environment in RAM: we could work on NVRAM directly, but we want to
2480keep settings there always unmodified except somebody uses "saveenv"
2481to save the current settings.
2482
2483
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002484- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002485
2486 Use this if you have an EEPROM or similar serial access
2487 device and a driver for it.
2488
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002489 - CONFIG_ENV_OFFSET:
2490 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002491
2492 These two #defines specify the offset and size of the
2493 environment area within the total memory of your EEPROM.
2494
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002495 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002496 If defined, specified the chip address of the EEPROM device.
2497 The default address is zero.
2498
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002499 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002500 If defined, the number of bits used to address bytes in a
2501 single page in the EEPROM device. A 64 byte page, for example
2502 would require six bits.
2503
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002504 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002505 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002506 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002507
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002508 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002509 The length in bytes of the EEPROM memory array address. Note
2510 that this is NOT the chip address length!
2511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002512 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002513 EEPROM chips that implement "address overflow" are ones
2514 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2515 address and the extra bits end up in the "chip address" bit
2516 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2517 byte chips.
2518
2519 Note that we consider the length of the address field to
2520 still be one byte because the extra address bits are hidden
2521 in the chip address.
2522
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002523 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002524 The size in bytes of the EEPROM device.
2525
Heiko Schocher548738b2010-01-07 08:55:40 +01002526 - CONFIG_ENV_EEPROM_IS_ON_I2C
2527 define this, if you have I2C and SPI activated, and your
2528 EEPROM, which holds the environment, is on the I2C bus.
2529
2530 - CONFIG_I2C_ENV_EEPROM_BUS
2531 if you have an Environment on an EEPROM reached over
2532 I2C muxes, you can define here, how to reach this
2533 EEPROM. For example:
2534
Wolfgang Denka9046b92010-06-13 17:48:15 +02002535 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002536
2537 EEPROM which holds the environment, is reached over
2538 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002539
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002540- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002541
wdenkd4ca31c2004-01-02 14:00:00 +00002542 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002543 want to use for the environment.
2544
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002545 - CONFIG_ENV_OFFSET:
2546 - CONFIG_ENV_ADDR:
2547 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002548
2549 These three #defines specify the offset and size of the
2550 environment area within the total memory of your DataFlash placed
2551 at the specified address.
2552
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002553- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002554
2555 Define this if you have a NAND device which you want to use
2556 for the environment.
2557
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002558 - CONFIG_ENV_OFFSET:
2559 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002560
2561 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002562 area within the first NAND device. CONFIG_ENV_OFFSET must be
2563 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002564
Scott Woodfdd813d2010-09-17 14:38:37 -05002565 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002566
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002567 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002568 size used to hold a redundant copy of the environment data, so
2569 that there is a valid backup copy in case there is a power failure
2570 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2571 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002572
Scott Woodfdd813d2010-09-17 14:38:37 -05002573 - CONFIG_ENV_RANGE (optional):
2574
2575 Specifies the length of the region in which the environment
2576 can be written. This should be a multiple of the NAND device's
2577 block size. Specifying a range with more erase blocks than
2578 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2579 the range to be avoided.
2580
2581 - CONFIG_ENV_OFFSET_OOB (optional):
2582
2583 Enables support for dynamically retrieving the offset of the
2584 environment from block zero's out-of-band data. The
2585 "nand env.oob" command can be used to record this offset.
2586 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2587 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002588
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002589- CONFIG_NAND_ENV_DST
2590
2591 Defines address in RAM to which the nand_spl code should copy the
2592 environment. If redundant environment is used, it will be copied to
2593 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2594
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002595- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002596
2597 Defines offset to the initial SPI buffer area in DPRAM. The
2598 area is used at an early stage (ROM part) if the environment
2599 is configured to reside in the SPI EEPROM: We need a 520 byte
2600 scratch DPRAM area. It is used between the two initialization
2601 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2602 to be a good choice since it makes it far enough from the
2603 start of the data area as well as from the stack pointer.
2604
Bruce Adlere881cb52007-11-02 13:15:42 -07002605Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002606has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002607created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002608until then to read environment variables.
2609
wdenk85ec0bc2003-03-31 16:34:49 +00002610The environment is protected by a CRC32 checksum. Before the monitor
2611is relocated into RAM, as a result of a bad CRC you will be working
2612with the compiled-in default environment - *silently*!!! [This is
2613necessary, because the first environment variable we need is the
2614"baudrate" setting for the console - if we have a bad CRC, we don't
2615have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002616
2617Note: once the monitor has been relocated, then it will complain if
2618the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002619use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002621- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002622 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002624 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002625 also needs to be defined.
2626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002627- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002628 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002629
Ron Madridf5675aa2009-02-18 14:30:44 -08002630- CONFIG_NS16550_MIN_FUNCTIONS:
2631 Define this if you desire to only have use of the NS16550_init
2632 and NS16550_putc functions for the serial driver located at
2633 drivers/serial/ns16550.c. This option is useful for saving
2634 space for already greatly restricted images, including but not
2635 limited to NAND_SPL configurations.
2636
wdenkc6097192002-11-03 00:24:07 +00002637Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002638---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002639
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002640- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002641 Cache Line Size of the CPU.
2642
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002643- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002644 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002645
wdenk42d1f032003-10-15 23:53:47 +00002646 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2647 and RPXsuper) to be able to adjust the position of
2648 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002649
wdenk7f6c2cb2002-11-10 22:06:23 +00002650- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002651 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002652
2653 the default drive number (default value 0)
2654
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002655 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002656
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002657 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002658 (default value 1)
2659
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002660 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002661
wdenk43d96162003-03-06 00:02:04 +00002662 defines the offset of register from address. It
2663 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002664 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002665
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002666 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2667 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002668 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002669
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002670 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002671 fdc_hw_init() is called at the beginning of the FDC
2672 setup. fdc_hw_init() must be provided by the board
2673 source code. It is used to make hardware dependant
2674 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002675
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002676- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002677 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002678 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002680- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002681
wdenk7152b1d2003-09-05 23:19:14 +00002682 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002683 initial data and stack; please note that this must be
2684 writable memory that is working WITHOUT special
2685 initialization, i. e. you CANNOT use normal RAM which
2686 will become available only after programming the
2687 memory controller and running certain initialization
2688 sequences.
2689
2690 U-Boot uses the following memory types:
2691 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2692 - MPC824X: data cache
2693 - PPC4xx: data cache
2694
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002695- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002696
2697 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002698 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2699 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002700 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002701 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002702 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2703 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2704 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002705
2706 Note:
2707 On the MPC824X (or other systems that use the data
2708 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002709 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002710 point to an otherwise UNUSED address space between
2711 the top of RAM and the start of the PCI space.
2712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002713- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002715- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002716
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002717- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002719- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002720
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002721- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002722
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002723- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002726 SDRAM timing
2727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002728- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002729 periodic timer for refresh
2730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002731- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2734 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2735 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2736 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002737 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2738
2739- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002740 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2741 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002742 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002744- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2745 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002746 Machine Mode Register and Memory Periodic Timer
2747 Prescaler definitions (SDRAM timing)
2748
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002749- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002750 enable I2C microcode relocation patch (MPC8xx);
2751 define relocation offset in DPRAM [DSP2]
2752
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002753- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002754 enable SMC microcode relocation patch (MPC8xx);
2755 define relocation offset in DPRAM [SMC1]
2756
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002757- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002758 enable SPI microcode relocation patch (MPC8xx);
2759 define relocation offset in DPRAM [SCC4]
2760
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002761- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002762 Use OSCM clock mode on MBX8xx board. Be careful,
2763 wrong setting might damage your board. Read
2764 doc/README.MBX before setting this variable!
2765
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002766- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002767 Offset of the bootmode word in DPRAM used by post
2768 (Power On Self Tests). This definition overrides
2769 #define'd default value in commproc.h resp.
2770 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002771
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002772- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2773 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2774 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2775 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2776 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2777 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2778 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2779 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002780 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002781
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002782- CONFIG_PCI_DISABLE_PCIE:
2783 Disable PCI-Express on systems where it is supported but not
2784 required.
2785
Kumar Galaa09b9b62010-12-30 12:09:53 -06002786- CONFIG_SYS_SRIO:
2787 Chip has SRIO or not
2788
2789- CONFIG_SRIO1:
2790 Board has SRIO 1 port available
2791
2792- CONFIG_SRIO2:
2793 Board has SRIO 2 port available
2794
2795- CONFIG_SYS_SRIOn_MEM_VIRT:
2796 Virtual Address of SRIO port 'n' memory region
2797
2798- CONFIG_SYS_SRIOn_MEM_PHYS:
2799 Physical Address of SRIO port 'n' memory region
2800
2801- CONFIG_SYS_SRIOn_MEM_SIZE:
2802 Size of SRIO port 'n' memory region
2803
Ben Warrenbb99ad62006-09-07 16:50:54 -04002804- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002805 Get DDR timing information from an I2C EEPROM. Common
2806 with pluggable memory modules such as SODIMMs
2807
Ben Warrenbb99ad62006-09-07 16:50:54 -04002808 SPD_EEPROM_ADDRESS
2809 I2C address of the SPD EEPROM
2810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002811- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002812 If SPD EEPROM is on an I2C bus other than the first
2813 one, specify here. Note that the value must resolve
2814 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002816- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002817 Only for 83xx systems. If specified, then DDR should
2818 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002819
wdenkc26e4542004-04-18 10:13:26 +00002820- CONFIG_ETHER_ON_FEC[12]
2821 Define to enable FEC[12] on a 8xx series processor.
2822
2823- CONFIG_FEC[12]_PHY
2824 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002825 to the given FEC; i. e.
2826 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002827 means that the PHY with address 4 is connected to FEC1
2828
2829 When set to -1, means to probe for first available.
2830
2831- CONFIG_FEC[12]_PHY_NORXERR
2832 The PHY does not have a RXERR line (RMII only).
2833 (so program the FEC to ignore it).
2834
2835- CONFIG_RMII
2836 Enable RMII mode for all FECs.
2837 Note that this is a global option, we can't
2838 have one FEC in standard MII mode and another in RMII mode.
2839
wdenk5cf91d62004-04-23 20:32:05 +00002840- CONFIG_CRC32_VERIFY
2841 Add a verify option to the crc32 command.
2842 The syntax is:
2843
2844 => crc32 -v <address> <count> <crc32>
2845
2846 Where address/count indicate a memory area
2847 and crc32 is the correct crc32 which the
2848 area should have.
2849
wdenk56523f12004-07-11 17:40:54 +00002850- CONFIG_LOOPW
2851 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002852 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002853
stroese7b466642004-12-16 18:46:55 +00002854- CONFIG_MX_CYCLIC
2855 Add the "mdc" and "mwc" memory commands. These are cyclic
2856 "md/mw" commands.
2857 Examples:
2858
wdenkefe2a4d2004-12-16 21:44:03 +00002859 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002860 This command will print 4 bytes (10,11,12,13) each 500 ms.
2861
wdenkefe2a4d2004-12-16 21:44:03 +00002862 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002863 This command will write 12345678 to address 100 all 10 ms.
2864
wdenkefe2a4d2004-12-16 21:44:03 +00002865 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002866 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002867
wdenk8aa1a2d2005-04-04 12:44:11 +00002868- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002869 [ARM only] If this variable is defined, then certain
2870 low level initializations (like setting up the memory
2871 controller) are omitted and/or U-Boot does not
2872 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002873
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002874 Normally this variable MUST NOT be defined. The only
2875 exception is when U-Boot is loaded (to RAM) by some
2876 other boot loader or by a debugger which performs
2877 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002878
Magnus Liljadf812382009-06-13 20:50:00 +02002879- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02002880 Modifies the behaviour of start.S when compiling a loader
2881 that is executed before the actual U-Boot. E.g. when
2882 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002883
wdenkc6097192002-11-03 00:24:07 +00002884Building the Software:
2885======================
2886
Wolfgang Denk218ca722008-03-26 10:40:12 +01002887Building U-Boot has been tested in several native build environments
2888and in many different cross environments. Of course we cannot support
2889all possibly existing versions of cross development tools in all
2890(potentially obsolete) versions. In case of tool chain problems we
2891recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2892which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002893
Wolfgang Denk218ca722008-03-26 10:40:12 +01002894If you are not using a native environment, it is assumed that you
2895have GNU cross compiling tools available in your path. In this case,
2896you must set the environment variable CROSS_COMPILE in your shell.
2897Note that no changes to the Makefile or any other source files are
2898necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002899
Wolfgang Denk218ca722008-03-26 10:40:12 +01002900 $ CROSS_COMPILE=ppc_4xx-
2901 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002902
Peter Tyser2f8d3962009-03-13 18:54:51 -05002903Note: If you wish to generate Windows versions of the utilities in
2904 the tools directory you can use the MinGW toolchain
2905 (http://www.mingw.org). Set your HOST tools to the MinGW
2906 toolchain and execute 'make tools'. For example:
2907
2908 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2909
2910 Binaries such as tools/mkimage.exe will be created which can
2911 be executed on computers running Windows.
2912
Wolfgang Denk218ca722008-03-26 10:40:12 +01002913U-Boot is intended to be simple to build. After installing the
2914sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002915is done by typing:
2916
2917 make NAME_config
2918
Wolfgang Denk218ca722008-03-26 10:40:12 +01002919where "NAME_config" is the name of one of the existing configu-
2920rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002921
wdenk2729af92004-05-03 20:45:30 +00002922Note: for some board special configuration names may exist; check if
2923 additional information is available from the board vendor; for
2924 instance, the TQM823L systems are available without (standard)
2925 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002926 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002927
wdenk2729af92004-05-03 20:45:30 +00002928 make TQM823L_config
2929 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002930
wdenk2729af92004-05-03 20:45:30 +00002931 make TQM823L_LCD_config
2932 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002933
wdenk2729af92004-05-03 20:45:30 +00002934 etc.
wdenkc6097192002-11-03 00:24:07 +00002935
wdenkc6097192002-11-03 00:24:07 +00002936
wdenk2729af92004-05-03 20:45:30 +00002937Finally, type "make all", and you should get some working U-Boot
2938images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002939
wdenk2729af92004-05-03 20:45:30 +00002940- "u-boot.bin" is a raw binary image
2941- "u-boot" is an image in ELF binary format
2942- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002943
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002944By default the build is performed locally and the objects are saved
2945in the source directory. One of the two methods can be used to change
2946this behavior and build U-Boot to some external directory:
2947
29481. Add O= to the make command line invocations:
2949
2950 make O=/tmp/build distclean
2951 make O=/tmp/build NAME_config
2952 make O=/tmp/build all
2953
29542. Set environment variable BUILD_DIR to point to the desired location:
2955
2956 export BUILD_DIR=/tmp/build
2957 make distclean
2958 make NAME_config
2959 make all
2960
2961Note that the command line "O=" setting overrides the BUILD_DIR environment
2962variable.
2963
wdenkc6097192002-11-03 00:24:07 +00002964
wdenk2729af92004-05-03 20:45:30 +00002965Please be aware that the Makefiles assume you are using GNU make, so
2966for instance on NetBSD you might need to use "gmake" instead of
2967native "make".
wdenkc6097192002-11-03 00:24:07 +00002968
wdenkc6097192002-11-03 00:24:07 +00002969
wdenk2729af92004-05-03 20:45:30 +00002970If the system board that you have is not listed, then you will need
2971to port U-Boot to your hardware platform. To do this, follow these
2972steps:
wdenkc6097192002-11-03 00:24:07 +00002973
wdenk2729af92004-05-03 20:45:30 +000029741. Add a new configuration option for your board to the toplevel
2975 "Makefile" and to the "MAKEALL" script, using the existing
2976 entries as examples. Note that here and at many other places
2977 boards and other names are listed in alphabetical sort order. Please
2978 keep this order.
29792. Create a new directory to hold your board specific code. Add any
2980 files you need. In your board directory, you will need at least
2981 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
29823. Create a new configuration file "include/configs/<board>.h" for
2983 your board
29843. If you're porting U-Boot to a new CPU, then also create a new
2985 directory to hold your CPU specific code. Add any files you need.
29864. Run "make <board>_config" with your new name.
29875. Type "make", and you should get a working "u-boot.srec" file
2988 to be installed on your target system.
29896. Debug and solve any problems that might arise.
2990 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002991
wdenkc6097192002-11-03 00:24:07 +00002992
wdenk2729af92004-05-03 20:45:30 +00002993Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2994==============================================================
wdenkc6097192002-11-03 00:24:07 +00002995
Wolfgang Denk218ca722008-03-26 10:40:12 +01002996If you have modified U-Boot sources (for instance added a new board
2997or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002998provide feedback to the other developers. The feedback normally takes
2999the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003000official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003001
Wolfgang Denk218ca722008-03-26 10:40:12 +01003002But before you submit such a patch, please verify that your modifi-
3003cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003004the supported boards compile WITHOUT ANY compiler warnings. To do so,
3005just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003006for ALL supported system. Be warned, this will take a while. You can
3007select which (cross) compiler to use by passing a `CROSS_COMPILE'
3008environment variable to the script, i. e. to use the ELDK cross tools
3009you can type
wdenkc6097192002-11-03 00:24:07 +00003010
wdenk2729af92004-05-03 20:45:30 +00003011 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003012
wdenk2729af92004-05-03 20:45:30 +00003013or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003014
wdenk2729af92004-05-03 20:45:30 +00003015 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003016
Wolfgang Denk218ca722008-03-26 10:40:12 +01003017When using the MAKEALL script, the default behaviour is to build
3018U-Boot in the source directory. This location can be changed by
3019setting the BUILD_DIR environment variable. Also, for each target
3020built, the MAKEALL script saves two log files (<target>.ERR and
3021<target>.MAKEALL) in the <source dir>/LOG directory. This default
3022location can be changed by setting the MAKEALL_LOGDIR environment
3023variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003024
3025 export BUILD_DIR=/tmp/build
3026 export MAKEALL_LOGDIR=/tmp/log
3027 CROSS_COMPILE=ppc_8xx- MAKEALL
3028
Wolfgang Denk218ca722008-03-26 10:40:12 +01003029With the above settings build objects are saved in the /tmp/build,
3030log files are saved in the /tmp/log and the source tree remains clean
3031during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003032
3033
wdenk2729af92004-05-03 20:45:30 +00003034See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003035
wdenkc6097192002-11-03 00:24:07 +00003036
wdenk2729af92004-05-03 20:45:30 +00003037Monitor Commands - Overview:
3038============================
wdenkc6097192002-11-03 00:24:07 +00003039
wdenk2729af92004-05-03 20:45:30 +00003040go - start application at address 'addr'
3041run - run commands in an environment variable
3042bootm - boot application image from memory
3043bootp - boot image via network using BootP/TFTP protocol
3044tftpboot- boot image via network using TFTP protocol
3045 and env variables "ipaddr" and "serverip"
3046 (and eventually "gatewayip")
3047rarpboot- boot image via network using RARP/TFTP protocol
3048diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3049loads - load S-Record file over serial line
3050loadb - load binary file over serial line (kermit mode)
3051md - memory display
3052mm - memory modify (auto-incrementing)
3053nm - memory modify (constant address)
3054mw - memory write (fill)
3055cp - memory copy
3056cmp - memory compare
3057crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003058i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003059sspi - SPI utility commands
3060base - print or set address offset
3061printenv- print environment variables
3062setenv - set environment variables
3063saveenv - save environment variables to persistent storage
3064protect - enable or disable FLASH write protection
3065erase - erase FLASH memory
3066flinfo - print FLASH memory information
3067bdinfo - print Board Info structure
3068iminfo - print header information for application image
3069coninfo - print console devices and informations
3070ide - IDE sub-system
3071loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003072loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003073mtest - simple RAM test
3074icache - enable or disable instruction cache
3075dcache - enable or disable data cache
3076reset - Perform RESET of the CPU
3077echo - echo args to console
3078version - print monitor version
3079help - print online help
3080? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003081
wdenkc6097192002-11-03 00:24:07 +00003082
wdenk2729af92004-05-03 20:45:30 +00003083Monitor Commands - Detailed Description:
3084========================================
wdenkc6097192002-11-03 00:24:07 +00003085
wdenk2729af92004-05-03 20:45:30 +00003086TODO.
wdenkc6097192002-11-03 00:24:07 +00003087
wdenk2729af92004-05-03 20:45:30 +00003088For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003089
3090
wdenk2729af92004-05-03 20:45:30 +00003091Environment Variables:
3092======================
wdenkc6097192002-11-03 00:24:07 +00003093
wdenk2729af92004-05-03 20:45:30 +00003094U-Boot supports user configuration using Environment Variables which
3095can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003096
wdenk2729af92004-05-03 20:45:30 +00003097Environment Variables are set using "setenv", printed using
3098"printenv", and saved to Flash using "saveenv". Using "setenv"
3099without a value can be used to delete a variable from the
3100environment. As long as you don't save the environment you are
3101working with an in-memory copy. In case the Flash area containing the
3102environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003103
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003104Some configuration options can be set using Environment Variables.
3105
3106List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003107
wdenk2729af92004-05-03 20:45:30 +00003108 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003109
wdenk2729af92004-05-03 20:45:30 +00003110 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003111
wdenk2729af92004-05-03 20:45:30 +00003112 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003113
wdenk2729af92004-05-03 20:45:30 +00003114 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003115
wdenk2729af92004-05-03 20:45:30 +00003116 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003117
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003118 bootm_low - Memory range available for image processing in the bootm
3119 command can be restricted. This variable is given as
3120 a hexadecimal number and defines lowest address allowed
3121 for use by the bootm command. See also "bootm_size"
3122 environment variable. Address defined by "bootm_low" is
3123 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003124 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003125
3126 bootm_size - Memory range available for image processing in the bootm
3127 command can be restricted. This variable is given as
3128 a hexadecimal number and defines the size of the region
3129 allowed for use by the bootm command. See also "bootm_low"
3130 environment variable.
3131
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003132 updatefile - Location of the software update file on a TFTP server, used
3133 by the automatic software update feature. Please refer to
3134 documentation in doc/README.update for more details.
3135
wdenk2729af92004-05-03 20:45:30 +00003136 autoload - if set to "no" (any string beginning with 'n'),
3137 "bootp" will just load perform a lookup of the
3138 configuration from the BOOTP server, but not try to
3139 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003140
wdenk2729af92004-05-03 20:45:30 +00003141 autostart - if set to "yes", an image loaded using the "bootp",
3142 "rarpboot", "tftpboot" or "diskboot" commands will
3143 be automatically started (by internally calling
3144 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003145
wdenk2729af92004-05-03 20:45:30 +00003146 If set to "no", a standalone image passed to the
3147 "bootm" command will be copied to the load address
3148 (and eventually uncompressed), but NOT be started.
3149 This can be used to load and uncompress arbitrary
3150 data.
wdenkc6097192002-11-03 00:24:07 +00003151
wdenk17ea1172004-06-06 21:51:03 +00003152 i2cfast - (PPC405GP|PPC405EP only)
3153 if set to 'y' configures Linux I2C driver for fast
3154 mode (400kHZ). This environment variable is used in
3155 initialization code. So, for changes to be effective
3156 it must be saved and board must be reset.
3157
wdenk2729af92004-05-03 20:45:30 +00003158 initrd_high - restrict positioning of initrd images:
3159 If this variable is not set, initrd images will be
3160 copied to the highest possible address in RAM; this
3161 is usually what you want since it allows for
3162 maximum initrd size. If for some reason you want to
3163 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003164 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003165 variable to a value of "no" or "off" or "0".
3166 Alternatively, you can set it to a maximum upper
3167 address to use (U-Boot will still check that it
3168 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003169
wdenk2729af92004-05-03 20:45:30 +00003170 For instance, when you have a system with 16 MB
3171 RAM, and want to reserve 4 MB from use by Linux,
3172 you can do this by adding "mem=12M" to the value of
3173 the "bootargs" variable. However, now you must make
3174 sure that the initrd image is placed in the first
3175 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003176
wdenk2729af92004-05-03 20:45:30 +00003177 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003178
wdenk2729af92004-05-03 20:45:30 +00003179 If you set initrd_high to 0xFFFFFFFF, this is an
3180 indication to U-Boot that all addresses are legal
3181 for the Linux kernel, including addresses in flash
3182 memory. In this case U-Boot will NOT COPY the
3183 ramdisk at all. This may be useful to reduce the
3184 boot time on your system, but requires that this
3185 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003186
wdenk2729af92004-05-03 20:45:30 +00003187 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003188
wdenk2729af92004-05-03 20:45:30 +00003189 loadaddr - Default load address for commands like "bootp",
3190 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003191
wdenk2729af92004-05-03 20:45:30 +00003192 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003193
wdenk2729af92004-05-03 20:45:30 +00003194 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003195
wdenk2729af92004-05-03 20:45:30 +00003196 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003197
wdenk2729af92004-05-03 20:45:30 +00003198 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk2729af92004-05-03 20:45:30 +00003200 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003201
wdenk2729af92004-05-03 20:45:30 +00003202 ethprime - When CONFIG_NET_MULTI is enabled controls which
3203 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003204
wdenk2729af92004-05-03 20:45:30 +00003205 ethact - When CONFIG_NET_MULTI is enabled controls which
3206 interface is currently active. For example you
3207 can do the following
wdenkc6097192002-11-03 00:24:07 +00003208
Heiko Schocher48690d82010-07-20 17:45:02 +02003209 => setenv ethact FEC
3210 => ping 192.168.0.1 # traffic sent on FEC
3211 => setenv ethact SCC
3212 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003213
Matthias Fuchse1692572008-01-17 07:45:05 +01003214 ethrotate - When set to "no" U-Boot does not go through all
3215 available network interfaces.
3216 It just stays at the currently selected interface.
3217
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003218 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003219 either succeed or fail without retrying.
3220 When set to "once" the network operation will
3221 fail when all the available network interfaces
3222 are tried once without success.
3223 Useful on scripts which control the retry operation
3224 themselves.
wdenkc6097192002-11-03 00:24:07 +00003225
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003226 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003227
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003228 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003229 UDP source port.
3230
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003231 tftpdstport - If this is set, the value is used for TFTP's UDP
3232 destination port instead of the Well Know Port 69.
3233
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003234 tftpblocksize - Block size to use for TFTP transfers; if not set,
3235 we use the TFTP server's default block size
3236
3237 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3238 seconds, minimum value is 1000 = 1 second). Defines
3239 when a packet is considered to be lost so it has to
3240 be retransmitted. The default is 5000 = 5 seconds.
3241 Lowering this value may make downloads succeed
3242 faster in networks with high packet loss rates or
3243 with unreliable TFTP servers.
3244
3245 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003246 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003247 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003248
wdenk2729af92004-05-03 20:45:30 +00003249The following environment variables may be used and automatically
3250updated by the network boot commands ("bootp" and "rarpboot"),
3251depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003252
wdenk2729af92004-05-03 20:45:30 +00003253 bootfile - see above
3254 dnsip - IP address of your Domain Name Server
3255 dnsip2 - IP address of your secondary Domain Name Server
3256 gatewayip - IP address of the Gateway (Router) to use
3257 hostname - Target hostname
3258 ipaddr - see above
3259 netmask - Subnet Mask
3260 rootpath - Pathname of the root filesystem on the NFS server
3261 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003262
wdenka3d991b2004-04-15 21:48:45 +00003263
wdenk2729af92004-05-03 20:45:30 +00003264There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003265
wdenk2729af92004-05-03 20:45:30 +00003266 serial# - contains hardware identification information such
3267 as type string and/or serial number
3268 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003269
wdenk2729af92004-05-03 20:45:30 +00003270These variables can be set only once (usually during manufacturing of
3271the board). U-Boot refuses to delete or overwrite these variables
3272once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003273
3274
wdenk2729af92004-05-03 20:45:30 +00003275Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003276
wdenk2729af92004-05-03 20:45:30 +00003277 ver - Contains the U-Boot version string as printed
3278 with the "version" command. This variable is
3279 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003280
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk2729af92004-05-03 20:45:30 +00003282Please note that changes to some configuration parameters may take
3283only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003284
stroesec1551ea2003-04-04 15:53:41 +00003285
wdenk2729af92004-05-03 20:45:30 +00003286Command Line Parsing:
3287=====================
stroesec1551ea2003-04-04 15:53:41 +00003288
wdenk2729af92004-05-03 20:45:30 +00003289There are two different command line parsers available with U-Boot:
3290the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003291
wdenk2729af92004-05-03 20:45:30 +00003292Old, simple command line parser:
3293--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003294
wdenk2729af92004-05-03 20:45:30 +00003295- supports environment variables (through setenv / saveenv commands)
3296- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003297- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003298- special characters ('$', ';') can be escaped by prefixing with '\',
3299 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003300 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003301- You can also escape text by enclosing in single apostrophes, for example:
3302 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003303
wdenk2729af92004-05-03 20:45:30 +00003304Hush shell:
3305-----------
wdenkf07771c2003-05-28 08:06:31 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307- similar to Bourne shell, with control structures like
3308 if...then...else...fi, for...do...done; while...do...done,
3309 until...do...done, ...
3310- supports environment ("global") variables (through setenv / saveenv
3311 commands) and local shell variables (through standard shell syntax
3312 "name=value"); only environment variables can be used with "run"
3313 command
wdenkf07771c2003-05-28 08:06:31 +00003314
wdenk2729af92004-05-03 20:45:30 +00003315General rules:
3316--------------
wdenkf07771c2003-05-28 08:06:31 +00003317
wdenk2729af92004-05-03 20:45:30 +00003318(1) If a command line (or an environment variable executed by a "run"
3319 command) contains several commands separated by semicolon, and
3320 one of these commands fails, then the remaining commands will be
3321 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003322
wdenk2729af92004-05-03 20:45:30 +00003323(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003324 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003325 command will cause "run" to terminate, i. e. the remaining
3326 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003327
wdenk2729af92004-05-03 20:45:30 +00003328Note for Redundant Ethernet Interfaces:
3329=======================================
wdenkf07771c2003-05-28 08:06:31 +00003330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003331Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003332such configurations and is capable of automatic selection of a
3333"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003334
wdenk2729af92004-05-03 20:45:30 +00003335Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3336MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3337"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003338
wdenk2729af92004-05-03 20:45:30 +00003339If the network interface stores some valid MAC address (for instance
3340in SROM), this is used as default address if there is NO correspon-
3341ding setting in the environment; if the corresponding environment
3342variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003343
wdenk2729af92004-05-03 20:45:30 +00003344o If the SROM has a valid MAC address, and there is no address in the
3345 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003346
wdenk2729af92004-05-03 20:45:30 +00003347o If there is no valid address in the SROM, and a definition in the
3348 environment exists, then the value from the environment variable is
3349 used.
wdenkc6097192002-11-03 00:24:07 +00003350
wdenk2729af92004-05-03 20:45:30 +00003351o If both the SROM and the environment contain a MAC address, and
3352 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003353
wdenk2729af92004-05-03 20:45:30 +00003354o If both the SROM and the environment contain a MAC address, and the
3355 addresses differ, the value from the environment is used and a
3356 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003357
wdenk2729af92004-05-03 20:45:30 +00003358o If neither SROM nor the environment contain a MAC address, an error
3359 is raised.
wdenkc6097192002-11-03 00:24:07 +00003360
Ben Warrenecee9322010-04-26 11:11:46 -07003361If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3362will be programmed into hardware as part of the initialization process. This
3363may be skipped by setting the appropriate 'ethmacskip' environment variable.
3364The naming convention is as follows:
3365"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003366
wdenk2729af92004-05-03 20:45:30 +00003367Image Formats:
3368==============
wdenkc6097192002-11-03 00:24:07 +00003369
Marian Balakowicz3310c542008-03-12 12:13:13 +01003370U-Boot is capable of booting (and performing other auxiliary operations on)
3371images in two formats:
3372
3373New uImage format (FIT)
3374-----------------------
3375
3376Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3377to Flattened Device Tree). It allows the use of images with multiple
3378components (several kernels, ramdisks, etc.), with contents protected by
3379SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3380
3381
3382Old uImage format
3383-----------------
3384
3385Old image format is based on binary files which can be basically anything,
3386preceded by a special header; see the definitions in include/image.h for
3387details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003388
wdenk2729af92004-05-03 20:45:30 +00003389* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3390 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003391 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3392 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3393 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003394* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003395 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3396 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003397* Compression Type (uncompressed, gzip, bzip2)
3398* Load Address
3399* Entry Point
3400* Image Name
3401* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403The header is marked by a special Magic Number, and both the header
3404and the data portions of the image are secured against corruption by
3405CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003406
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk2729af92004-05-03 20:45:30 +00003408Linux Support:
3409==============
wdenkc6097192002-11-03 00:24:07 +00003410
wdenk2729af92004-05-03 20:45:30 +00003411Although U-Boot should support any OS or standalone application
3412easily, the main focus has always been on Linux during the design of
3413U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003414
wdenk2729af92004-05-03 20:45:30 +00003415U-Boot includes many features that so far have been part of some
3416special "boot loader" code within the Linux kernel. Also, any
3417"initrd" images to be used are no longer part of one big Linux image;
3418instead, kernel and "initrd" are separate images. This implementation
3419serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003420
wdenk2729af92004-05-03 20:45:30 +00003421- the same features can be used for other OS or standalone
3422 applications (for instance: using compressed images to reduce the
3423 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003424
wdenk2729af92004-05-03 20:45:30 +00003425- it becomes much easier to port new Linux kernel versions because
3426 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003427
wdenk2729af92004-05-03 20:45:30 +00003428- the same Linux kernel image can now be used with different "initrd"
3429 images; of course this also means that different kernel images can
3430 be run with the same "initrd". This makes testing easier (you don't
3431 have to build a new "zImage.initrd" Linux image when you just
3432 change a file in your "initrd"). Also, a field-upgrade of the
3433 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003434
wdenkc6097192002-11-03 00:24:07 +00003435
wdenk2729af92004-05-03 20:45:30 +00003436Linux HOWTO:
3437============
wdenkc6097192002-11-03 00:24:07 +00003438
wdenk2729af92004-05-03 20:45:30 +00003439Porting Linux to U-Boot based systems:
3440---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003441
wdenk2729af92004-05-03 20:45:30 +00003442U-Boot cannot save you from doing all the necessary modifications to
3443configure the Linux device drivers for use with your target hardware
3444(no, we don't intend to provide a full virtual machine interface to
3445Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003446
Stefan Roesea47a12b2010-04-15 16:07:28 +02003447But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003448
wdenk2729af92004-05-03 20:45:30 +00003449Just make sure your machine specific header file (for instance
3450include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003451Information structure as we define in include/asm-<arch>/u-boot.h,
3452and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003453as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003454
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk2729af92004-05-03 20:45:30 +00003456Configuring the Linux kernel:
3457-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003458
wdenk2729af92004-05-03 20:45:30 +00003459No specific requirements for U-Boot. Make sure you have some root
3460device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003461
wdenkc6097192002-11-03 00:24:07 +00003462
wdenk2729af92004-05-03 20:45:30 +00003463Building a Linux Image:
3464-----------------------
wdenkc6097192002-11-03 00:24:07 +00003465
wdenk2729af92004-05-03 20:45:30 +00003466With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3467not used. If you use recent kernel source, a new build target
3468"uImage" will exist which automatically builds an image usable by
3469U-Boot. Most older kernels also have support for a "pImage" target,
3470which was introduced for our predecessor project PPCBoot and uses a
3471100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003472
wdenk2729af92004-05-03 20:45:30 +00003473Example:
wdenkc6097192002-11-03 00:24:07 +00003474
wdenk2729af92004-05-03 20:45:30 +00003475 make TQM850L_config
3476 make oldconfig
3477 make dep
3478 make uImage
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk2729af92004-05-03 20:45:30 +00003480The "uImage" build target uses a special tool (in 'tools/mkimage') to
3481encapsulate a compressed Linux kernel image with header information,
3482CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003485
wdenk2729af92004-05-03 20:45:30 +00003486* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003487
wdenk2729af92004-05-03 20:45:30 +00003488 ${CROSS_COMPILE}-objcopy -O binary \
3489 -R .note -R .comment \
3490 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003491
wdenk2729af92004-05-03 20:45:30 +00003492* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003493
wdenk2729af92004-05-03 20:45:30 +00003494 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003495
wdenk2729af92004-05-03 20:45:30 +00003496* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003497
wdenk2729af92004-05-03 20:45:30 +00003498 mkimage -A ppc -O linux -T kernel -C gzip \
3499 -a 0 -e 0 -n "Linux Kernel Image" \
3500 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003501
wdenk24ee89b2002-11-03 17:56:27 +00003502
wdenk2729af92004-05-03 20:45:30 +00003503The "mkimage" tool can also be used to create ramdisk images for use
3504with U-Boot, either separated from the Linux kernel image, or
3505combined into one file. "mkimage" encapsulates the images with a 64
3506byte header containing information about target architecture,
3507operating system, image type, compression method, entry points, time
3508stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510"mkimage" can be called in two ways: to verify existing images and
3511print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003512
wdenk2729af92004-05-03 20:45:30 +00003513In the first form (with "-l" option) mkimage lists the information
3514contained in the header of an existing U-Boot image; this includes
3515checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003516
wdenk2729af92004-05-03 20:45:30 +00003517 tools/mkimage -l image
3518 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003519
wdenk2729af92004-05-03 20:45:30 +00003520The second form (with "-d" option) is used to build a U-Boot image
3521from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003522
wdenk2729af92004-05-03 20:45:30 +00003523 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3524 -n name -d data_file image
3525 -A ==> set architecture to 'arch'
3526 -O ==> set operating system to 'os'
3527 -T ==> set image type to 'type'
3528 -C ==> set compression type 'comp'
3529 -a ==> set load address to 'addr' (hex)
3530 -e ==> set entry point to 'ep' (hex)
3531 -n ==> set image name to 'name'
3532 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003533
wdenk69459792004-05-29 16:53:29 +00003534Right now, all Linux kernels for PowerPC systems use the same load
3535address (0x00000000), but the entry point address depends on the
3536kernel version:
wdenkc6097192002-11-03 00:24:07 +00003537
wdenk2729af92004-05-03 20:45:30 +00003538- 2.2.x kernels have the entry point at 0x0000000C,
3539- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003540
wdenk2729af92004-05-03 20:45:30 +00003541So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3544 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003545 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003546 > examples/uImage.TQM850L
3547 Image Name: 2.4.4 kernel for TQM850L
3548 Created: Wed Jul 19 02:34:59 2000
3549 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3550 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3551 Load Address: 0x00000000
3552 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003553
wdenk2729af92004-05-03 20:45:30 +00003554To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003555
wdenk2729af92004-05-03 20:45:30 +00003556 -> tools/mkimage -l examples/uImage.TQM850L
3557 Image Name: 2.4.4 kernel for TQM850L
3558 Created: Wed Jul 19 02:34:59 2000
3559 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3560 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3561 Load Address: 0x00000000
3562 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003563
wdenk2729af92004-05-03 20:45:30 +00003564NOTE: for embedded systems where boot time is critical you can trade
3565speed for memory and install an UNCOMPRESSED image instead: this
3566needs more space in Flash, but boots much faster since it does not
3567need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003568
Stefan Roesea47a12b2010-04-15 16:07:28 +02003569 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003570 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3571 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003572 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003573 > examples/uImage.TQM850L-uncompressed
3574 Image Name: 2.4.4 kernel for TQM850L
3575 Created: Wed Jul 19 02:34:59 2000
3576 Image Type: PowerPC Linux Kernel Image (uncompressed)
3577 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3578 Load Address: 0x00000000
3579 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003580
wdenkc6097192002-11-03 00:24:07 +00003581
wdenk2729af92004-05-03 20:45:30 +00003582Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3583when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003584
wdenk2729af92004-05-03 20:45:30 +00003585 -> tools/mkimage -n 'Simple Ramdisk Image' \
3586 > -A ppc -O linux -T ramdisk -C gzip \
3587 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3588 Image Name: Simple Ramdisk Image
3589 Created: Wed Jan 12 14:01:50 2000
3590 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3591 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3592 Load Address: 0x00000000
3593 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003594
wdenkdb01a2e2004-04-15 23:14:49 +00003595
wdenk2729af92004-05-03 20:45:30 +00003596Installing a Linux Image:
3597-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003598
wdenk2729af92004-05-03 20:45:30 +00003599To downloading a U-Boot image over the serial (console) interface,
3600you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003601
wdenk2729af92004-05-03 20:45:30 +00003602 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003603
wdenk2729af92004-05-03 20:45:30 +00003604The 'objcopy' does not understand the information in the U-Boot
3605image header, so the resulting S-Record file will be relative to
3606address 0x00000000. To load it to a given address, you need to
3607specify the target address as 'offset' parameter with the 'loads'
3608command.
wdenkc6097192002-11-03 00:24:07 +00003609
wdenk2729af92004-05-03 20:45:30 +00003610Example: install the image to address 0x40100000 (which on the
3611TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003612
wdenk2729af92004-05-03 20:45:30 +00003613 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003614
wdenk2729af92004-05-03 20:45:30 +00003615 .......... done
3616 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003617
wdenk2729af92004-05-03 20:45:30 +00003618 => loads 40100000
3619 ## Ready for S-Record download ...
3620 ~>examples/image.srec
3621 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3622 ...
3623 15989 15990 15991 15992
3624 [file transfer complete]
3625 [connected]
3626 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003627
3628
wdenk2729af92004-05-03 20:45:30 +00003629You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003630this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003631corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003632
wdenk2729af92004-05-03 20:45:30 +00003633 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003634
wdenk2729af92004-05-03 20:45:30 +00003635 ## Checking Image at 40100000 ...
3636 Image Name: 2.2.13 for initrd on TQM850L
3637 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3638 Data Size: 335725 Bytes = 327 kB = 0 MB
3639 Load Address: 00000000
3640 Entry Point: 0000000c
3641 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003642
3643
wdenk2729af92004-05-03 20:45:30 +00003644Boot Linux:
3645-----------
wdenkc6097192002-11-03 00:24:07 +00003646
wdenk2729af92004-05-03 20:45:30 +00003647The "bootm" command is used to boot an application that is stored in
3648memory (RAM or Flash). In case of a Linux kernel image, the contents
3649of the "bootargs" environment variable is passed to the kernel as
3650parameters. You can check and modify this variable using the
3651"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003652
3653
wdenk2729af92004-05-03 20:45:30 +00003654 => printenv bootargs
3655 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003656
wdenk2729af92004-05-03 20:45:30 +00003657 => 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 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659 => printenv bootargs
3660 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 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662 => bootm 40020000
3663 ## Booting Linux kernel at 40020000 ...
3664 Image Name: 2.2.13 for NFS on TQM850L
3665 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3666 Data Size: 381681 Bytes = 372 kB = 0 MB
3667 Load Address: 00000000
3668 Entry Point: 0000000c
3669 Verifying Checksum ... OK
3670 Uncompressing Kernel Image ... OK
3671 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
3672 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3673 time_init: decrementer frequency = 187500000/60
3674 Calibrating delay loop... 49.77 BogoMIPS
3675 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3676 ...
wdenkc6097192002-11-03 00:24:07 +00003677
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003678If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003679the memory addresses of both the kernel and the initrd image (PPBCOOT
3680format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003681
wdenk2729af92004-05-03 20:45:30 +00003682 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003683
wdenk2729af92004-05-03 20:45:30 +00003684 ## Checking Image at 40100000 ...
3685 Image Name: 2.2.13 for initrd on TQM850L
3686 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3687 Data Size: 335725 Bytes = 327 kB = 0 MB
3688 Load Address: 00000000
3689 Entry Point: 0000000c
3690 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003691
wdenk2729af92004-05-03 20:45:30 +00003692 ## Checking Image at 40200000 ...
3693 Image Name: Simple Ramdisk Image
3694 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3695 Data Size: 566530 Bytes = 553 kB = 0 MB
3696 Load Address: 00000000
3697 Entry Point: 00000000
3698 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk2729af92004-05-03 20:45:30 +00003700 => bootm 40100000 40200000
3701 ## Booting Linux kernel at 40100000 ...
3702 Image Name: 2.2.13 for initrd on TQM850L
3703 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3704 Data Size: 335725 Bytes = 327 kB = 0 MB
3705 Load Address: 00000000
3706 Entry Point: 0000000c
3707 Verifying Checksum ... OK
3708 Uncompressing Kernel Image ... OK
3709 ## Loading RAMDisk Image at 40200000 ...
3710 Image Name: Simple Ramdisk Image
3711 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3712 Data Size: 566530 Bytes = 553 kB = 0 MB
3713 Load Address: 00000000
3714 Entry Point: 00000000
3715 Verifying Checksum ... OK
3716 Loading Ramdisk ... OK
3717 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
3718 Boot arguments: root=/dev/ram
3719 time_init: decrementer frequency = 187500000/60
3720 Calibrating delay loop... 49.77 BogoMIPS
3721 ...
3722 RAMDISK: Compressed image found at block 0
3723 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003724
wdenk2729af92004-05-03 20:45:30 +00003725 bash#
wdenkc6097192002-11-03 00:24:07 +00003726
Matthew McClintock02677682006-06-28 10:41:37 -05003727Boot Linux and pass a flat device tree:
3728-----------
3729
3730First, U-Boot must be compiled with the appropriate defines. See the section
3731titled "Linux Kernel Interface" above for a more in depth explanation. The
3732following is an example of how to start a kernel and pass an updated
3733flat device tree:
3734
3735=> print oftaddr
3736oftaddr=0x300000
3737=> print oft
3738oft=oftrees/mpc8540ads.dtb
3739=> tftp $oftaddr $oft
3740Speed: 1000, full duplex
3741Using TSEC0 device
3742TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3743Filename 'oftrees/mpc8540ads.dtb'.
3744Load address: 0x300000
3745Loading: #
3746done
3747Bytes transferred = 4106 (100a hex)
3748=> tftp $loadaddr $bootfile
3749Speed: 1000, full duplex
3750Using TSEC0 device
3751TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3752Filename 'uImage'.
3753Load address: 0x200000
3754Loading:############
3755done
3756Bytes transferred = 1029407 (fb51f hex)
3757=> print loadaddr
3758loadaddr=200000
3759=> print oftaddr
3760oftaddr=0x300000
3761=> bootm $loadaddr - $oftaddr
3762## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003763 Image Name: Linux-2.6.17-dirty
3764 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3765 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003766 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003767 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003768 Verifying Checksum ... OK
3769 Uncompressing Kernel Image ... OK
3770Booting using flat device tree at 0x300000
3771Using MPC85xx ADS machine description
3772Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3773[snip]
3774
3775
wdenk2729af92004-05-03 20:45:30 +00003776More About U-Boot Image Types:
3777------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003778
wdenk2729af92004-05-03 20:45:30 +00003779U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003780
wdenk2729af92004-05-03 20:45:30 +00003781 "Standalone Programs" are directly runnable in the environment
3782 provided by U-Boot; it is expected that (if they behave
3783 well) you can continue to work in U-Boot after return from
3784 the Standalone Program.
3785 "OS Kernel Images" are usually images of some Embedded OS which
3786 will take over control completely. Usually these programs
3787 will install their own set of exception handlers, device
3788 drivers, set up the MMU, etc. - this means, that you cannot
3789 expect to re-enter U-Boot except by resetting the CPU.
3790 "RAMDisk Images" are more or less just data blocks, and their
3791 parameters (address, size) are passed to an OS kernel that is
3792 being started.
3793 "Multi-File Images" contain several images, typically an OS
3794 (Linux) kernel image and one or more data images like
3795 RAMDisks. This construct is useful for instance when you want
3796 to boot over the network using BOOTP etc., where the boot
3797 server provides just a single image file, but you want to get
3798 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003799
wdenk2729af92004-05-03 20:45:30 +00003800 "Multi-File Images" start with a list of image sizes, each
3801 image size (in bytes) specified by an "uint32_t" in network
3802 byte order. This list is terminated by an "(uint32_t)0".
3803 Immediately after the terminating 0 follow the images, one by
3804 one, all aligned on "uint32_t" boundaries (size rounded up to
3805 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003806
wdenk2729af92004-05-03 20:45:30 +00003807 "Firmware Images" are binary images containing firmware (like
3808 U-Boot or FPGA images) which usually will be programmed to
3809 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003810
wdenk2729af92004-05-03 20:45:30 +00003811 "Script files" are command sequences that will be executed by
3812 U-Boot's command interpreter; this feature is especially
3813 useful when you configure U-Boot to use a real shell (hush)
3814 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003815
wdenkc6097192002-11-03 00:24:07 +00003816
wdenk2729af92004-05-03 20:45:30 +00003817Standalone HOWTO:
3818=================
wdenkc6097192002-11-03 00:24:07 +00003819
wdenk2729af92004-05-03 20:45:30 +00003820One of the features of U-Boot is that you can dynamically load and
3821run "standalone" applications, which can use some resources of
3822U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003823
wdenk2729af92004-05-03 20:45:30 +00003824Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk2729af92004-05-03 20:45:30 +00003826"Hello World" Demo:
3827-------------------
wdenkc6097192002-11-03 00:24:07 +00003828
wdenk2729af92004-05-03 20:45:30 +00003829'examples/hello_world.c' contains a small "Hello World" Demo
3830application; it is automatically compiled when you build U-Boot.
3831It's configured to run at address 0x00040004, so you can play with it
3832like that:
wdenkc6097192002-11-03 00:24:07 +00003833
wdenk2729af92004-05-03 20:45:30 +00003834 => loads
3835 ## Ready for S-Record download ...
3836 ~>examples/hello_world.srec
3837 1 2 3 4 5 6 7 8 9 10 11 ...
3838 [file transfer complete]
3839 [connected]
3840 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003841
wdenk2729af92004-05-03 20:45:30 +00003842 => go 40004 Hello World! This is a test.
3843 ## Starting application at 0x00040004 ...
3844 Hello World
3845 argc = 7
3846 argv[0] = "40004"
3847 argv[1] = "Hello"
3848 argv[2] = "World!"
3849 argv[3] = "This"
3850 argv[4] = "is"
3851 argv[5] = "a"
3852 argv[6] = "test."
3853 argv[7] = "<NULL>"
3854 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003855
wdenk2729af92004-05-03 20:45:30 +00003856 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003857
wdenk2729af92004-05-03 20:45:30 +00003858Another example, which demonstrates how to register a CPM interrupt
3859handler with the U-Boot code, can be found in 'examples/timer.c'.
3860Here, a CPM timer is set up to generate an interrupt every second.
3861The interrupt service routine is trivial, just printing a '.'
3862character, but this is just a demo program. The application can be
3863controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003864
wdenk2729af92004-05-03 20:45:30 +00003865 ? - print current values og the CPM Timer registers
3866 b - enable interrupts and start timer
3867 e - stop timer and disable interrupts
3868 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003869
wdenk2729af92004-05-03 20:45:30 +00003870 => loads
3871 ## Ready for S-Record download ...
3872 ~>examples/timer.srec
3873 1 2 3 4 5 6 7 8 9 10 11 ...
3874 [file transfer complete]
3875 [connected]
3876 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003877
wdenk2729af92004-05-03 20:45:30 +00003878 => go 40004
3879 ## Starting application at 0x00040004 ...
3880 TIMERS=0xfff00980
3881 Using timer 1
3882 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884Hit 'b':
3885 [q, b, e, ?] Set interval 1000000 us
3886 Enabling timer
3887Hit '?':
3888 [q, b, e, ?] ........
3889 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3890Hit '?':
3891 [q, b, e, ?] .
3892 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3893Hit '?':
3894 [q, b, e, ?] .
3895 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3896Hit '?':
3897 [q, b, e, ?] .
3898 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3899Hit 'e':
3900 [q, b, e, ?] ...Stopping timer
3901Hit 'q':
3902 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003903
3904
wdenk2729af92004-05-03 20:45:30 +00003905Minicom warning:
3906================
wdenk85ec0bc2003-03-31 16:34:49 +00003907
wdenk2729af92004-05-03 20:45:30 +00003908Over time, many people have reported problems when trying to use the
3909"minicom" terminal emulation program for serial download. I (wd)
3910consider minicom to be broken, and recommend not to use it. Under
3911Unix, I recommend to use C-Kermit for general purpose use (and
3912especially for kermit binary protocol download ("loadb" command), and
3913use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003914
wdenk2729af92004-05-03 20:45:30 +00003915Nevertheless, if you absolutely want to use it try adding this
3916configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003917
wdenk2729af92004-05-03 20:45:30 +00003918 Name Program Name U/D FullScr IO-Red. Multi
3919 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3920 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003921
3922
wdenk2729af92004-05-03 20:45:30 +00003923NetBSD Notes:
3924=============
wdenkc6097192002-11-03 00:24:07 +00003925
wdenk2729af92004-05-03 20:45:30 +00003926Starting at version 0.9.2, U-Boot supports NetBSD both as host
3927(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003928
wdenk2729af92004-05-03 20:45:30 +00003929Building requires a cross environment; it is known to work on
3930NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3931need gmake since the Makefiles are not compatible with BSD make).
3932Note that the cross-powerpc package does not install include files;
3933attempting to build U-Boot will fail because <machine/ansi.h> is
3934missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003935
wdenk2729af92004-05-03 20:45:30 +00003936 # cd /usr/pkg/cross/powerpc-netbsd/include
3937 # mkdir powerpc
3938 # ln -s powerpc machine
3939 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3940 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk2729af92004-05-03 20:45:30 +00003942Native builds *don't* work due to incompatibilities between native
3943and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945Booting assumes that (the first part of) the image booted is a
3946stage-2 loader which in turn loads and then invokes the kernel
3947proper. Loader sources will eventually appear in the NetBSD source
3948tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003949meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003950
3951
wdenk2729af92004-05-03 20:45:30 +00003952Implementation Internals:
3953=========================
wdenkc6097192002-11-03 00:24:07 +00003954
wdenk2729af92004-05-03 20:45:30 +00003955The following is not intended to be a complete description of every
3956implementation detail. However, it should help to understand the
3957inner workings of U-Boot and make it easier to port it to custom
3958hardware.
wdenkc6097192002-11-03 00:24:07 +00003959
3960
wdenk2729af92004-05-03 20:45:30 +00003961Initial Stack, Global Data:
3962---------------------------
wdenkc6097192002-11-03 00:24:07 +00003963
wdenk2729af92004-05-03 20:45:30 +00003964The implementation of U-Boot is complicated by the fact that U-Boot
3965starts running out of ROM (flash memory), usually without access to
3966system RAM (because the memory controller is not initialized yet).
3967This means that we don't have writable Data or BSS segments, and BSS
3968is not initialized as zero. To be able to get a C environment working
3969at all, we have to allocate at least a minimal stack. Implementation
3970options for this are defined and restricted by the CPU used: Some CPU
3971models provide on-chip memory (like the IMMR area on MPC8xx and
3972MPC826x processors), on others (parts of) the data cache can be
3973locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003974
Wolfgang Denk218ca722008-03-26 10:40:12 +01003975 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01003976 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00003977
wdenk2729af92004-05-03 20:45:30 +00003978 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3979 From: "Chris Hallinan" <clh@net1plus.com>
3980 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3981 ...
wdenk43d96162003-03-06 00:02:04 +00003982
wdenk2729af92004-05-03 20:45:30 +00003983 Correct me if I'm wrong, folks, but the way I understand it
3984 is this: Using DCACHE as initial RAM for Stack, etc, does not
3985 require any physical RAM backing up the cache. The cleverness
3986 is that the cache is being used as a temporary supply of
3987 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003988 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00003989 can see how this works by studying the cache architecture and
3990 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3993 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003994 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00003995 option should work for you. Using CS 4 should be fine if your
3996 board designers haven't used it for something that would
3997 cause you grief during the initial boot! It is frequently not
3998 used.
wdenk43d96162003-03-06 00:02:04 +00003999
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004000 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004001 with your processor/board/system design. The default value
4002 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004003 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004004 than your SDRAM module. If you have a 64MB SDRAM module, set
4005 it above 400_0000. Just make sure your board has no resources
4006 that are supposed to respond to that address! That code in
4007 start.S has been around a while and should work as is when
4008 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004009
wdenk2729af92004-05-03 20:45:30 +00004010 -Chris Hallinan
4011 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004012
wdenk2729af92004-05-03 20:45:30 +00004013It is essential to remember this, since it has some impact on the C
4014code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004015
wdenk2729af92004-05-03 20:45:30 +00004016* Initialized global data (data segment) is read-only. Do not attempt
4017 to write it.
wdenkc6097192002-11-03 00:24:07 +00004018
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004019* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004020 as zero data - BSS segment) at all - this is undefined, initiali-
4021 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004022
wdenk2729af92004-05-03 20:45:30 +00004023* Stack space is very limited. Avoid big data buffers or things like
4024 that.
wdenkc6097192002-11-03 00:24:07 +00004025
wdenk2729af92004-05-03 20:45:30 +00004026Having only the stack as writable memory limits means we cannot use
4027normal global data to share information beween the code. But it
4028turned out that the implementation of U-Boot can be greatly
4029simplified by making a global data structure (gd_t) available to all
4030functions. We could pass a pointer to this data as argument to _all_
4031functions, but this would bloat the code. Instead we use a feature of
4032the GCC compiler (Global Register Variables) to share the data: we
4033place a pointer (gd) to the global data into a register which we
4034reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004035
wdenk2729af92004-05-03 20:45:30 +00004036When choosing a register for such a purpose we are restricted by the
4037relevant (E)ABI specifications for the current architecture, and by
4038GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004039
wdenk2729af92004-05-03 20:45:30 +00004040For PowerPC, the following registers have specific use:
4041 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004042 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004043 R3-R4: parameter passing and return values
4044 R5-R10: parameter passing
4045 R13: small data area pointer
4046 R30: GOT pointer
4047 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004048
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004049 (U-Boot also uses R12 as internal GOT pointer. r12
4050 is a volatile register so r12 needs to be reset when
4051 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004052
Wolfgang Denke7670f62008-02-14 22:43:22 +01004053 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004054
wdenk2729af92004-05-03 20:45:30 +00004055 Note: on PPC, we could use a static initializer (since the
4056 address of the global data structure is known at compile time),
4057 but it turned out that reserving a register results in somewhat
4058 smaller code - although the code savings are not that big (on
4059 average for all boards 752 bytes for the whole U-Boot image,
4060 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004061
Robin Getzc4db3352009-08-17 15:23:02 +00004062On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004063 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4064
Robin Getzc4db3352009-08-17 15:23:02 +00004065 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004066
wdenk2729af92004-05-03 20:45:30 +00004067On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004068
wdenk2729af92004-05-03 20:45:30 +00004069 R0: function argument word/integer result
4070 R1-R3: function argument word
4071 R9: GOT pointer
4072 R10: stack limit (used only if stack checking if enabled)
4073 R11: argument (frame) pointer
4074 R12: temporary workspace
4075 R13: stack pointer
4076 R14: link register
4077 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk2729af92004-05-03 20:45:30 +00004079 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004080
Thomas Chou0df01fd2010-05-21 11:08:03 +08004081On Nios II, the ABI is documented here:
4082 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4083
4084 ==> U-Boot will use gp to hold a pointer to the global data
4085
4086 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4087 to access small data sections, so gp is free.
4088
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004089NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4090or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004091
wdenk2729af92004-05-03 20:45:30 +00004092Memory Management:
4093------------------
wdenkc6097192002-11-03 00:24:07 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095U-Boot runs in system state and uses physical addresses, i.e. the
4096MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004097
wdenk2729af92004-05-03 20:45:30 +00004098The available memory is mapped to fixed addresses using the memory
4099controller. In this process, a contiguous block is formed for each
4100memory type (Flash, SDRAM, SRAM), even when it consists of several
4101physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004102
wdenk2729af92004-05-03 20:45:30 +00004103U-Boot is installed in the first 128 kB of the first Flash bank (on
4104TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4105booting and sizing and initializing DRAM, the code relocates itself
4106to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004107memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004108configuration setting]. Below that, a structure with global Board
4109Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004110
wdenk2729af92004-05-03 20:45:30 +00004111Additionally, some exception handler code is copied to the low 8 kB
4112of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114So a typical memory configuration with 16 MB of DRAM could look like
4115this:
wdenkc6097192002-11-03 00:24:07 +00004116
wdenk2729af92004-05-03 20:45:30 +00004117 0x0000 0000 Exception Vector code
4118 :
4119 0x0000 1FFF
4120 0x0000 2000 Free for Application Use
4121 :
4122 :
wdenkc6097192002-11-03 00:24:07 +00004123
wdenk2729af92004-05-03 20:45:30 +00004124 :
4125 :
4126 0x00FB FF20 Monitor Stack (Growing downward)
4127 0x00FB FFAC Board Info Data and permanent copy of global data
4128 0x00FC 0000 Malloc Arena
4129 :
4130 0x00FD FFFF
4131 0x00FE 0000 RAM Copy of Monitor Code
4132 ... eventually: LCD or video framebuffer
4133 ... eventually: pRAM (Protected RAM - unchanged by reset)
4134 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004135
4136
wdenk2729af92004-05-03 20:45:30 +00004137System Initialization:
4138----------------------
wdenkc6097192002-11-03 00:24:07 +00004139
wdenk2729af92004-05-03 20:45:30 +00004140In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004141(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004142configuration for CS0# this is a mirror of the onboard Flash memory.
4143To be able to re-map memory U-Boot then jumps to its link address.
4144To be able to implement the initialization code in C, a (small!)
4145initial stack is set up in the internal Dual Ported RAM (in case CPUs
4146which provide such a feature like MPC8xx or MPC8260), or in a locked
4147part of the data cache. After that, U-Boot initializes the CPU core,
4148the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004149
wdenk2729af92004-05-03 20:45:30 +00004150Next, all (potentially) available memory banks are mapped using a
4151preliminary mapping. For example, we put them on 512 MB boundaries
4152(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4153on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4154programmed for SDRAM access. Using the temporary configuration, a
4155simple memory test is run that determines the size of the SDRAM
4156banks.
wdenkc6097192002-11-03 00:24:07 +00004157
wdenk2729af92004-05-03 20:45:30 +00004158When there is more than one SDRAM bank, and the banks are of
4159different size, the largest is mapped first. For equal size, the first
4160bank (CS2#) is mapped first. The first mapping is always for address
41610x00000000, with any additional banks following immediately to create
4162contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004163
wdenk2729af92004-05-03 20:45:30 +00004164Then, the monitor installs itself at the upper end of the SDRAM area
4165and allocates memory for use by malloc() and for the global Board
4166Info data; also, the exception vector code is copied to the low RAM
4167pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004168
wdenk2729af92004-05-03 20:45:30 +00004169Only after this relocation will you have a "normal" C environment;
4170until that you are restricted in several ways, mostly because you are
4171running from ROM, and because the code will have to be relocated to a
4172new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004173
4174
wdenk2729af92004-05-03 20:45:30 +00004175U-Boot Porting Guide:
4176----------------------
wdenkc6097192002-11-03 00:24:07 +00004177
wdenk2729af92004-05-03 20:45:30 +00004178[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4179list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004180
4181
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004182int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004183{
4184 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004185
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004186 signal(SIGALRM, no_more_time);
4187 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004188
wdenk2729af92004-05-03 20:45:30 +00004189 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004190 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004191 return 0;
4192 }
4193
wdenk2729af92004-05-03 20:45:30 +00004194 Download latest U-Boot source;
4195
Wolfgang Denk06682362008-12-30 22:56:11 +01004196 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004197
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004198 if (clueless)
4199 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201 while (learning) {
4202 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004203 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4204 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004205 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004206 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004207 }
wdenkc6097192002-11-03 00:24:07 +00004208
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004209 if (available_money > toLocalCurrency ($2500))
4210 Buy a BDI3000;
4211 else
wdenk2729af92004-05-03 20:45:30 +00004212 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004213
4214 if (a similar board exists) { /* hopefully... */
4215 cp -a board/<similar> board/<myboard>
4216 cp include/configs/<similar>.h include/configs/<myboard>.h
4217 } else {
4218 Create your own board support subdirectory;
4219 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004220 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004221 Edit new board/<myboard> files
4222 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004223
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004224 while (!accepted) {
4225 while (!running) {
4226 do {
4227 Add / modify source code;
4228 } until (compiles);
4229 Debug;
4230 if (clueless)
4231 email("Hi, I am having problems...");
4232 }
4233 Send patch file to the U-Boot email list;
4234 if (reasonable critiques)
4235 Incorporate improvements from email list code review;
4236 else
4237 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004238 }
wdenkc6097192002-11-03 00:24:07 +00004239
wdenk2729af92004-05-03 20:45:30 +00004240 return 0;
4241}
4242
4243void no_more_time (int sig)
4244{
4245 hire_a_guru();
4246}
wdenkc6097192002-11-03 00:24:07 +00004247
4248
wdenk2729af92004-05-03 20:45:30 +00004249Coding Standards:
4250-----------------
wdenkc6097192002-11-03 00:24:07 +00004251
wdenk2729af92004-05-03 20:45:30 +00004252All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004253coding style; see the file "Documentation/CodingStyle" and the script
4254"scripts/Lindent" in your Linux kernel source directory. In sources
4255originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4256spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004257
Detlev Zundel2c051652006-09-01 15:39:02 +02004258Source files originating from a different project (for example the
4259MTD subsystem) are generally exempt from these guidelines and are not
4260reformated to ease subsequent migration to newer versions of those
4261sources.
4262
4263Please note that U-Boot is implemented in C (and to some small parts in
4264Assembler); no C++ is used, so please do not use C++ style comments (//)
4265in your code.
wdenk2729af92004-05-03 20:45:30 +00004266
4267Please also stick to the following formatting rules:
4268- remove any trailing white space
4269- use TAB characters for indentation, not spaces
4270- make sure NOT to use DOS '\r\n' line feeds
4271- do not add more than 2 empty lines to source files
4272- do not add trailing empty lines to source files
4273
4274Submissions which do not conform to the standards may be returned
4275with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004276
4277
wdenk2729af92004-05-03 20:45:30 +00004278Submitting Patches:
4279-------------------
wdenkc6097192002-11-03 00:24:07 +00004280
wdenk2729af92004-05-03 20:45:30 +00004281Since the number of patches for U-Boot is growing, we need to
4282establish some rules. Submissions which do not conform to these rules
4283may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004284
Magnus Lilja0d28f342008-08-06 19:32:33 +02004285Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004286
Wolfgang Denk06682362008-12-30 22:56:11 +01004287Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4288see http://lists.denx.de/mailman/listinfo/u-boot
4289
wdenk2729af92004-05-03 20:45:30 +00004290When you send a patch, please include the following information with
4291it:
wdenkc6097192002-11-03 00:24:07 +00004292
wdenk2729af92004-05-03 20:45:30 +00004293* For bug fixes: a description of the bug and how your patch fixes
4294 this bug. Please try to include a way of demonstrating that the
4295 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004296
wdenk2729af92004-05-03 20:45:30 +00004297* For new features: a description of the feature and your
4298 implementation.
wdenkc6097192002-11-03 00:24:07 +00004299
wdenk2729af92004-05-03 20:45:30 +00004300* A CHANGELOG entry as plaintext (separate from the patch)
4301
4302* For major contributions, your entry to the CREDITS file
4303
4304* When you add support for a new board, don't forget to add this
4305 board to the MAKEALL script, too.
4306
4307* If your patch adds new configuration options, don't forget to
4308 document these in the README file.
4309
Wolfgang Denk218ca722008-03-26 10:40:12 +01004310* The patch itself. If you are using git (which is *strongly*
4311 recommended) you can easily generate the patch using the
4312 "git-format-patch". If you then use "git-send-email" to send it to
4313 the U-Boot mailing list, you will avoid most of the common problems
4314 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004315
Wolfgang Denk218ca722008-03-26 10:40:12 +01004316 If you cannot use git, use "diff -purN OLD NEW". If your version of
4317 diff does not support these options, then get the latest version of
4318 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004319
Wolfgang Denk218ca722008-03-26 10:40:12 +01004320 The current directory when running this command shall be the parent
4321 directory of the U-Boot source tree (i. e. please make sure that
4322 your patch includes sufficient directory information for the
4323 affected files).
4324
4325 We prefer patches as plain text. MIME attachments are discouraged,
4326 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004327
4328* If one logical set of modifications affects or creates several
4329 files, all these changes shall be submitted in a SINGLE patch file.
4330
4331* Changesets that contain different, unrelated modifications shall be
4332 submitted as SEPARATE patches, one patch per changeset.
4333
4334
4335Notes:
4336
4337* Before sending the patch, run the MAKEALL script on your patched
4338 source tree and make sure that no errors or warnings are reported
4339 for any of the boards.
4340
4341* Keep your modifications to the necessary minimum: A patch
4342 containing several unrelated changes or arbitrary reformats will be
4343 returned with a request to re-formatting / split it.
4344
4345* If you modify existing code, make sure that your new code does not
4346 add to the memory footprint of the code ;-) Small is beautiful!
4347 When adding new features, these should compile conditionally only
4348 (using #ifdef), and the resulting code with the new feature
4349 disabled must not need more memory than the old code without your
4350 modification.
wdenk90dc6702005-05-03 14:12:25 +00004351
Wolfgang Denk06682362008-12-30 22:56:11 +01004352* Remember that there is a size limit of 100 kB per message on the
4353 u-boot mailing list. Bigger patches will be moderated. If they are
4354 reasonable and not too big, they will be acknowledged. But patches
4355 bigger than the size limit should be avoided.