blob: 2f38af73afb0da7e29ac759cdce1ab5c17fc0f9e [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- Interrupt driven serial port input:
540 CONFIG_SERIAL_SOFTWARE_FIFO
541
542 PPC405GP only.
543 Use an interrupt handler for receiving data on the
544 serial port. It also enables using hardware handshake
545 (RTS/CTS) and UART's built-in FIFO. Set the number of
546 bytes the interrupt driven input buffer should have.
547
wdenk109c0e32004-03-23 21:43:07 +0000548 Leave undefined to disable this feature, including
549 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000550
stroese1d49b1f2003-05-23 11:39:05 +0000551- Console UART Number:
552 CONFIG_UART1_CONSOLE
553
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200554 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000555 If defined internal UART1 (and not UART0) is used
556 as default U-Boot console.
557
wdenkc6097192002-11-03 00:24:07 +0000558- Boot Delay: CONFIG_BOOTDELAY - in seconds
559 Delay before automatically booting the default image;
560 set to -1 to disable autoboot.
561
562 See doc/README.autoboot for these options that
563 work with CONFIG_BOOTDELAY. None are required.
564 CONFIG_BOOT_RETRY_TIME
565 CONFIG_BOOT_RETRY_MIN
566 CONFIG_AUTOBOOT_KEYED
567 CONFIG_AUTOBOOT_PROMPT
568 CONFIG_AUTOBOOT_DELAY_STR
569 CONFIG_AUTOBOOT_STOP_STR
570 CONFIG_AUTOBOOT_DELAY_STR2
571 CONFIG_AUTOBOOT_STOP_STR2
572 CONFIG_ZERO_BOOTDELAY_CHECK
573 CONFIG_RESET_TO_RETRY
574
575- Autoboot Command:
576 CONFIG_BOOTCOMMAND
577 Only needed when CONFIG_BOOTDELAY is enabled;
578 define a command string that is automatically executed
579 when no character is read on the console interface
580 within "Boot Delay" after reset.
581
582 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000583 This can be used to pass arguments to the bootm
584 command. The value of CONFIG_BOOTARGS goes into the
585 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000586
587 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000588 The value of these goes into the environment as
589 "ramboot" and "nfsboot" respectively, and can be used
590 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200591 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000592
593- Pre-Boot Commands:
594 CONFIG_PREBOOT
595
596 When this option is #defined, the existence of the
597 environment variable "preboot" will be checked
598 immediately before starting the CONFIG_BOOTDELAY
599 countdown and/or running the auto-boot command resp.
600 entering interactive mode.
601
602 This feature is especially useful when "preboot" is
603 automatically generated or modified. For an example
604 see the LWMON board specific code: here "preboot" is
605 modified when the user holds down a certain
606 combination of keys on the (special) keyboard when
607 booting the systems
608
609- Serial Download Echo Mode:
610 CONFIG_LOADS_ECHO
611 If defined to 1, all characters received during a
612 serial download (using the "loads" command) are
613 echoed back. This might be needed by some terminal
614 emulations (like "cu"), but may as well just take
615 time on others. This setting #define's the initial
616 value of the "loads_echo" environment variable.
617
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500618- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000619 CONFIG_KGDB_BAUDRATE
620 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200621 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000622
623- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500624 Monitor commands can be included or excluded
625 from the build by using the #include files
626 "config_cmd_all.h" and #undef'ing unwanted
627 commands, or using "config_cmd_default.h"
628 and augmenting with additional #define's
629 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000630
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500631 The default command configuration includes all commands
632 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000633
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500634 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500635 CONFIG_CMD_BDI bdinfo
636 CONFIG_CMD_BEDBUG * Include BedBug Debugger
637 CONFIG_CMD_BMP * BMP support
638 CONFIG_CMD_BSP * Board specific commands
639 CONFIG_CMD_BOOTD bootd
640 CONFIG_CMD_CACHE * icache, dcache
641 CONFIG_CMD_CONSOLE coninfo
642 CONFIG_CMD_DATE * support for RTC, date/time...
643 CONFIG_CMD_DHCP * DHCP support
644 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600645 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
646 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
647 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
648 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500649 CONFIG_CMD_DTT * Digital Therm and Thermostat
650 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500651 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500652 CONFIG_CMD_EEPROM * EEPROM read/write support
653 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500654 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500655 CONFIG_CMD_FDC * Floppy Disk Support
656 CONFIG_CMD_FAT * FAT partition support
657 CONFIG_CMD_FDOS * Dos diskette Support
658 CONFIG_CMD_FLASH flinfo, erase, protect
659 CONFIG_CMD_FPGA FPGA device initialization support
660 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
661 CONFIG_CMD_I2C * I2C serial bus support
662 CONFIG_CMD_IDE * IDE harddisk support
663 CONFIG_CMD_IMI iminfo
664 CONFIG_CMD_IMLS List all found images
665 CONFIG_CMD_IMMAP * IMMR dump support
666 CONFIG_CMD_IRQ * irqinfo
667 CONFIG_CMD_ITEST Integer/string test of 2 values
668 CONFIG_CMD_JFFS2 * JFFS2 Support
669 CONFIG_CMD_KGDB * kgdb
670 CONFIG_CMD_LOADB loadb
671 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400672 CONFIG_CMD_MD5SUM print md5 message digest
673 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500674 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
675 loop, loopw, mtest
676 CONFIG_CMD_MISC Misc functions like sleep etc
677 CONFIG_CMD_MMC * MMC memory mapped support
678 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100679 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500680 CONFIG_CMD_NAND * NAND support
681 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600682 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
683 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500684 CONFIG_CMD_PCI * pciinfo
685 CONFIG_CMD_PCMCIA * PCMCIA support
686 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
687 host
688 CONFIG_CMD_PORTIO * Port I/O
689 CONFIG_CMD_REGINFO * Register dump
690 CONFIG_CMD_RUN run command in env variable
691 CONFIG_CMD_SAVES * save S record dump
692 CONFIG_CMD_SCSI * SCSI Support
693 CONFIG_CMD_SDRAM * print SDRAM configuration information
694 (requires CONFIG_CMD_I2C)
695 CONFIG_CMD_SETGETDCR Support for DCR Register access
696 (4xx only)
Robin Getz02c9aa12009-07-27 00:07:59 -0400697 CONFIG_CMD_SHA1 print sha1 memory digest
698 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200699 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500700 CONFIG_CMD_SPI * SPI serial bus support
701 CONFIG_CMD_USB * USB support
702 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500703 CONFIG_CMD_CDP * Cisco Discover Protocol support
704 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000705
wdenkc6097192002-11-03 00:24:07 +0000706
707 EXAMPLE: If you want all functions except of network
708 support you can write:
709
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500710 #include "config_cmd_all.h"
711 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000712
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400713 Other Commands:
714 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000715
716 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500717 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000718 what you (and your U-Boot users) are doing. Data
719 cache cannot be enabled on systems like the 8xx or
720 8260 (where accesses to the IMMR region must be
721 uncached), and it cannot be disabled on all other
722 systems where we (mis-) use the data cache to hold an
723 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000724
725
726 XXX - this list needs to get updated!
727
728- Watchdog:
729 CONFIG_WATCHDOG
730 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000731 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000732 code for a watchdog. For the 8xx and 8260 CPUs, the
733 SIU Watchdog feature is enabled in the SYPCR
734 register.
735
stroesec1551ea2003-04-04 15:53:41 +0000736- U-Boot Version:
737 CONFIG_VERSION_VARIABLE
738 If this variable is defined, an environment variable
739 named "ver" is created by U-Boot showing the U-Boot
740 version as printed by the "version" command.
741 This variable is readonly.
742
wdenkc6097192002-11-03 00:24:07 +0000743- Real-Time Clock:
744
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500745 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000746 has to be selected, too. Define exactly one of the
747 following options:
748
749 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
750 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200751 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000752 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000753 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000754 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000755 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000756 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100757 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000758 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200759 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000760
wdenkb37c7e52003-06-30 16:24:52 +0000761 Note that if the RTC uses I2C, then the I2C interface
762 must also be configured. See I2C Support, below.
763
Peter Tysere92739d2008-12-17 16:36:21 -0600764- GPIO Support:
765 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
766 CONFIG_PCA953X_INFO - enable pca953x info command
767
768 Note that if the GPIO device uses I2C, then the I2C interface
769 must also be configured. See I2C Support, below.
770
wdenkc6097192002-11-03 00:24:07 +0000771- Timestamp Support:
772
wdenk43d96162003-03-06 00:02:04 +0000773 When CONFIG_TIMESTAMP is selected, the timestamp
774 (date and time) of an image is printed by image
775 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500776 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000777
778- Partition Support:
779 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400780 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000781
Wolfgang Denk218ca722008-03-26 10:40:12 +0100782 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
783 CONFIG_CMD_SCSI) you must configure support for at
784 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000785
786- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000787 CONFIG_IDE_RESET_ROUTINE - this is defined in several
788 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000789
wdenk4d13cba2004-03-14 14:09:05 +0000790 CONFIG_IDE_RESET - is this is defined, IDE Reset will
791 be performed by calling the function
792 ide_set_reset(int reset)
793 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000794
795- ATAPI Support:
796 CONFIG_ATAPI
797
798 Set this to enable ATAPI support.
799
wdenkc40b2952004-03-13 23:29:43 +0000800- LBA48 Support
801 CONFIG_LBA48
802
803 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100804 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000805 Whithout these , LBA48 support uses 32bit variables and will 'only'
806 support disks up to 2.1TB.
807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200808 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000809 When enabled, makes the IDE subsystem use 64bit sector addresses.
810 Default is 32bit.
811
wdenkc6097192002-11-03 00:24:07 +0000812- SCSI Support:
813 At the moment only there is only support for the
814 SYM53C8XX SCSI controller; define
815 CONFIG_SCSI_SYM53C8XX to enable it.
816
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200817 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
818 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
819 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000820 maximum numbers of LUNs, SCSI ID's and target
821 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200822 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000823
824- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000825 CONFIG_E1000
826 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000827
Andre Schwarzac3315c2008-03-06 16:45:44 +0100828 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200829 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100830
wdenkc6097192002-11-03 00:24:07 +0000831 CONFIG_EEPRO100
832 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200833 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000834 write routine for first time initialisation.
835
836 CONFIG_TULIP
837 Support for Digital 2114x chips.
838 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
839 modem chip initialisation (KS8761/QS6611).
840
841 CONFIG_NATSEMI
842 Support for National dp83815 chips.
843
844 CONFIG_NS8382X
845 Support for National dp8382[01] gigabit chips.
846
wdenk45219c42003-05-12 21:50:16 +0000847- NETWORK Support (other):
848
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100849 CONFIG_DRIVER_AT91EMAC
850 Support for AT91RM9200 EMAC.
851
852 CONFIG_RMII
853 Define this to use reduced MII inteface
854
855 CONFIG_DRIVER_AT91EMAC_QUIET
856 If this defined, the driver is quiet.
857 The driver doen't show link status messages.
858
wdenk45219c42003-05-12 21:50:16 +0000859 CONFIG_DRIVER_LAN91C96
860 Support for SMSC's LAN91C96 chips.
861
862 CONFIG_LAN91C96_BASE
863 Define this to hold the physical address
864 of the LAN91C96's I/O space
865
866 CONFIG_LAN91C96_USE_32_BIT
867 Define this to enable 32 bit addressing
868
wdenkf39748a2004-06-09 13:37:52 +0000869 CONFIG_DRIVER_SMC91111
870 Support for SMSC's LAN91C111 chip
871
872 CONFIG_SMC91111_BASE
873 Define this to hold the physical address
874 of the device (I/O space)
875
876 CONFIG_SMC_USE_32_BIT
877 Define this if data bus is 32 bits
878
879 CONFIG_SMC_USE_IOFUNCS
880 Define this to use i/o functions instead of macros
881 (some hardware wont work with macros)
882
Mike Rapoportc2fff332009-11-11 10:03:03 +0200883 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200884 Support for SMSC's LAN911x and LAN921x chips
885
Mike Rapoportc2fff332009-11-11 10:03:03 +0200886 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200887 Define this to hold the physical address
888 of the device (I/O space)
889
Mike Rapoportc2fff332009-11-11 10:03:03 +0200890 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200891 Define this if data bus is 32 bits
892
Mike Rapoportc2fff332009-11-11 10:03:03 +0200893 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200894 Define this if data bus is 16 bits. If your processor
895 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200896 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200897
wdenkc6097192002-11-03 00:24:07 +0000898- USB Support:
899 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000900 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000901 CONFIG_USB_UHCI to enable it.
902 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000903 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000904 storage devices.
905 Note:
906 Supported are USB Keyboards and USB Floppy drives
907 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000908 MPC5200 USB requires additional defines:
909 CONFIG_USB_CLOCK
910 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500911 CONFIG_PSC3_USB
912 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000913 CONFIG_USB_CONFIG
914 for differential drivers: 0x00001000
915 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500916 for differential drivers on PSC3: 0x00000100
917 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200918 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200919 May be defined to allow interrupt polling
920 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000921
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200922- USB Device:
923 Define the below if you wish to use the USB console.
924 Once firmware is rebuilt from a serial console issue the
925 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200926 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200927 it has found a new device. The environment variable usbtty
928 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200929 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200930 Common Device Class Abstract Control Model serial device.
931 If you select usbtty = gserial you should be able to enumerate
932 a Linux host by
933 # modprobe usbserial vendor=0xVendorID product=0xProductID
934 else if using cdc_acm, simply setting the environment
935 variable usbtty to be cdc_acm should suffice. The following
936 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200937
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200938 CONFIG_USB_DEVICE
939 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000940
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200941 CONFIG_USB_TTY
942 Define this to have a tty type of device available to
943 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200944
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200945 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200946 Define this if you want stdin, stdout &/or stderr to
947 be set to usbtty.
948
949 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200950 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200951 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200952 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200953
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200954 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200955 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200956 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200957
Wolfgang Denk386eda02006-06-14 18:14:56 +0200958 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200959 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200960 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200961 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
962 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
963 should pretend to be a Linux device to it's target host.
964
965 CONFIG_USBD_MANUFACTURER
966 Define this string as the name of your company for
967 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200968
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200969 CONFIG_USBD_PRODUCT_NAME
970 Define this string as the name of your product
971 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
972
973 CONFIG_USBD_VENDORID
974 Define this as your assigned Vendor ID from the USB
975 Implementors Forum. This *must* be a genuine Vendor ID
976 to avoid polluting the USB namespace.
977 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200978
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200979 CONFIG_USBD_PRODUCTID
980 Define this as the unique Product ID
981 for your device
982 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000983
984
985- MMC Support:
986 The MMC controller on the Intel PXA is supported. To
987 enable this define CONFIG_MMC. The MMC can be
988 accessed from the boot prompt by mapping the device
989 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500990 enabled with CONFIG_CMD_MMC. The MMC driver also works with
991 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000992
wdenk6705d812004-08-02 23:22:59 +0000993- Journaling Flash filesystem support:
994 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
995 CONFIG_JFFS2_NAND_DEV
996 Define these for a default partition on a NAND device
997
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200998 CONFIG_SYS_JFFS2_FIRST_SECTOR,
999 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001000 Define these for a default partition on a NOR device
1001
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001002 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001003 Define this to create an own partition. You have to provide a
1004 function struct part_info* jffs2_part_info(int part_num)
1005
1006 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001007 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001008 to disable the command chpart. This is the default when you
1009 have not defined a custom partition
1010
wdenkc6097192002-11-03 00:24:07 +00001011- Keyboard Support:
1012 CONFIG_ISA_KEYBOARD
1013
1014 Define this to enable standard (PC-Style) keyboard
1015 support
1016
1017 CONFIG_I8042_KBD
1018 Standard PC keyboard driver with US (is default) and
1019 GERMAN key layout (switch via environment 'keymap=de') support.
1020 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1021 for cfb_console. Supports cursor blinking.
1022
1023- Video support:
1024 CONFIG_VIDEO
1025
1026 Define this to enable video support (for output to
1027 video).
1028
1029 CONFIG_VIDEO_CT69000
1030
1031 Enable Chips & Technologies 69000 Video chip
1032
1033 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001034 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001035 video output is selected via environment 'videoout'
1036 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1037 assumed.
wdenkc6097192002-11-03 00:24:07 +00001038
wdenkb79a11c2004-03-25 15:14:43 +00001039 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001040 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001041 are possible:
1042 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001043 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001044
1045 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1046 -------------+---------------------------------------------
1047 8 bits | 0x301* 0x303 0x305 0x161 0x307
1048 15 bits | 0x310 0x313 0x316 0x162 0x319
1049 16 bits | 0x311 0x314 0x317 0x163 0x31A
1050 24 bits | 0x312 0x315 0x318 ? 0x31B
1051 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001052 (i.e. setenv videomode 317; saveenv; reset;)
1053
wdenkb79a11c2004-03-25 15:14:43 +00001054 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001055 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001056
1057
stroesec1551ea2003-04-04 15:53:41 +00001058 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001059 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001060 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1061 or CONFIG_VIDEO_SED13806_16BPP
1062
wdenk682011f2003-06-03 23:54:09 +00001063- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001064 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001065
wdenk8bde7f72003-06-27 21:31:46 +00001066 Define this to enable a custom keyboard support.
1067 This simply calls drv_keyboard_init() which must be
1068 defined in your board-specific files.
1069 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001070
wdenkc6097192002-11-03 00:24:07 +00001071- LCD Support: CONFIG_LCD
1072
1073 Define this to enable LCD support (for output to LCD
1074 display); also select one of the supported displays
1075 by defining one of these:
1076
Stelian Pop39cf4802008-05-09 21:57:18 +02001077 CONFIG_ATMEL_LCD:
1078
1079 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1080
wdenkfd3103b2003-11-25 16:55:19 +00001081 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001082
wdenkfd3103b2003-11-25 16:55:19 +00001083 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001084
wdenkfd3103b2003-11-25 16:55:19 +00001085 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001086
wdenkfd3103b2003-11-25 16:55:19 +00001087 NEC NL6448BC20-08. 6.5", 640x480.
1088 Active, color, single scan.
1089
1090 CONFIG_NEC_NL6448BC33_54
1091
1092 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001093 Active, color, single scan.
1094
1095 CONFIG_SHARP_16x9
1096
1097 Sharp 320x240. Active, color, single scan.
1098 It isn't 16x9, and I am not sure what it is.
1099
1100 CONFIG_SHARP_LQ64D341
1101
1102 Sharp LQ64D341 display, 640x480.
1103 Active, color, single scan.
1104
1105 CONFIG_HLD1045
1106
1107 HLD1045 display, 640x480.
1108 Active, color, single scan.
1109
1110 CONFIG_OPTREX_BW
1111
1112 Optrex CBL50840-2 NF-FW 99 22 M5
1113 or
1114 Hitachi LMG6912RPFC-00T
1115 or
1116 Hitachi SP14Q002
1117
1118 320x240. Black & white.
1119
1120 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001121 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001122
wdenk7152b1d2003-09-05 23:19:14 +00001123- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001124
wdenk8bde7f72003-06-27 21:31:46 +00001125 If this option is set, the environment is checked for
1126 a variable "splashimage". If found, the usual display
1127 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001128 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001129 specified in "splashimage" is loaded instead. The
1130 console is redirected to the "nulldev", too. This
1131 allows for a "silent" boot where a splash screen is
1132 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001133
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001134 CONFIG_SPLASH_SCREEN_ALIGN
1135
1136 If this option is set the splash image can be freely positioned
1137 on the screen. Environment variable "splashpos" specifies the
1138 position as "x,y". If a positive number is given it is used as
1139 number of pixel from left/top. If a negative number is given it
1140 is used as number of pixel from right/bottom. You can also
1141 specify 'm' for centering the image.
1142
1143 Example:
1144 setenv splashpos m,m
1145 => image at center of screen
1146
1147 setenv splashpos 30,20
1148 => image at x = 30 and y = 20
1149
1150 setenv splashpos -10,m
1151 => vertically centered image
1152 at x = dspWidth - bmpWidth - 9
1153
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001154- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1155
1156 If this option is set, additionally to standard BMP
1157 images, gzipped BMP images can be displayed via the
1158 splashscreen support or the bmp command.
1159
Anatolij Gustschind5011762010-03-15 14:50:25 +01001160- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1161
1162 If this option is set, 8-bit RLE compressed BMP images
1163 can be displayed via the splashscreen support or the
1164 bmp command.
1165
wdenkc29fdfc2003-08-29 20:57:53 +00001166- Compression support:
1167 CONFIG_BZIP2
1168
1169 If this option is set, support for bzip2 compressed
1170 images is included. If not, only uncompressed and gzip
1171 compressed images are supported.
1172
wdenk42d1f032003-10-15 23:53:47 +00001173 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001174 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001175 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001176
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001177 CONFIG_LZMA
1178
1179 If this option is set, support for lzma compressed
1180 images is included.
1181
1182 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1183 requires an amount of dynamic memory that is given by the
1184 formula:
1185
1186 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1187
1188 Where lc and lp stand for, respectively, Literal context bits
1189 and Literal pos bits.
1190
1191 This value is upper-bounded by 14MB in the worst case. Anyway,
1192 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1193 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1194 a very small buffer.
1195
1196 Use the lzmainfo tool to determinate the lc and lp values and
1197 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001198 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001199
wdenk17ea1172004-06-06 21:51:03 +00001200- MII/PHY support:
1201 CONFIG_PHY_ADDR
1202
1203 The address of PHY on MII bus.
1204
1205 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1206
1207 The clock frequency of the MII bus
1208
1209 CONFIG_PHY_GIGE
1210
1211 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001212 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001213
1214 CONFIG_PHY_RESET_DELAY
1215
1216 Some PHY like Intel LXT971A need extra delay after
1217 reset before any MII register access is possible.
1218 For such PHY, set this option to the usec delay
1219 required. (minimum 300usec for LXT971A)
1220
1221 CONFIG_PHY_CMD_DELAY (ppc4xx)
1222
1223 Some PHY like Intel LXT971A need extra delay after
1224 command issued before MII status register can be read
1225
wdenkc6097192002-11-03 00:24:07 +00001226- Ethernet address:
1227 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001228 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001229 CONFIG_ETH2ADDR
1230 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001231 CONFIG_ETH4ADDR
1232 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001233
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001234 Define a default value for Ethernet address to use
1235 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001236 is not determined automatically.
1237
1238- IP address:
1239 CONFIG_IPADDR
1240
1241 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001242 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001243 determined through e.g. bootp.
1244
1245- Server IP address:
1246 CONFIG_SERVERIP
1247
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001248 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001249 server to contact when using the "tftboot" command.
1250
Robin Getz97cfe862009-07-21 12:15:28 -04001251 CONFIG_KEEP_SERVERADDR
1252
1253 Keeps the server's MAC address, in the env 'serveraddr'
1254 for passing to bootargs (like Linux's netconsole option)
1255
David Updegraff53a5c422007-06-11 10:41:07 -05001256- Multicast TFTP Mode:
1257 CONFIG_MCAST_TFTP
1258
1259 Defines whether you want to support multicast TFTP as per
1260 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001261 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001262 driver in use must provide a function: mcast() to join/leave a
1263 multicast group.
1264
1265 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001266- BOOTP Recovery Mode:
1267 CONFIG_BOOTP_RANDOM_DELAY
1268
1269 If you have many targets in a network that try to
1270 boot using BOOTP, you may want to avoid that all
1271 systems send out BOOTP requests at precisely the same
1272 moment (which would happen for instance at recovery
1273 from a power failure, when all systems will try to
1274 boot, thus flooding the BOOTP server. Defining
1275 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1276 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001277 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001278
1279 1st BOOTP request: delay 0 ... 1 sec
1280 2nd BOOTP request: delay 0 ... 2 sec
1281 3rd BOOTP request: delay 0 ... 4 sec
1282 4th and following
1283 BOOTP requests: delay 0 ... 8 sec
1284
stroesefe389a82003-08-28 14:17:32 +00001285- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001286 You can fine tune the DHCP functionality by defining
1287 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001288
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001289 CONFIG_BOOTP_SUBNETMASK
1290 CONFIG_BOOTP_GATEWAY
1291 CONFIG_BOOTP_HOSTNAME
1292 CONFIG_BOOTP_NISDOMAIN
1293 CONFIG_BOOTP_BOOTPATH
1294 CONFIG_BOOTP_BOOTFILESIZE
1295 CONFIG_BOOTP_DNS
1296 CONFIG_BOOTP_DNS2
1297 CONFIG_BOOTP_SEND_HOSTNAME
1298 CONFIG_BOOTP_NTPSERVER
1299 CONFIG_BOOTP_TIMEOFFSET
1300 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001301
Wilson Callan5d110f02007-07-28 10:56:13 -04001302 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1303 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001304
1305 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1306 serverip from a DHCP server, it is possible that more
1307 than one DNS serverip is offered to the client.
1308 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1309 serverip will be stored in the additional environment
1310 variable "dnsip2". The first DNS serverip is always
1311 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001312 is defined.
stroesefe389a82003-08-28 14:17:32 +00001313
1314 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1315 to do a dynamic update of a DNS server. To do this, they
1316 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001317 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001318 of the "hostname" environment variable is passed as
1319 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001320
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001321 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1322
1323 A 32bit value in microseconds for a delay between
1324 receiving a "DHCP Offer" and sending the "DHCP Request".
1325 This fixes a problem with certain DHCP servers that don't
1326 respond 100% of the time to a "DHCP request". E.g. On an
1327 AT91RM9200 processor running at 180MHz, this delay needed
1328 to be *at least* 15,000 usec before a Windows Server 2003
1329 DHCP server would reply 100% of the time. I recommend at
1330 least 50,000 usec to be safe. The alternative is to hope
1331 that one of the retries will be successful but note that
1332 the DHCP timeout and retry process takes a longer than
1333 this delay.
1334
wdenka3d991b2004-04-15 21:48:45 +00001335 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001336 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001337
1338 The device id used in CDP trigger frames.
1339
1340 CONFIG_CDP_DEVICE_ID_PREFIX
1341
1342 A two character string which is prefixed to the MAC address
1343 of the device.
1344
1345 CONFIG_CDP_PORT_ID
1346
1347 A printf format string which contains the ascii name of
1348 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001349 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001350
1351 CONFIG_CDP_CAPABILITIES
1352
1353 A 32bit integer which indicates the device capabilities;
1354 0x00000010 for a normal host which does not forwards.
1355
1356 CONFIG_CDP_VERSION
1357
1358 An ascii string containing the version of the software.
1359
1360 CONFIG_CDP_PLATFORM
1361
1362 An ascii string containing the name of the platform.
1363
1364 CONFIG_CDP_TRIGGER
1365
1366 A 32bit integer sent on the trigger.
1367
1368 CONFIG_CDP_POWER_CONSUMPTION
1369
1370 A 16bit integer containing the power consumption of the
1371 device in .1 of milliwatts.
1372
1373 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1374
1375 A byte containing the id of the VLAN.
1376
wdenkc6097192002-11-03 00:24:07 +00001377- Status LED: CONFIG_STATUS_LED
1378
1379 Several configurations allow to display the current
1380 status using a LED. For instance, the LED will blink
1381 fast while running U-Boot code, stop blinking as
1382 soon as a reply to a BOOTP request was received, and
1383 start blinking slow once the Linux kernel is running
1384 (supported by a status LED driver in the Linux
1385 kernel). Defining CONFIG_STATUS_LED enables this
1386 feature in U-Boot.
1387
1388- CAN Support: CONFIG_CAN_DRIVER
1389
1390 Defining CONFIG_CAN_DRIVER enables CAN driver support
1391 on those systems that support this (optional)
1392 feature, like the TQM8xxL modules.
1393
1394- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1395
wdenkb37c7e52003-06-30 16:24:52 +00001396 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001397 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001398 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001399
wdenk945af8d2003-07-16 21:53:01 +00001400 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001401 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001402 CONFIG_COMMANDS) and communicate with i2c based realtime
1403 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001404 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001405
Ben Warrenbb99ad62006-09-07 16:50:54 -04001406 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001407
wdenk945af8d2003-07-16 21:53:01 +00001408 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001409 bit-banging) driver instead of CPM or similar hardware
1410 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001411
wdenk945af8d2003-07-16 21:53:01 +00001412 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001413 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001414
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001415 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001416 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001417 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001418 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001419
Peter Tyser8d321b82010-04-12 22:28:21 -05001420 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001421 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001422 and so its address should therefore be cleared to 0 (See,
1423 eg, MPC823e User's Manual p.16-473). So, set
1424 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001425
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001426 CONFIG_SYS_I2C_INIT_MPC5XXX
1427
1428 When a board is reset during an i2c bus transfer
1429 chips might think that the current transfer is still
1430 in progress. Reset the slave devices by sending start
1431 commands until the slave device responds.
1432
wdenk945af8d2003-07-16 21:53:01 +00001433 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001434
1435 If you use the software i2c interface (CONFIG_SOFT_I2C)
1436 then the following macros need to be defined (examples are
1437 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001438
1439 I2C_INIT
1440
wdenkb37c7e52003-06-30 16:24:52 +00001441 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001442 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001443
wdenkba56f622004-02-06 23:19:44 +00001444 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001445
wdenkc6097192002-11-03 00:24:07 +00001446 I2C_PORT
1447
wdenk43d96162003-03-06 00:02:04 +00001448 (Only for MPC8260 CPU). The I/O port to use (the code
1449 assumes both bits are on the same port). Valid values
1450 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001451
1452 I2C_ACTIVE
1453
1454 The code necessary to make the I2C data line active
1455 (driven). If the data line is open collector, this
1456 define can be null.
1457
wdenkb37c7e52003-06-30 16:24:52 +00001458 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1459
wdenkc6097192002-11-03 00:24:07 +00001460 I2C_TRISTATE
1461
1462 The code necessary to make the I2C data line tri-stated
1463 (inactive). If the data line is open collector, this
1464 define can be null.
1465
wdenkb37c7e52003-06-30 16:24:52 +00001466 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1467
wdenkc6097192002-11-03 00:24:07 +00001468 I2C_READ
1469
1470 Code that returns TRUE if the I2C data line is high,
1471 FALSE if it is low.
1472
wdenkb37c7e52003-06-30 16:24:52 +00001473 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1474
wdenkc6097192002-11-03 00:24:07 +00001475 I2C_SDA(bit)
1476
1477 If <bit> is TRUE, sets the I2C data line high. If it
1478 is FALSE, it clears it (low).
1479
wdenkb37c7e52003-06-30 16:24:52 +00001480 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001481 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001482 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001483
wdenkc6097192002-11-03 00:24:07 +00001484 I2C_SCL(bit)
1485
1486 If <bit> is TRUE, sets the I2C clock line high. If it
1487 is FALSE, it clears it (low).
1488
wdenkb37c7e52003-06-30 16:24:52 +00001489 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001490 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001491 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001492
wdenkc6097192002-11-03 00:24:07 +00001493 I2C_DELAY
1494
1495 This delay is invoked four times per clock cycle so this
1496 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001497 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001498 like:
1499
wdenkb37c7e52003-06-30 16:24:52 +00001500 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001501
Mike Frysinger793b5722010-07-21 13:38:02 -04001502 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1503
1504 If your arch supports the generic GPIO framework (asm/gpio.h),
1505 then you may alternatively define the two GPIOs that are to be
1506 used as SCL / SDA. Any of the previous I2C_xxx macros will
1507 have GPIO-based defaults assigned to them as appropriate.
1508
1509 You should define these to the GPIO value as given directly to
1510 the generic GPIO functions.
1511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001512 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001513
wdenk8bde7f72003-06-27 21:31:46 +00001514 When a board is reset during an i2c bus transfer
1515 chips might think that the current transfer is still
1516 in progress. On some boards it is possible to access
1517 the i2c SCLK line directly, either by using the
1518 processor pin as a GPIO or by having a second pin
1519 connected to the bus. If this option is defined a
1520 custom i2c_init_board() routine in boards/xxx/board.c
1521 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001522
Richard Retanubun26a33502010-04-12 15:08:17 -04001523 CONFIG_SYS_I2C_BOARD_LATE_INIT
1524
1525 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1526 defined a custom i2c_board_late_init() routine in
1527 boards/xxx/board.c is run AFTER the operations in i2c_init()
1528 is completed. This callpoint can be used to unreset i2c bus
1529 using CPU i2c controller register accesses for CPUs whose i2c
1530 controller provide such a method. It is called at the end of
1531 i2c_init() to allow i2c_init operations to setup the i2c bus
1532 controller on the CPU (e.g. setting bus speed & slave address).
1533
wdenk17ea1172004-06-06 21:51:03 +00001534 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1535
1536 This option enables configuration of bi_iic_fast[] flags
1537 in u-boot bd_info structure based on u-boot environment
1538 variable "i2cfast". (see also i2cfast)
1539
Ben Warrenbb99ad62006-09-07 16:50:54 -04001540 CONFIG_I2C_MULTI_BUS
1541
1542 This option allows the use of multiple I2C buses, each of which
1543 must have a controller. At any point in time, only one bus is
1544 active. To switch to a different bus, use the 'i2c dev' command.
1545 Note that bus numbering is zero-based.
1546
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001547 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001548
1549 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001550 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1551 is set, specify a list of bus-device pairs. Otherwise, specify
1552 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001553
1554 e.g.
1555 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001556 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001557
1558 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1559
1560 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001561 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001562
1563 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1564
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001565 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001566
1567 If defined, then this indicates the I2C bus number for DDR SPD.
1568 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1569
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001570 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001571
1572 If defined, then this indicates the I2C bus number for the RTC.
1573 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1574
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001575 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001576
1577 If defined, then this indicates the I2C bus number for the DTT.
1578 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1579
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001580 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001581
1582 If defined, specifies the I2C address of the DTT device.
1583 If not defined, then U-Boot uses predefined value for
1584 specified DTT device.
1585
Timur Tabibe5e6182006-11-03 19:15:00 -06001586 CONFIG_FSL_I2C
1587
1588 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001589 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001590
Heiko Schocher67b23a32008-10-15 09:39:47 +02001591 CONFIG_I2C_MUX
1592
1593 Define this option if you have I2C devices reached over 1 .. n
1594 I2C Muxes like the pca9544a. This option addes a new I2C
1595 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1596 new I2C Bus to the existing I2C Busses. If you select the
1597 new Bus with "i2c dev", u-bbot sends first the commandos for
1598 the muxes to activate this new "bus".
1599
1600 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1601 feature!
1602
1603 Example:
1604 Adding a new I2C Bus reached over 2 pca9544a muxes
1605 The First mux with address 70 and channel 6
1606 The Second mux with address 71 and channel 4
1607
1608 => i2c bus pca9544a:70:6:pca9544a:71:4
1609
1610 Use the "i2c bus" command without parameter, to get a list
1611 of I2C Busses with muxes:
1612
1613 => i2c bus
1614 Busses reached over muxes:
1615 Bus ID: 2
1616 reached over Mux(es):
1617 pca9544a@70 ch: 4
1618 Bus ID: 3
1619 reached over Mux(es):
1620 pca9544a@70 ch: 6
1621 pca9544a@71 ch: 4
1622 =>
1623
1624 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1625 u-boot sends First the Commando to the mux@70 to enable
1626 channel 6, and then the Commando to the mux@71 to enable
1627 the channel 4.
1628
1629 After that, you can use the "normal" i2c commands as
1630 usual, to communicate with your I2C devices behind
1631 the 2 muxes.
1632
1633 This option is actually implemented for the bitbanging
1634 algorithm in common/soft_i2c.c and for the Hardware I2C
1635 Bus on the MPC8260. But it should be not so difficult
1636 to add this option to other architectures.
1637
Andrew Dyer2ac69852008-12-29 17:36:01 -06001638 CONFIG_SOFT_I2C_READ_REPEATED_START
1639
1640 defining this will force the i2c_read() function in
1641 the soft_i2c driver to perform an I2C repeated start
1642 between writing the address pointer and reading the
1643 data. If this define is omitted the default behaviour
1644 of doing a stop-start sequence will be used. Most I2C
1645 devices can use either method, but some require one or
1646 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001647
wdenkc6097192002-11-03 00:24:07 +00001648- SPI Support: CONFIG_SPI
1649
1650 Enables SPI driver (so far only tested with
1651 SPI EEPROM, also an instance works with Crystal A/D and
1652 D/As on the SACSng board)
1653
1654 CONFIG_SPI_X
1655
1656 Enables extended (16-bit) SPI EEPROM addressing.
1657 (symmetrical to CONFIG_I2C_X)
1658
1659 CONFIG_SOFT_SPI
1660
wdenk43d96162003-03-06 00:02:04 +00001661 Enables a software (bit-bang) SPI driver rather than
1662 using hardware support. This is a general purpose
1663 driver that only requires three general I/O port pins
1664 (two outputs, one input) to function. If this is
1665 defined, the board configuration must define several
1666 SPI configuration items (port pins to use, etc). For
1667 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001668
Ben Warren04a9e112008-01-16 22:37:35 -05001669 CONFIG_HARD_SPI
1670
1671 Enables a hardware SPI driver for general-purpose reads
1672 and writes. As with CONFIG_SOFT_SPI, the board configuration
1673 must define a list of chip-select function pointers.
1674 Currently supported on some MPC8xxx processors. For an
1675 example, see include/configs/mpc8349emds.h.
1676
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001677 CONFIG_MXC_SPI
1678
1679 Enables the driver for the SPI controllers on i.MX and MXC
1680 SoCs. Currently only i.MX31 is supported.
1681
Matthias Fuchs01335022007-12-27 17:12:34 +01001682- FPGA Support: CONFIG_FPGA
1683
1684 Enables FPGA subsystem.
1685
1686 CONFIG_FPGA_<vendor>
1687
1688 Enables support for specific chip vendors.
1689 (ALTERA, XILINX)
1690
1691 CONFIG_FPGA_<family>
1692
1693 Enables support for FPGA family.
1694 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1695
1696 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001697
wdenk43d96162003-03-06 00:02:04 +00001698 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001699
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001700 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001701
wdenk8bde7f72003-06-27 21:31:46 +00001702 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001703
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001704 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001705
wdenk43d96162003-03-06 00:02:04 +00001706 Enable checks on FPGA configuration interface busy
1707 status by the configuration function. This option
1708 will require a board or device specific function to
1709 be written.
wdenkc6097192002-11-03 00:24:07 +00001710
1711 CONFIG_FPGA_DELAY
1712
1713 If defined, a function that provides delays in the FPGA
1714 configuration driver.
1715
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001716 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001717 Allow Control-C to interrupt FPGA configuration
1718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001719 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001720
wdenk43d96162003-03-06 00:02:04 +00001721 Check for configuration errors during FPGA bitfile
1722 loading. For example, abort during Virtex II
1723 configuration if the INIT_B line goes low (which
1724 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001725
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001726 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001727
wdenk43d96162003-03-06 00:02:04 +00001728 Maximum time to wait for the INIT_B line to deassert
1729 after PROB_B has been deasserted during a Virtex II
1730 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001731 ms.
wdenkc6097192002-11-03 00:24:07 +00001732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001733 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001734
wdenk43d96162003-03-06 00:02:04 +00001735 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001736 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001738 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001739
wdenk43d96162003-03-06 00:02:04 +00001740 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001741 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001742
1743- Configuration Management:
1744 CONFIG_IDENT_STRING
1745
wdenk43d96162003-03-06 00:02:04 +00001746 If defined, this string will be added to the U-Boot
1747 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001748
1749- Vendor Parameter Protection:
1750
wdenk43d96162003-03-06 00:02:04 +00001751 U-Boot considers the values of the environment
1752 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001753 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001754 are set once by the board vendor / manufacturer, and
1755 protects these variables from casual modification by
1756 the user. Once set, these variables are read-only,
1757 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001758 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001759
1760 If CONFIG_ENV_OVERWRITE is #defined in your config
1761 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001762 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001763 these parameters.
1764
1765 Alternatively, if you #define _both_ CONFIG_ETHADDR
1766 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001767 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001768 which can be changed exactly ONCE by the user. [The
1769 serial# is unaffected by this, i. e. it remains
1770 read-only.]
1771
1772- Protected RAM:
1773 CONFIG_PRAM
1774
1775 Define this variable to enable the reservation of
1776 "protected RAM", i. e. RAM which is not overwritten
1777 by U-Boot. Define CONFIG_PRAM to hold the number of
1778 kB you want to reserve for pRAM. You can overwrite
1779 this default value by defining an environment
1780 variable "pram" to the number of kB you want to
1781 reserve. Note that the board info structure will
1782 still show the full amount of RAM. If pRAM is
1783 reserved, a new environment variable "mem" will
1784 automatically be defined to hold the amount of
1785 remaining RAM in a form that can be passed as boot
1786 argument to Linux, for instance like that:
1787
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001788 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001789 saveenv
1790
1791 This way you can tell Linux not to use this memory,
1792 either, which results in a memory region that will
1793 not be affected by reboots.
1794
1795 *WARNING* If your board configuration uses automatic
1796 detection of the RAM size, you must make sure that
1797 this memory test is non-destructive. So far, the
1798 following board configurations are known to be
1799 "pRAM-clean":
1800
1801 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1802 HERMES, IP860, RPXlite, LWMON, LANTEC,
1803 PCU_E, FLAGADM, TQM8260
1804
1805- Error Recovery:
1806 CONFIG_PANIC_HANG
1807
1808 Define this variable to stop the system in case of a
1809 fatal error, so that you have to reset it manually.
1810 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001811 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001812 automatically as fast as possible, but it may be
1813 useful during development since you can try to debug
1814 the conditions that lead to the situation.
1815
1816 CONFIG_NET_RETRY_COUNT
1817
wdenk43d96162003-03-06 00:02:04 +00001818 This variable defines the number of retries for
1819 network operations like ARP, RARP, TFTP, or BOOTP
1820 before giving up the operation. If not defined, a
1821 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001822
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001823 CONFIG_ARP_TIMEOUT
1824
1825 Timeout waiting for an ARP reply in milliseconds.
1826
wdenkc6097192002-11-03 00:24:07 +00001827- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001828 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001829
1830 Enable auto completion of commands using TAB.
1831
Wolfgang Denka9398e02006-11-27 15:32:42 +01001832 Note that this feature has NOT been implemented yet
1833 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001834
1835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001836 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001837
1838 Define this variable to enable the "hush" shell (from
1839 Busybox) as command line interpreter, thus enabling
1840 powerful command line syntax like
1841 if...then...else...fi conditionals or `&&' and '||'
1842 constructs ("shell scripts").
1843
1844 If undefined, you get the old, much simpler behaviour
1845 with a somewhat smaller memory footprint.
1846
1847
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001848 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001849
1850 This defines the secondary prompt string, which is
1851 printed when the command interpreter needs more input
1852 to complete a command. Usually "> ".
1853
1854 Note:
1855
wdenk8bde7f72003-06-27 21:31:46 +00001856 In the current implementation, the local variables
1857 space and global environment variables space are
1858 separated. Local variables are those you define by
1859 simply typing `name=value'. To access a local
1860 variable later on, you have write `$name' or
1861 `${name}'; to execute the contents of a variable
1862 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001863
wdenk43d96162003-03-06 00:02:04 +00001864 Global environment variables are those you use
1865 setenv/printenv to work with. To run a command stored
1866 in such a variable, you need to use the run command,
1867 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001868
1869 To store commands and special characters in a
1870 variable, please use double quotation marks
1871 surrounding the whole text of the variable, instead
1872 of the backslashes before semicolons and special
1873 symbols.
1874
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001875- Commandline Editing and History:
1876 CONFIG_CMDLINE_EDITING
1877
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001878 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001879 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001880
wdenka8c7c702003-12-06 19:49:23 +00001881- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001882 CONFIG_EXTRA_ENV_SETTINGS
1883
wdenk43d96162003-03-06 00:02:04 +00001884 Define this to contain any number of null terminated
1885 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001886 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001887
wdenk43d96162003-03-06 00:02:04 +00001888 For example, place something like this in your
1889 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001890
1891 #define CONFIG_EXTRA_ENV_SETTINGS \
1892 "myvar1=value1\0" \
1893 "myvar2=value2\0"
1894
wdenk43d96162003-03-06 00:02:04 +00001895 Warning: This method is based on knowledge about the
1896 internal format how the environment is stored by the
1897 U-Boot code. This is NOT an official, exported
1898 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001899 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001900 You better know what you are doing here.
1901
wdenk43d96162003-03-06 00:02:04 +00001902 Note: overly (ab)use of the default environment is
1903 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001904 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001905 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001906
wdenka8c7c702003-12-06 19:49:23 +00001907- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001908 CONFIG_HAS_DATAFLASH
1909
wdenk8bde7f72003-06-27 21:31:46 +00001910 Defining this option enables DataFlash features and
1911 allows to read/write in Dataflash via the standard
1912 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001913
wdenk3f85ce22004-02-23 16:11:30 +00001914- SystemACE Support:
1915 CONFIG_SYSTEMACE
1916
1917 Adding this option adds support for Xilinx SystemACE
1918 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001919 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001920 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001921
1922 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001923 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001924
1925 When SystemACE support is added, the "ace" device type
1926 becomes available to the fat commands, i.e. fatls.
1927
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001928- TFTP Fixed UDP Port:
1929 CONFIG_TFTP_PORT
1930
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001931 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001932 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001933 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001934 number generator is used.
1935
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001936 Also, the environment variable tftpdstp is used to supply
1937 the TFTP UDP destination port value. If tftpdstp isn't
1938 defined, the normal port 69 is used.
1939
1940 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001941 blindly start the TFTP transfer using the pre-configured
1942 target IP address and UDP port. This has the effect of
1943 "punching through" the (Windows XP) firewall, allowing
1944 the remainder of the TFTP transfer to proceed normally.
1945 A better solution is to properly configure the firewall,
1946 but sometimes that is not allowed.
1947
wdenka8c7c702003-12-06 19:49:23 +00001948- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001949 CONFIG_SHOW_BOOT_PROGRESS
1950
wdenk43d96162003-03-06 00:02:04 +00001951 Defining this option allows to add some board-
1952 specific code (calling a user-provided function
1953 "show_boot_progress(int)") that enables you to show
1954 the system's boot progress on some display (for
1955 example, some LED's) on your board. At the moment,
1956 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001957
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001958Legacy uImage format:
1959
wdenkc6097192002-11-03 00:24:07 +00001960 Arg Where When
1961 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001962 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001963 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001964 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001965 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001966 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001967 4 common/cmd_bootm.c Image data has correct checksum
1968 -4 common/cmd_bootm.c Image is for unsupported architecture
1969 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001970 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001971 6 common/cmd_bootm.c Image Type check OK
1972 -6 common/cmd_bootm.c gunzip uncompression error
1973 -7 common/cmd_bootm.c Unimplemented compression type
1974 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001975 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001976 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001977
1978 9 common/image.c Start initial ramdisk verification
1979 -10 common/image.c Ramdisk header has bad magic number
1980 -11 common/image.c Ramdisk header has bad checksum
1981 10 common/image.c Ramdisk header is OK
1982 -12 common/image.c Ramdisk data has bad checksum
1983 11 common/image.c Ramdisk data has correct checksum
1984 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001985 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001986 13 common/image.c Start multifile image verification
1987 14 common/image.c No initial ramdisk, no multifile, continue.
1988
Peter Tyserea0364f2010-04-12 22:28:04 -05001989 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001990
Stefan Roesea47a12b2010-04-15 16:07:28 +02001991 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00001992 -31 post/post.c POST test failed, detected by post_output_backlog()
1993 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001994
Heiko Schocher566a4942007-06-22 19:11:54 +02001995 34 common/cmd_doc.c before loading a Image from a DOC device
1996 -35 common/cmd_doc.c Bad usage of "doc" command
1997 35 common/cmd_doc.c correct usage of "doc" command
1998 -36 common/cmd_doc.c No boot device
1999 36 common/cmd_doc.c correct boot device
2000 -37 common/cmd_doc.c Unknown Chip ID on boot device
2001 37 common/cmd_doc.c correct chip ID found, device available
2002 -38 common/cmd_doc.c Read Error on boot device
2003 38 common/cmd_doc.c reading Image header from DOC device OK
2004 -39 common/cmd_doc.c Image header has bad magic number
2005 39 common/cmd_doc.c Image header has correct magic number
2006 -40 common/cmd_doc.c Error reading Image from DOC device
2007 40 common/cmd_doc.c Image header has correct magic number
2008 41 common/cmd_ide.c before loading a Image from a IDE device
2009 -42 common/cmd_ide.c Bad usage of "ide" command
2010 42 common/cmd_ide.c correct usage of "ide" command
2011 -43 common/cmd_ide.c No boot device
2012 43 common/cmd_ide.c boot device found
2013 -44 common/cmd_ide.c Device not available
2014 44 common/cmd_ide.c Device available
2015 -45 common/cmd_ide.c wrong partition selected
2016 45 common/cmd_ide.c partition selected
2017 -46 common/cmd_ide.c Unknown partition table
2018 46 common/cmd_ide.c valid partition table found
2019 -47 common/cmd_ide.c Invalid partition type
2020 47 common/cmd_ide.c correct partition type
2021 -48 common/cmd_ide.c Error reading Image Header on boot device
2022 48 common/cmd_ide.c reading Image Header from IDE device OK
2023 -49 common/cmd_ide.c Image header has bad magic number
2024 49 common/cmd_ide.c Image header has correct magic number
2025 -50 common/cmd_ide.c Image header has bad checksum
2026 50 common/cmd_ide.c Image header has correct checksum
2027 -51 common/cmd_ide.c Error reading Image from IDE device
2028 51 common/cmd_ide.c reading Image from IDE device OK
2029 52 common/cmd_nand.c before loading a Image from a NAND device
2030 -53 common/cmd_nand.c Bad usage of "nand" command
2031 53 common/cmd_nand.c correct usage of "nand" command
2032 -54 common/cmd_nand.c No boot device
2033 54 common/cmd_nand.c boot device found
2034 -55 common/cmd_nand.c Unknown Chip ID on boot device
2035 55 common/cmd_nand.c correct chip ID found, device available
2036 -56 common/cmd_nand.c Error reading Image Header on boot device
2037 56 common/cmd_nand.c reading Image Header from NAND device OK
2038 -57 common/cmd_nand.c Image header has bad magic number
2039 57 common/cmd_nand.c Image header has correct magic number
2040 -58 common/cmd_nand.c Error reading Image from NAND device
2041 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002042
Heiko Schocher566a4942007-06-22 19:11:54 +02002043 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002044
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002045 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002046 -64 net/eth.c no Ethernet found.
2047 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002048
Heiko Schocher566a4942007-06-22 19:11:54 +02002049 -80 common/cmd_net.c usage wrong
2050 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002051 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002052 81 common/cmd_net.c NetLoop() back without error
2053 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2054 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002055 83 common/cmd_net.c running "source" command
2056 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002057 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002058
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002059FIT uImage format:
2060
2061 Arg Where When
2062 100 common/cmd_bootm.c Kernel FIT Image has correct format
2063 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2064 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2065 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2066 102 common/cmd_bootm.c Kernel unit name specified
2067 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002068 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002069 104 common/cmd_bootm.c Got kernel subimage node offset
2070 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2071 105 common/cmd_bootm.c Kernel subimage hash verification OK
2072 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2073 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002074 -106 common/cmd_bootm.c Kernel subimage has wrong type
2075 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002076 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2077 108 common/cmd_bootm.c Got kernel subimage data/size
2078 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2079 -109 common/cmd_bootm.c Can't get kernel subimage type
2080 -110 common/cmd_bootm.c Can't get kernel subimage comp
2081 -111 common/cmd_bootm.c Can't get kernel subimage os
2082 -112 common/cmd_bootm.c Can't get kernel subimage load address
2083 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2084
2085 120 common/image.c Start initial ramdisk verification
2086 -120 common/image.c Ramdisk FIT image has incorrect format
2087 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002088 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002089 -122 common/image.c Can't get configuration for ramdisk subimage
2090 123 common/image.c Ramdisk unit name specified
2091 -124 common/image.c Can't get ramdisk subimage node offset
2092 125 common/image.c Got ramdisk subimage node offset
2093 -125 common/image.c Ramdisk subimage hash verification failed
2094 126 common/image.c Ramdisk subimage hash verification OK
2095 -126 common/image.c Ramdisk subimage for unsupported architecture
2096 127 common/image.c Architecture check OK
2097 -127 common/image.c Can't get ramdisk subimage data/size
2098 128 common/image.c Got ramdisk subimage data/size
2099 129 common/image.c Can't get ramdisk load address
2100 -129 common/image.c Got ramdisk load address
2101
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002102 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002103 131 common/cmd_doc.c FIT image format OK
2104
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002105 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002106 141 common/cmd_ide.c FIT image format OK
2107
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002108 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002109 151 common/cmd_nand.c FIT image format OK
2110
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002111- Automatic software updates via TFTP server
2112 CONFIG_UPDATE_TFTP
2113 CONFIG_UPDATE_TFTP_CNT_MAX
2114 CONFIG_UPDATE_TFTP_MSEC_MAX
2115
2116 These options enable and control the auto-update feature;
2117 for a more detailed description refer to doc/README.update.
2118
2119- MTD Support (mtdparts command, UBI support)
2120 CONFIG_MTD_DEVICE
2121
2122 Adds the MTD device infrastructure from the Linux kernel.
2123 Needed for mtdparts command support.
2124
2125 CONFIG_MTD_PARTITIONS
2126
2127 Adds the MTD partitioning infrastructure from the Linux
2128 kernel. Needed for UBI support.
2129
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002130
wdenkc6097192002-11-03 00:24:07 +00002131Modem Support:
2132--------------
2133
wdenk85ec0bc2003-03-31 16:34:49 +00002134[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002135
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002136- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002137 CONFIG_MODEM_SUPPORT
2138
2139- RTS/CTS Flow control enable:
2140 CONFIG_HWFLOW
2141
2142- Modem debug support:
2143 CONFIG_MODEM_SUPPORT_DEBUG
2144
wdenk43d96162003-03-06 00:02:04 +00002145 Enables debugging stuff (char screen[1024], dbg())
2146 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002147
wdenka8c7c702003-12-06 19:49:23 +00002148- Interrupt support (PPC):
2149
wdenkd4ca31c2004-01-02 14:00:00 +00002150 There are common interrupt_init() and timer_interrupt()
2151 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002152 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002153 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002154 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002155 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002156 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002157 specific handling. If board has watchdog / status_led
2158 / other_activity_monitor it works automatically from
2159 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002160
wdenkc6097192002-11-03 00:24:07 +00002161- General:
2162
wdenk43d96162003-03-06 00:02:04 +00002163 In the target system modem support is enabled when a
2164 specific key (key combination) is pressed during
2165 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002166 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002167 board_init(). Currently key_pressed() is a dummy
2168 function, returning 1 and thus enabling modem
2169 initialization.
wdenkc6097192002-11-03 00:24:07 +00002170
wdenk43d96162003-03-06 00:02:04 +00002171 If there are no modem init strings in the
2172 environment, U-Boot proceed to autoboot; the
2173 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002174 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002175
2176 See also: doc/README.Modem
2177
2178
wdenkc6097192002-11-03 00:24:07 +00002179Configuration Settings:
2180-----------------------
2181
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002182- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002183 undefine this when you're short of memory.
2184
Peter Tyser2fb26042009-01-27 18:03:12 -06002185- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2186 width of the commands listed in the 'help' command output.
2187
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002188- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002189 prompt for user input.
2190
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002191- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002192
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002193- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002195- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002196
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002197- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002198 the application (usually a Linux kernel) when it is
2199 booted
2200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002201- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002202 List of legal baudrate settings for this board.
2203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002204- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002205 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002207- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002208 If the board specific function
2209 extern int overwrite_console (void);
2210 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002211 serial port, else the settings in the environment are used.
2212
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002213- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002214 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002216- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002217 Enable overwrite of previous console environment settings.
2218
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002219- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002220 Begin and End addresses of the area used by the
2221 simple memory test.
2222
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002223- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002224 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002225
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002226- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002227 Scratch address used by the alternate memory test
2228 You only need to set this if address zero isn't writeable
2229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002230- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2231 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002232 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002233 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002234 fixing up gd->ram_size the Linux kernel should gets passed
2235 the now "corrected" memory size and won't touch it either.
2236 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002237 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002238 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002239 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002240
2241 This option can be used as a workaround for the 440EPx/GRx
2242 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2243 be touched.
2244
2245 WARNING: Please make sure that this value is a multiple of
2246 the Linux page size (normally 4k). If this is not the case,
2247 then the end address of the Linux memory will be located at a
2248 non page size aligned address and this could cause major
2249 problems.
2250
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002251- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002252 Default load address for network file downloads
2253
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002254- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002255 Enable temporary baudrate change while serial download
2256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002257- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002258 Physical start address of SDRAM. _Must_ be 0 here.
2259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002260- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002261 Physical start address of Motherboard I/O (if using a
2262 Cogent motherboard)
2263
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002264- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002265 Physical start address of Flash memory.
2266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002267- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002268 Physical start address of boot monitor code (set by
2269 make config files to be same as the text base address
2270 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002271 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002272
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002273- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002274 Size of memory reserved for monitor code, used to
2275 determine _at_compile_time_ (!) if the environment is
2276 embedded within the U-Boot image, or in a separate
2277 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002278
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002279- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002280 Size of DRAM reserved for malloc() use.
2281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002282- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002283 Normally compressed uImages are limited to an
2284 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002285 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002286 to adjust this setting to your needs.
2287
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002288- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002289 Maximum size of memory mapped by the startup code of
2290 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002291 the Linux kernel (bd_info, boot arguments, FDT blob if
2292 used) must be put below this limit, unless "bootm_low"
2293 enviroment variable is defined and non-zero. In such case
2294 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002295 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002297- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002298 Max number of Flash memory banks
2299
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002300- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002301 Max number of sectors on a Flash chip
2302
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002303- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002304 Timeout for Flash erase operations (in ms)
2305
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002306- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002307 Timeout for Flash write operations (in ms)
2308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002309- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002310 Timeout for Flash set sector lock bit operation (in ms)
2311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002312- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002313 Timeout for Flash clear lock bits operation (in ms)
2314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002315- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002316 If defined, hardware flash sectors protection is used
2317 instead of U-Boot software protection.
2318
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002319- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002320
2321 Enable TFTP transfers directly to flash memory;
2322 without this option such a download has to be
2323 performed in two steps: (1) download to RAM, and (2)
2324 copy from RAM to flash.
2325
2326 The two-step approach is usually more reliable, since
2327 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002328 the flash, but in some situations (when system RAM is
2329 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002330 downloaded image) this option may be very useful.
2331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002332- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002333 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002334 common flash structure for storing flash geometry.
2335
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002336- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002337 This option also enables the building of the cfi_flash driver
2338 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002339
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002340- CONFIG_FLASH_CFI_MTD
2341 This option enables the building of the cfi_mtd driver
2342 in the drivers directory. The driver exports CFI flash
2343 to the MTD layer.
2344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002345- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002346 Use buffered writes to flash.
2347
2348- CONFIG_FLASH_SPANSION_S29WS_N
2349 s29ws-n MirrorBit flash has non-standard addresses for buffered
2350 write commands.
2351
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002352- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002353 If this option is defined, the common CFI flash doesn't
2354 print it's warning upon not recognized FLASH banks. This
2355 is useful, if some of the configured banks are only
2356 optionally available.
2357
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002358- CONFIG_FLASH_SHOW_PROGRESS
2359 If defined (must be an integer), print out countdown
2360 digits and dots. Recommended value: 45 (9..1) for 80
2361 column displays, 15 (3..1) for 40 column displays.
2362
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002363- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002364 Defines the number of Ethernet receive buffers. On some
2365 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002366 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2367 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002368 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002369 Defaults to 4 if not defined.
2370
wdenkc6097192002-11-03 00:24:07 +00002371The following definitions that deal with the placement and management
2372of environment data (variable area); in general, we support the
2373following configurations:
2374
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002375- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002376
2377 Define this if the environment is in flash memory.
2378
2379 a) The environment occupies one whole flash sector, which is
2380 "embedded" in the text segment with the U-Boot code. This
2381 happens usually with "bottom boot sector" or "top boot
2382 sector" type flash chips, which have several smaller
2383 sectors at the start or the end. For instance, such a
2384 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2385 such a case you would place the environment in one of the
2386 4 kB sectors - with U-Boot code before and after it. With
2387 "top boot sector" type flash chips, you would put the
2388 environment in one of the last sectors, leaving a gap
2389 between U-Boot and the environment.
2390
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002391 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002392
2393 Offset of environment data (variable area) to the
2394 beginning of flash memory; for instance, with bottom boot
2395 type flash chips the second sector can be used: the offset
2396 for this sector is given here.
2397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002398 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002399
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002400 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002401
2402 This is just another way to specify the start address of
2403 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002404 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002405
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002406 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002407
2408 Size of the sector containing the environment.
2409
2410
2411 b) Sometimes flash chips have few, equal sized, BIG sectors.
2412 In such a case you don't want to spend a whole sector for
2413 the environment.
2414
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002415 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002416
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002417 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002418 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002419 of this flash sector for the environment. This saves
2420 memory for the RAM copy of the environment.
2421
2422 It may also save flash memory if you decide to use this
2423 when your environment is "embedded" within U-Boot code,
2424 since then the remainder of the flash sector could be used
2425 for U-Boot code. It should be pointed out that this is
2426 STRONGLY DISCOURAGED from a robustness point of view:
2427 updating the environment in flash makes it always
2428 necessary to erase the WHOLE sector. If something goes
2429 wrong before the contents has been restored from a copy in
2430 RAM, your target system will be dead.
2431
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002432 - CONFIG_ENV_ADDR_REDUND
2433 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002434
wdenk43d96162003-03-06 00:02:04 +00002435 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002436 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002437 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002438 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002439
2440BE CAREFUL! Any changes to the flash layout, and some changes to the
2441source code will make it necessary to adapt <board>/u-boot.lds*
2442accordingly!
2443
2444
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002445- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002446
2447 Define this if you have some non-volatile memory device
2448 (NVRAM, battery buffered SRAM) which you want to use for the
2449 environment.
2450
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002451 - CONFIG_ENV_ADDR:
2452 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002453
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002454 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002455 want to use for environment. It is assumed that this memory
2456 can just be read and written to, without any special
2457 provision.
2458
2459BE CAREFUL! The first access to the environment happens quite early
2460in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002461console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002462U-Boot will hang.
2463
2464Please note that even with NVRAM we still use a copy of the
2465environment in RAM: we could work on NVRAM directly, but we want to
2466keep settings there always unmodified except somebody uses "saveenv"
2467to save the current settings.
2468
2469
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002470- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002471
2472 Use this if you have an EEPROM or similar serial access
2473 device and a driver for it.
2474
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002475 - CONFIG_ENV_OFFSET:
2476 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002477
2478 These two #defines specify the offset and size of the
2479 environment area within the total memory of your EEPROM.
2480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002481 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002482 If defined, specified the chip address of the EEPROM device.
2483 The default address is zero.
2484
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002485 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002486 If defined, the number of bits used to address bytes in a
2487 single page in the EEPROM device. A 64 byte page, for example
2488 would require six bits.
2489
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002490 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002491 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002492 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002493
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002494 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002495 The length in bytes of the EEPROM memory array address. Note
2496 that this is NOT the chip address length!
2497
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002498 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002499 EEPROM chips that implement "address overflow" are ones
2500 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2501 address and the extra bits end up in the "chip address" bit
2502 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2503 byte chips.
2504
2505 Note that we consider the length of the address field to
2506 still be one byte because the extra address bits are hidden
2507 in the chip address.
2508
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002509 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002510 The size in bytes of the EEPROM device.
2511
Heiko Schocher548738b2010-01-07 08:55:40 +01002512 - CONFIG_ENV_EEPROM_IS_ON_I2C
2513 define this, if you have I2C and SPI activated, and your
2514 EEPROM, which holds the environment, is on the I2C bus.
2515
2516 - CONFIG_I2C_ENV_EEPROM_BUS
2517 if you have an Environment on an EEPROM reached over
2518 I2C muxes, you can define here, how to reach this
2519 EEPROM. For example:
2520
Wolfgang Denka9046b92010-06-13 17:48:15 +02002521 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002522
2523 EEPROM which holds the environment, is reached over
2524 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002525
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002526- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002527
wdenkd4ca31c2004-01-02 14:00:00 +00002528 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002529 want to use for the environment.
2530
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002531 - CONFIG_ENV_OFFSET:
2532 - CONFIG_ENV_ADDR:
2533 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002534
2535 These three #defines specify the offset and size of the
2536 environment area within the total memory of your DataFlash placed
2537 at the specified address.
2538
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002539- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002540
2541 Define this if you have a NAND device which you want to use
2542 for the environment.
2543
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002544 - CONFIG_ENV_OFFSET:
2545 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002546
2547 These two #defines specify the offset and size of the environment
2548 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00002549
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002550 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002551
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002552 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002553 size used to hold a redundant copy of the environment data,
2554 so that there is a valid backup copy in case there is a
2555 power failure during a "saveenv" operation.
2556
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002557 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2558 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002559 the NAND devices block size.
2560
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002561- CONFIG_NAND_ENV_DST
2562
2563 Defines address in RAM to which the nand_spl code should copy the
2564 environment. If redundant environment is used, it will be copied to
2565 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2566
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002567- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002568
2569 Defines offset to the initial SPI buffer area in DPRAM. The
2570 area is used at an early stage (ROM part) if the environment
2571 is configured to reside in the SPI EEPROM: We need a 520 byte
2572 scratch DPRAM area. It is used between the two initialization
2573 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2574 to be a good choice since it makes it far enough from the
2575 start of the data area as well as from the stack pointer.
2576
Bruce Adlere881cb52007-11-02 13:15:42 -07002577Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002578has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002579created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002580until then to read environment variables.
2581
wdenk85ec0bc2003-03-31 16:34:49 +00002582The environment is protected by a CRC32 checksum. Before the monitor
2583is relocated into RAM, as a result of a bad CRC you will be working
2584with the compiled-in default environment - *silently*!!! [This is
2585necessary, because the first environment variable we need is the
2586"baudrate" setting for the console - if we have a bad CRC, we don't
2587have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002588
2589Note: once the monitor has been relocated, then it will complain if
2590the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002591use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002592
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002593- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002594 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002596 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002597 also needs to be defined.
2598
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002599- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002600 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002601
Ron Madridf5675aa2009-02-18 14:30:44 -08002602- CONFIG_NS16550_MIN_FUNCTIONS:
2603 Define this if you desire to only have use of the NS16550_init
2604 and NS16550_putc functions for the serial driver located at
2605 drivers/serial/ns16550.c. This option is useful for saving
2606 space for already greatly restricted images, including but not
2607 limited to NAND_SPL configurations.
2608
wdenkc6097192002-11-03 00:24:07 +00002609Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002610---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002611
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002612- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002613 Cache Line Size of the CPU.
2614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002615- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002616 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002617
wdenk42d1f032003-10-15 23:53:47 +00002618 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2619 and RPXsuper) to be able to adjust the position of
2620 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002621
wdenk7f6c2cb2002-11-10 22:06:23 +00002622- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002623 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002624
2625 the default drive number (default value 0)
2626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002627 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002628
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002629 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002630 (default value 1)
2631
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002632 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002633
wdenk43d96162003-03-06 00:02:04 +00002634 defines the offset of register from address. It
2635 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002636 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002637
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002638 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2639 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002640 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002641
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002642 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002643 fdc_hw_init() is called at the beginning of the FDC
2644 setup. fdc_hw_init() must be provided by the board
2645 source code. It is used to make hardware dependant
2646 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002647
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002648- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002649 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002650 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002651
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002652- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002653
wdenk7152b1d2003-09-05 23:19:14 +00002654 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002655 initial data and stack; please note that this must be
2656 writable memory that is working WITHOUT special
2657 initialization, i. e. you CANNOT use normal RAM which
2658 will become available only after programming the
2659 memory controller and running certain initialization
2660 sequences.
2661
2662 U-Boot uses the following memory types:
2663 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2664 - MPC824X: data cache
2665 - PPC4xx: data cache
2666
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002667- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002668
2669 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002670 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2671 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002672 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002673 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2674 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2675 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2676 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002677
2678 Note:
2679 On the MPC824X (or other systems that use the data
2680 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002681 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002682 point to an otherwise UNUSED address space between
2683 the top of RAM and the start of the PCI space.
2684
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002685- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002686
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002687- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002688
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002689- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002690
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002691- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002692
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002693- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002694
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002695- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002696
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002697- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002698 SDRAM timing
2699
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002700- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002701 periodic timer for refresh
2702
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002703- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002704
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002705- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2706 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2707 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2708 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002709 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2710
2711- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002712 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2713 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002714 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2715
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002716- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2717 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002718 Machine Mode Register and Memory Periodic Timer
2719 Prescaler definitions (SDRAM timing)
2720
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002721- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002722 enable I2C microcode relocation patch (MPC8xx);
2723 define relocation offset in DPRAM [DSP2]
2724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002726 enable SMC microcode relocation patch (MPC8xx);
2727 define relocation offset in DPRAM [SMC1]
2728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002729- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002730 enable SPI microcode relocation patch (MPC8xx);
2731 define relocation offset in DPRAM [SCC4]
2732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002734 Use OSCM clock mode on MBX8xx board. Be careful,
2735 wrong setting might damage your board. Read
2736 doc/README.MBX before setting this variable!
2737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002738- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002739 Offset of the bootmode word in DPRAM used by post
2740 (Power On Self Tests). This definition overrides
2741 #define'd default value in commproc.h resp.
2742 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002744- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2745 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2746 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2747 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2748 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2749 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2750 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2751 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002752 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002753
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002754- CONFIG_PCI_DISABLE_PCIE:
2755 Disable PCI-Express on systems where it is supported but not
2756 required.
2757
Ben Warrenbb99ad62006-09-07 16:50:54 -04002758- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002759 Get DDR timing information from an I2C EEPROM. Common
2760 with pluggable memory modules such as SODIMMs
2761
Ben Warrenbb99ad62006-09-07 16:50:54 -04002762 SPD_EEPROM_ADDRESS
2763 I2C address of the SPD EEPROM
2764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002765- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002766 If SPD EEPROM is on an I2C bus other than the first
2767 one, specify here. Note that the value must resolve
2768 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002769
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002770- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002771 Only for 83xx systems. If specified, then DDR should
2772 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002773
wdenkc26e4542004-04-18 10:13:26 +00002774- CONFIG_ETHER_ON_FEC[12]
2775 Define to enable FEC[12] on a 8xx series processor.
2776
2777- CONFIG_FEC[12]_PHY
2778 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002779 to the given FEC; i. e.
2780 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002781 means that the PHY with address 4 is connected to FEC1
2782
2783 When set to -1, means to probe for first available.
2784
2785- CONFIG_FEC[12]_PHY_NORXERR
2786 The PHY does not have a RXERR line (RMII only).
2787 (so program the FEC to ignore it).
2788
2789- CONFIG_RMII
2790 Enable RMII mode for all FECs.
2791 Note that this is a global option, we can't
2792 have one FEC in standard MII mode and another in RMII mode.
2793
wdenk5cf91d62004-04-23 20:32:05 +00002794- CONFIG_CRC32_VERIFY
2795 Add a verify option to the crc32 command.
2796 The syntax is:
2797
2798 => crc32 -v <address> <count> <crc32>
2799
2800 Where address/count indicate a memory area
2801 and crc32 is the correct crc32 which the
2802 area should have.
2803
wdenk56523f12004-07-11 17:40:54 +00002804- CONFIG_LOOPW
2805 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002806 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002807
stroese7b466642004-12-16 18:46:55 +00002808- CONFIG_MX_CYCLIC
2809 Add the "mdc" and "mwc" memory commands. These are cyclic
2810 "md/mw" commands.
2811 Examples:
2812
wdenkefe2a4d2004-12-16 21:44:03 +00002813 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002814 This command will print 4 bytes (10,11,12,13) each 500 ms.
2815
wdenkefe2a4d2004-12-16 21:44:03 +00002816 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002817 This command will write 12345678 to address 100 all 10 ms.
2818
wdenkefe2a4d2004-12-16 21:44:03 +00002819 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002820 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002821
wdenk8aa1a2d2005-04-04 12:44:11 +00002822- CONFIG_SKIP_LOWLEVEL_INIT
2823- CONFIG_SKIP_RELOCATE_UBOOT
2824
wdenk3c2b3d42005-04-05 23:32:21 +00002825 [ARM only] If these variables are defined, then
2826 certain low level initializations (like setting up
2827 the memory controller) are omitted and/or U-Boot does
2828 not relocate itself into RAM.
2829 Normally these variables MUST NOT be defined. The
2830 only exception is when U-Boot is loaded (to RAM) by
2831 some other boot loader or by a debugger which
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002832 performs these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002833
Magnus Liljadf812382009-06-13 20:50:00 +02002834- CONFIG_PRELOADER
2835
2836 Modifies the behaviour of start.S when compiling a loader
2837 that is executed before the actual U-Boot. E.g. when
2838 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002839
wdenkc6097192002-11-03 00:24:07 +00002840Building the Software:
2841======================
2842
Wolfgang Denk218ca722008-03-26 10:40:12 +01002843Building U-Boot has been tested in several native build environments
2844and in many different cross environments. Of course we cannot support
2845all possibly existing versions of cross development tools in all
2846(potentially obsolete) versions. In case of tool chain problems we
2847recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2848which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002849
Wolfgang Denk218ca722008-03-26 10:40:12 +01002850If you are not using a native environment, it is assumed that you
2851have GNU cross compiling tools available in your path. In this case,
2852you must set the environment variable CROSS_COMPILE in your shell.
2853Note that no changes to the Makefile or any other source files are
2854necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002855
Wolfgang Denk218ca722008-03-26 10:40:12 +01002856 $ CROSS_COMPILE=ppc_4xx-
2857 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002858
Peter Tyser2f8d3962009-03-13 18:54:51 -05002859Note: If you wish to generate Windows versions of the utilities in
2860 the tools directory you can use the MinGW toolchain
2861 (http://www.mingw.org). Set your HOST tools to the MinGW
2862 toolchain and execute 'make tools'. For example:
2863
2864 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2865
2866 Binaries such as tools/mkimage.exe will be created which can
2867 be executed on computers running Windows.
2868
Wolfgang Denk218ca722008-03-26 10:40:12 +01002869U-Boot is intended to be simple to build. After installing the
2870sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002871is done by typing:
2872
2873 make NAME_config
2874
Wolfgang Denk218ca722008-03-26 10:40:12 +01002875where "NAME_config" is the name of one of the existing configu-
2876rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002877
wdenk2729af92004-05-03 20:45:30 +00002878Note: for some board special configuration names may exist; check if
2879 additional information is available from the board vendor; for
2880 instance, the TQM823L systems are available without (standard)
2881 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002882 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002883
wdenk2729af92004-05-03 20:45:30 +00002884 make TQM823L_config
2885 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002886
wdenk2729af92004-05-03 20:45:30 +00002887 make TQM823L_LCD_config
2888 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002889
wdenk2729af92004-05-03 20:45:30 +00002890 etc.
wdenkc6097192002-11-03 00:24:07 +00002891
wdenkc6097192002-11-03 00:24:07 +00002892
wdenk2729af92004-05-03 20:45:30 +00002893Finally, type "make all", and you should get some working U-Boot
2894images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002895
wdenk2729af92004-05-03 20:45:30 +00002896- "u-boot.bin" is a raw binary image
2897- "u-boot" is an image in ELF binary format
2898- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002899
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002900By default the build is performed locally and the objects are saved
2901in the source directory. One of the two methods can be used to change
2902this behavior and build U-Boot to some external directory:
2903
29041. Add O= to the make command line invocations:
2905
2906 make O=/tmp/build distclean
2907 make O=/tmp/build NAME_config
2908 make O=/tmp/build all
2909
29102. Set environment variable BUILD_DIR to point to the desired location:
2911
2912 export BUILD_DIR=/tmp/build
2913 make distclean
2914 make NAME_config
2915 make all
2916
2917Note that the command line "O=" setting overrides the BUILD_DIR environment
2918variable.
2919
wdenkc6097192002-11-03 00:24:07 +00002920
wdenk2729af92004-05-03 20:45:30 +00002921Please be aware that the Makefiles assume you are using GNU make, so
2922for instance on NetBSD you might need to use "gmake" instead of
2923native "make".
wdenkc6097192002-11-03 00:24:07 +00002924
wdenkc6097192002-11-03 00:24:07 +00002925
wdenk2729af92004-05-03 20:45:30 +00002926If the system board that you have is not listed, then you will need
2927to port U-Boot to your hardware platform. To do this, follow these
2928steps:
wdenkc6097192002-11-03 00:24:07 +00002929
wdenk2729af92004-05-03 20:45:30 +000029301. Add a new configuration option for your board to the toplevel
2931 "Makefile" and to the "MAKEALL" script, using the existing
2932 entries as examples. Note that here and at many other places
2933 boards and other names are listed in alphabetical sort order. Please
2934 keep this order.
29352. Create a new directory to hold your board specific code. Add any
2936 files you need. In your board directory, you will need at least
2937 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
29383. Create a new configuration file "include/configs/<board>.h" for
2939 your board
29403. If you're porting U-Boot to a new CPU, then also create a new
2941 directory to hold your CPU specific code. Add any files you need.
29424. Run "make <board>_config" with your new name.
29435. Type "make", and you should get a working "u-boot.srec" file
2944 to be installed on your target system.
29456. Debug and solve any problems that might arise.
2946 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002947
wdenkc6097192002-11-03 00:24:07 +00002948
wdenk2729af92004-05-03 20:45:30 +00002949Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2950==============================================================
wdenkc6097192002-11-03 00:24:07 +00002951
Wolfgang Denk218ca722008-03-26 10:40:12 +01002952If you have modified U-Boot sources (for instance added a new board
2953or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002954provide feedback to the other developers. The feedback normally takes
2955the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01002956official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002957
Wolfgang Denk218ca722008-03-26 10:40:12 +01002958But before you submit such a patch, please verify that your modifi-
2959cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00002960the supported boards compile WITHOUT ANY compiler warnings. To do so,
2961just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01002962for ALL supported system. Be warned, this will take a while. You can
2963select which (cross) compiler to use by passing a `CROSS_COMPILE'
2964environment variable to the script, i. e. to use the ELDK cross tools
2965you can type
wdenkc6097192002-11-03 00:24:07 +00002966
wdenk2729af92004-05-03 20:45:30 +00002967 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002968
wdenk2729af92004-05-03 20:45:30 +00002969or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002970
wdenk2729af92004-05-03 20:45:30 +00002971 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002972
Wolfgang Denk218ca722008-03-26 10:40:12 +01002973When using the MAKEALL script, the default behaviour is to build
2974U-Boot in the source directory. This location can be changed by
2975setting the BUILD_DIR environment variable. Also, for each target
2976built, the MAKEALL script saves two log files (<target>.ERR and
2977<target>.MAKEALL) in the <source dir>/LOG directory. This default
2978location can be changed by setting the MAKEALL_LOGDIR environment
2979variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002980
2981 export BUILD_DIR=/tmp/build
2982 export MAKEALL_LOGDIR=/tmp/log
2983 CROSS_COMPILE=ppc_8xx- MAKEALL
2984
Wolfgang Denk218ca722008-03-26 10:40:12 +01002985With the above settings build objects are saved in the /tmp/build,
2986log files are saved in the /tmp/log and the source tree remains clean
2987during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002988
2989
wdenk2729af92004-05-03 20:45:30 +00002990See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002991
wdenkc6097192002-11-03 00:24:07 +00002992
wdenk2729af92004-05-03 20:45:30 +00002993Monitor Commands - Overview:
2994============================
wdenkc6097192002-11-03 00:24:07 +00002995
wdenk2729af92004-05-03 20:45:30 +00002996go - start application at address 'addr'
2997run - run commands in an environment variable
2998bootm - boot application image from memory
2999bootp - boot image via network using BootP/TFTP protocol
3000tftpboot- boot image via network using TFTP protocol
3001 and env variables "ipaddr" and "serverip"
3002 (and eventually "gatewayip")
3003rarpboot- boot image via network using RARP/TFTP protocol
3004diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3005loads - load S-Record file over serial line
3006loadb - load binary file over serial line (kermit mode)
3007md - memory display
3008mm - memory modify (auto-incrementing)
3009nm - memory modify (constant address)
3010mw - memory write (fill)
3011cp - memory copy
3012cmp - memory compare
3013crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003014i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003015sspi - SPI utility commands
3016base - print or set address offset
3017printenv- print environment variables
3018setenv - set environment variables
3019saveenv - save environment variables to persistent storage
3020protect - enable or disable FLASH write protection
3021erase - erase FLASH memory
3022flinfo - print FLASH memory information
3023bdinfo - print Board Info structure
3024iminfo - print header information for application image
3025coninfo - print console devices and informations
3026ide - IDE sub-system
3027loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003028loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003029mtest - simple RAM test
3030icache - enable or disable instruction cache
3031dcache - enable or disable data cache
3032reset - Perform RESET of the CPU
3033echo - echo args to console
3034version - print monitor version
3035help - print online help
3036? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003037
wdenkc6097192002-11-03 00:24:07 +00003038
wdenk2729af92004-05-03 20:45:30 +00003039Monitor Commands - Detailed Description:
3040========================================
wdenkc6097192002-11-03 00:24:07 +00003041
wdenk2729af92004-05-03 20:45:30 +00003042TODO.
wdenkc6097192002-11-03 00:24:07 +00003043
wdenk2729af92004-05-03 20:45:30 +00003044For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003045
3046
wdenk2729af92004-05-03 20:45:30 +00003047Environment Variables:
3048======================
wdenkc6097192002-11-03 00:24:07 +00003049
wdenk2729af92004-05-03 20:45:30 +00003050U-Boot supports user configuration using Environment Variables which
3051can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003052
wdenk2729af92004-05-03 20:45:30 +00003053Environment Variables are set using "setenv", printed using
3054"printenv", and saved to Flash using "saveenv". Using "setenv"
3055without a value can be used to delete a variable from the
3056environment. As long as you don't save the environment you are
3057working with an in-memory copy. In case the Flash area containing the
3058environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003059
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003060Some configuration options can be set using Environment Variables.
3061
3062List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003063
wdenk2729af92004-05-03 20:45:30 +00003064 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003065
wdenk2729af92004-05-03 20:45:30 +00003066 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003067
wdenk2729af92004-05-03 20:45:30 +00003068 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003069
wdenk2729af92004-05-03 20:45:30 +00003070 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003073
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003074 bootm_low - Memory range available for image processing in the bootm
3075 command can be restricted. This variable is given as
3076 a hexadecimal number and defines lowest address allowed
3077 for use by the bootm command. See also "bootm_size"
3078 environment variable. Address defined by "bootm_low" is
3079 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003080 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003081
3082 bootm_size - Memory range available for image processing in the bootm
3083 command can be restricted. This variable is given as
3084 a hexadecimal number and defines the size of the region
3085 allowed for use by the bootm command. See also "bootm_low"
3086 environment variable.
3087
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003088 updatefile - Location of the software update file on a TFTP server, used
3089 by the automatic software update feature. Please refer to
3090 documentation in doc/README.update for more details.
3091
wdenk2729af92004-05-03 20:45:30 +00003092 autoload - if set to "no" (any string beginning with 'n'),
3093 "bootp" will just load perform a lookup of the
3094 configuration from the BOOTP server, but not try to
3095 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003096
wdenk2729af92004-05-03 20:45:30 +00003097 autostart - if set to "yes", an image loaded using the "bootp",
3098 "rarpboot", "tftpboot" or "diskboot" commands will
3099 be automatically started (by internally calling
3100 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003101
wdenk2729af92004-05-03 20:45:30 +00003102 If set to "no", a standalone image passed to the
3103 "bootm" command will be copied to the load address
3104 (and eventually uncompressed), but NOT be started.
3105 This can be used to load and uncompress arbitrary
3106 data.
wdenkc6097192002-11-03 00:24:07 +00003107
wdenk17ea1172004-06-06 21:51:03 +00003108 i2cfast - (PPC405GP|PPC405EP only)
3109 if set to 'y' configures Linux I2C driver for fast
3110 mode (400kHZ). This environment variable is used in
3111 initialization code. So, for changes to be effective
3112 it must be saved and board must be reset.
3113
wdenk2729af92004-05-03 20:45:30 +00003114 initrd_high - restrict positioning of initrd images:
3115 If this variable is not set, initrd images will be
3116 copied to the highest possible address in RAM; this
3117 is usually what you want since it allows for
3118 maximum initrd size. If for some reason you want to
3119 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003120 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003121 variable to a value of "no" or "off" or "0".
3122 Alternatively, you can set it to a maximum upper
3123 address to use (U-Boot will still check that it
3124 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003125
wdenk2729af92004-05-03 20:45:30 +00003126 For instance, when you have a system with 16 MB
3127 RAM, and want to reserve 4 MB from use by Linux,
3128 you can do this by adding "mem=12M" to the value of
3129 the "bootargs" variable. However, now you must make
3130 sure that the initrd image is placed in the first
3131 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003132
wdenk2729af92004-05-03 20:45:30 +00003133 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003134
wdenk2729af92004-05-03 20:45:30 +00003135 If you set initrd_high to 0xFFFFFFFF, this is an
3136 indication to U-Boot that all addresses are legal
3137 for the Linux kernel, including addresses in flash
3138 memory. In this case U-Boot will NOT COPY the
3139 ramdisk at all. This may be useful to reduce the
3140 boot time on your system, but requires that this
3141 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003142
wdenk2729af92004-05-03 20:45:30 +00003143 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003144
wdenk2729af92004-05-03 20:45:30 +00003145 loadaddr - Default load address for commands like "bootp",
3146 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003147
wdenk2729af92004-05-03 20:45:30 +00003148 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003149
wdenk2729af92004-05-03 20:45:30 +00003150 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003151
wdenk2729af92004-05-03 20:45:30 +00003152 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003153
wdenk2729af92004-05-03 20:45:30 +00003154 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003155
wdenk2729af92004-05-03 20:45:30 +00003156 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003157
wdenk2729af92004-05-03 20:45:30 +00003158 ethprime - When CONFIG_NET_MULTI is enabled controls which
3159 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003160
wdenk2729af92004-05-03 20:45:30 +00003161 ethact - When CONFIG_NET_MULTI is enabled controls which
3162 interface is currently active. For example you
3163 can do the following
wdenkc6097192002-11-03 00:24:07 +00003164
Heiko Schocher48690d82010-07-20 17:45:02 +02003165 => setenv ethact FEC
3166 => ping 192.168.0.1 # traffic sent on FEC
3167 => setenv ethact SCC
3168 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003169
Matthias Fuchse1692572008-01-17 07:45:05 +01003170 ethrotate - When set to "no" U-Boot does not go through all
3171 available network interfaces.
3172 It just stays at the currently selected interface.
3173
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003174 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003175 either succeed or fail without retrying.
3176 When set to "once" the network operation will
3177 fail when all the available network interfaces
3178 are tried once without success.
3179 Useful on scripts which control the retry operation
3180 themselves.
wdenkc6097192002-11-03 00:24:07 +00003181
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003182 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003183
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003184 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003185 UDP source port.
3186
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003187 tftpdstport - If this is set, the value is used for TFTP's UDP
3188 destination port instead of the Well Know Port 69.
3189
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003190 tftpblocksize - Block size to use for TFTP transfers; if not set,
3191 we use the TFTP server's default block size
3192
3193 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3194 seconds, minimum value is 1000 = 1 second). Defines
3195 when a packet is considered to be lost so it has to
3196 be retransmitted. The default is 5000 = 5 seconds.
3197 Lowering this value may make downloads succeed
3198 faster in networks with high packet loss rates or
3199 with unreliable TFTP servers.
3200
3201 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003202 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003203 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003204
wdenk2729af92004-05-03 20:45:30 +00003205The following environment variables may be used and automatically
3206updated by the network boot commands ("bootp" and "rarpboot"),
3207depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003208
wdenk2729af92004-05-03 20:45:30 +00003209 bootfile - see above
3210 dnsip - IP address of your Domain Name Server
3211 dnsip2 - IP address of your secondary Domain Name Server
3212 gatewayip - IP address of the Gateway (Router) to use
3213 hostname - Target hostname
3214 ipaddr - see above
3215 netmask - Subnet Mask
3216 rootpath - Pathname of the root filesystem on the NFS server
3217 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003218
wdenka3d991b2004-04-15 21:48:45 +00003219
wdenk2729af92004-05-03 20:45:30 +00003220There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003221
wdenk2729af92004-05-03 20:45:30 +00003222 serial# - contains hardware identification information such
3223 as type string and/or serial number
3224 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003225
wdenk2729af92004-05-03 20:45:30 +00003226These variables can be set only once (usually during manufacturing of
3227the board). U-Boot refuses to delete or overwrite these variables
3228once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003229
3230
wdenk2729af92004-05-03 20:45:30 +00003231Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003232
wdenk2729af92004-05-03 20:45:30 +00003233 ver - Contains the U-Boot version string as printed
3234 with the "version" command. This variable is
3235 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003236
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk2729af92004-05-03 20:45:30 +00003238Please note that changes to some configuration parameters may take
3239only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003240
stroesec1551ea2003-04-04 15:53:41 +00003241
wdenk2729af92004-05-03 20:45:30 +00003242Command Line Parsing:
3243=====================
stroesec1551ea2003-04-04 15:53:41 +00003244
wdenk2729af92004-05-03 20:45:30 +00003245There are two different command line parsers available with U-Boot:
3246the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003247
wdenk2729af92004-05-03 20:45:30 +00003248Old, simple command line parser:
3249--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003250
wdenk2729af92004-05-03 20:45:30 +00003251- supports environment variables (through setenv / saveenv commands)
3252- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003253- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003254- special characters ('$', ';') can be escaped by prefixing with '\',
3255 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003256 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003257- You can also escape text by enclosing in single apostrophes, for example:
3258 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003259
wdenk2729af92004-05-03 20:45:30 +00003260Hush shell:
3261-----------
wdenkf07771c2003-05-28 08:06:31 +00003262
wdenk2729af92004-05-03 20:45:30 +00003263- similar to Bourne shell, with control structures like
3264 if...then...else...fi, for...do...done; while...do...done,
3265 until...do...done, ...
3266- supports environment ("global") variables (through setenv / saveenv
3267 commands) and local shell variables (through standard shell syntax
3268 "name=value"); only environment variables can be used with "run"
3269 command
wdenkf07771c2003-05-28 08:06:31 +00003270
wdenk2729af92004-05-03 20:45:30 +00003271General rules:
3272--------------
wdenkf07771c2003-05-28 08:06:31 +00003273
wdenk2729af92004-05-03 20:45:30 +00003274(1) If a command line (or an environment variable executed by a "run"
3275 command) contains several commands separated by semicolon, and
3276 one of these commands fails, then the remaining commands will be
3277 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003278
wdenk2729af92004-05-03 20:45:30 +00003279(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003280 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003281 command will cause "run" to terminate, i. e. the remaining
3282 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003283
wdenk2729af92004-05-03 20:45:30 +00003284Note for Redundant Ethernet Interfaces:
3285=======================================
wdenkf07771c2003-05-28 08:06:31 +00003286
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003287Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003288such configurations and is capable of automatic selection of a
3289"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003290
wdenk2729af92004-05-03 20:45:30 +00003291Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3292MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3293"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003294
wdenk2729af92004-05-03 20:45:30 +00003295If the network interface stores some valid MAC address (for instance
3296in SROM), this is used as default address if there is NO correspon-
3297ding setting in the environment; if the corresponding environment
3298variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003299
wdenk2729af92004-05-03 20:45:30 +00003300o If the SROM has a valid MAC address, and there is no address in the
3301 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303o If there is no valid address in the SROM, and a definition in the
3304 environment exists, then the value from the environment variable is
3305 used.
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307o If both the SROM and the environment contain a MAC address, and
3308 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003309
wdenk2729af92004-05-03 20:45:30 +00003310o If both the SROM and the environment contain a MAC address, and the
3311 addresses differ, the value from the environment is used and a
3312 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003313
wdenk2729af92004-05-03 20:45:30 +00003314o If neither SROM nor the environment contain a MAC address, an error
3315 is raised.
wdenkc6097192002-11-03 00:24:07 +00003316
Ben Warrenecee9322010-04-26 11:11:46 -07003317If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3318will be programmed into hardware as part of the initialization process. This
3319may be skipped by setting the appropriate 'ethmacskip' environment variable.
3320The naming convention is as follows:
3321"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003322
wdenk2729af92004-05-03 20:45:30 +00003323Image Formats:
3324==============
wdenkc6097192002-11-03 00:24:07 +00003325
Marian Balakowicz3310c542008-03-12 12:13:13 +01003326U-Boot is capable of booting (and performing other auxiliary operations on)
3327images in two formats:
3328
3329New uImage format (FIT)
3330-----------------------
3331
3332Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3333to Flattened Device Tree). It allows the use of images with multiple
3334components (several kernels, ramdisks, etc.), with contents protected by
3335SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3336
3337
3338Old uImage format
3339-----------------
3340
3341Old image format is based on binary files which can be basically anything,
3342preceded by a special header; see the definitions in include/image.h for
3343details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003344
wdenk2729af92004-05-03 20:45:30 +00003345* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3346 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003347 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3348 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3349 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003350* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003351 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3352 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003353* Compression Type (uncompressed, gzip, bzip2)
3354* Load Address
3355* Entry Point
3356* Image Name
3357* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003358
wdenk2729af92004-05-03 20:45:30 +00003359The header is marked by a special Magic Number, and both the header
3360and the data portions of the image are secured against corruption by
3361CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003362
wdenkc6097192002-11-03 00:24:07 +00003363
wdenk2729af92004-05-03 20:45:30 +00003364Linux Support:
3365==============
wdenkc6097192002-11-03 00:24:07 +00003366
wdenk2729af92004-05-03 20:45:30 +00003367Although U-Boot should support any OS or standalone application
3368easily, the main focus has always been on Linux during the design of
3369U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003370
wdenk2729af92004-05-03 20:45:30 +00003371U-Boot includes many features that so far have been part of some
3372special "boot loader" code within the Linux kernel. Also, any
3373"initrd" images to be used are no longer part of one big Linux image;
3374instead, kernel and "initrd" are separate images. This implementation
3375serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003376
wdenk2729af92004-05-03 20:45:30 +00003377- the same features can be used for other OS or standalone
3378 applications (for instance: using compressed images to reduce the
3379 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003380
wdenk2729af92004-05-03 20:45:30 +00003381- it becomes much easier to port new Linux kernel versions because
3382 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003383
wdenk2729af92004-05-03 20:45:30 +00003384- the same Linux kernel image can now be used with different "initrd"
3385 images; of course this also means that different kernel images can
3386 be run with the same "initrd". This makes testing easier (you don't
3387 have to build a new "zImage.initrd" Linux image when you just
3388 change a file in your "initrd"). Also, a field-upgrade of the
3389 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003390
wdenkc6097192002-11-03 00:24:07 +00003391
wdenk2729af92004-05-03 20:45:30 +00003392Linux HOWTO:
3393============
wdenkc6097192002-11-03 00:24:07 +00003394
wdenk2729af92004-05-03 20:45:30 +00003395Porting Linux to U-Boot based systems:
3396---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003397
wdenk2729af92004-05-03 20:45:30 +00003398U-Boot cannot save you from doing all the necessary modifications to
3399configure the Linux device drivers for use with your target hardware
3400(no, we don't intend to provide a full virtual machine interface to
3401Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003402
Stefan Roesea47a12b2010-04-15 16:07:28 +02003403But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003404
wdenk2729af92004-05-03 20:45:30 +00003405Just make sure your machine specific header file (for instance
3406include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003407Information structure as we define in include/asm-<arch>/u-boot.h,
3408and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003409as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003410
wdenkc6097192002-11-03 00:24:07 +00003411
wdenk2729af92004-05-03 20:45:30 +00003412Configuring the Linux kernel:
3413-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003414
wdenk2729af92004-05-03 20:45:30 +00003415No specific requirements for U-Boot. Make sure you have some root
3416device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003417
wdenkc6097192002-11-03 00:24:07 +00003418
wdenk2729af92004-05-03 20:45:30 +00003419Building a Linux Image:
3420-----------------------
wdenkc6097192002-11-03 00:24:07 +00003421
wdenk2729af92004-05-03 20:45:30 +00003422With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3423not used. If you use recent kernel source, a new build target
3424"uImage" will exist which automatically builds an image usable by
3425U-Boot. Most older kernels also have support for a "pImage" target,
3426which was introduced for our predecessor project PPCBoot and uses a
3427100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003428
wdenk2729af92004-05-03 20:45:30 +00003429Example:
wdenkc6097192002-11-03 00:24:07 +00003430
wdenk2729af92004-05-03 20:45:30 +00003431 make TQM850L_config
3432 make oldconfig
3433 make dep
3434 make uImage
wdenkc6097192002-11-03 00:24:07 +00003435
wdenk2729af92004-05-03 20:45:30 +00003436The "uImage" build target uses a special tool (in 'tools/mkimage') to
3437encapsulate a compressed Linux kernel image with header information,
3438CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003439
wdenk2729af92004-05-03 20:45:30 +00003440* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003441
wdenk2729af92004-05-03 20:45:30 +00003442* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003443
wdenk2729af92004-05-03 20:45:30 +00003444 ${CROSS_COMPILE}-objcopy -O binary \
3445 -R .note -R .comment \
3446 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003447
wdenk2729af92004-05-03 20:45:30 +00003448* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003449
wdenk2729af92004-05-03 20:45:30 +00003450 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003451
wdenk2729af92004-05-03 20:45:30 +00003452* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003453
wdenk2729af92004-05-03 20:45:30 +00003454 mkimage -A ppc -O linux -T kernel -C gzip \
3455 -a 0 -e 0 -n "Linux Kernel Image" \
3456 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003457
wdenk24ee89b2002-11-03 17:56:27 +00003458
wdenk2729af92004-05-03 20:45:30 +00003459The "mkimage" tool can also be used to create ramdisk images for use
3460with U-Boot, either separated from the Linux kernel image, or
3461combined into one file. "mkimage" encapsulates the images with a 64
3462byte header containing information about target architecture,
3463operating system, image type, compression method, entry points, time
3464stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003465
wdenk2729af92004-05-03 20:45:30 +00003466"mkimage" can be called in two ways: to verify existing images and
3467print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003468
wdenk2729af92004-05-03 20:45:30 +00003469In the first form (with "-l" option) mkimage lists the information
3470contained in the header of an existing U-Boot image; this includes
3471checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003472
wdenk2729af92004-05-03 20:45:30 +00003473 tools/mkimage -l image
3474 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003475
wdenk2729af92004-05-03 20:45:30 +00003476The second form (with "-d" option) is used to build a U-Boot image
3477from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003478
wdenk2729af92004-05-03 20:45:30 +00003479 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3480 -n name -d data_file image
3481 -A ==> set architecture to 'arch'
3482 -O ==> set operating system to 'os'
3483 -T ==> set image type to 'type'
3484 -C ==> set compression type 'comp'
3485 -a ==> set load address to 'addr' (hex)
3486 -e ==> set entry point to 'ep' (hex)
3487 -n ==> set image name to 'name'
3488 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003489
wdenk69459792004-05-29 16:53:29 +00003490Right now, all Linux kernels for PowerPC systems use the same load
3491address (0x00000000), but the entry point address depends on the
3492kernel version:
wdenkc6097192002-11-03 00:24:07 +00003493
wdenk2729af92004-05-03 20:45:30 +00003494- 2.2.x kernels have the entry point at 0x0000000C,
3495- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003496
wdenk2729af92004-05-03 20:45:30 +00003497So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003498
wdenk2729af92004-05-03 20:45:30 +00003499 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3500 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003501 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003502 > examples/uImage.TQM850L
3503 Image Name: 2.4.4 kernel for TQM850L
3504 Created: Wed Jul 19 02:34:59 2000
3505 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3506 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3507 Load Address: 0x00000000
3508 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003511
wdenk2729af92004-05-03 20:45:30 +00003512 -> tools/mkimage -l examples/uImage.TQM850L
3513 Image Name: 2.4.4 kernel for TQM850L
3514 Created: Wed Jul 19 02:34:59 2000
3515 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3516 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3517 Load Address: 0x00000000
3518 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003519
wdenk2729af92004-05-03 20:45:30 +00003520NOTE: for embedded systems where boot time is critical you can trade
3521speed for memory and install an UNCOMPRESSED image instead: this
3522needs more space in Flash, but boots much faster since it does not
3523need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003524
Stefan Roesea47a12b2010-04-15 16:07:28 +02003525 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003526 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3527 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003528 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003529 > examples/uImage.TQM850L-uncompressed
3530 Image Name: 2.4.4 kernel for TQM850L
3531 Created: Wed Jul 19 02:34:59 2000
3532 Image Type: PowerPC Linux Kernel Image (uncompressed)
3533 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3534 Load Address: 0x00000000
3535 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003536
wdenkc6097192002-11-03 00:24:07 +00003537
wdenk2729af92004-05-03 20:45:30 +00003538Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3539when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003540
wdenk2729af92004-05-03 20:45:30 +00003541 -> tools/mkimage -n 'Simple Ramdisk Image' \
3542 > -A ppc -O linux -T ramdisk -C gzip \
3543 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3544 Image Name: Simple Ramdisk Image
3545 Created: Wed Jan 12 14:01:50 2000
3546 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3547 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3548 Load Address: 0x00000000
3549 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003550
wdenkdb01a2e2004-04-15 23:14:49 +00003551
wdenk2729af92004-05-03 20:45:30 +00003552Installing a Linux Image:
3553-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003554
wdenk2729af92004-05-03 20:45:30 +00003555To downloading a U-Boot image over the serial (console) interface,
3556you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003557
wdenk2729af92004-05-03 20:45:30 +00003558 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003559
wdenk2729af92004-05-03 20:45:30 +00003560The 'objcopy' does not understand the information in the U-Boot
3561image header, so the resulting S-Record file will be relative to
3562address 0x00000000. To load it to a given address, you need to
3563specify the target address as 'offset' parameter with the 'loads'
3564command.
wdenkc6097192002-11-03 00:24:07 +00003565
wdenk2729af92004-05-03 20:45:30 +00003566Example: install the image to address 0x40100000 (which on the
3567TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003568
wdenk2729af92004-05-03 20:45:30 +00003569 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003570
wdenk2729af92004-05-03 20:45:30 +00003571 .......... done
3572 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003573
wdenk2729af92004-05-03 20:45:30 +00003574 => loads 40100000
3575 ## Ready for S-Record download ...
3576 ~>examples/image.srec
3577 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3578 ...
3579 15989 15990 15991 15992
3580 [file transfer complete]
3581 [connected]
3582 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003583
3584
wdenk2729af92004-05-03 20:45:30 +00003585You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003586this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003587corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591 ## Checking Image at 40100000 ...
3592 Image Name: 2.2.13 for initrd on TQM850L
3593 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3594 Data Size: 335725 Bytes = 327 kB = 0 MB
3595 Load Address: 00000000
3596 Entry Point: 0000000c
3597 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003598
3599
wdenk2729af92004-05-03 20:45:30 +00003600Boot Linux:
3601-----------
wdenkc6097192002-11-03 00:24:07 +00003602
wdenk2729af92004-05-03 20:45:30 +00003603The "bootm" command is used to boot an application that is stored in
3604memory (RAM or Flash). In case of a Linux kernel image, the contents
3605of the "bootargs" environment variable is passed to the kernel as
3606parameters. You can check and modify this variable using the
3607"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003608
3609
wdenk2729af92004-05-03 20:45:30 +00003610 => printenv bootargs
3611 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003612
wdenk2729af92004-05-03 20:45:30 +00003613 => 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 +00003614
wdenk2729af92004-05-03 20:45:30 +00003615 => printenv bootargs
3616 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 +00003617
wdenk2729af92004-05-03 20:45:30 +00003618 => bootm 40020000
3619 ## Booting Linux kernel at 40020000 ...
3620 Image Name: 2.2.13 for NFS on TQM850L
3621 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3622 Data Size: 381681 Bytes = 372 kB = 0 MB
3623 Load Address: 00000000
3624 Entry Point: 0000000c
3625 Verifying Checksum ... OK
3626 Uncompressing Kernel Image ... OK
3627 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
3628 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3629 time_init: decrementer frequency = 187500000/60
3630 Calibrating delay loop... 49.77 BogoMIPS
3631 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3632 ...
wdenkc6097192002-11-03 00:24:07 +00003633
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003634If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003635the memory addresses of both the kernel and the initrd image (PPBCOOT
3636format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003637
wdenk2729af92004-05-03 20:45:30 +00003638 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003639
wdenk2729af92004-05-03 20:45:30 +00003640 ## Checking Image at 40100000 ...
3641 Image Name: 2.2.13 for initrd on TQM850L
3642 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3643 Data Size: 335725 Bytes = 327 kB = 0 MB
3644 Load Address: 00000000
3645 Entry Point: 0000000c
3646 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003647
wdenk2729af92004-05-03 20:45:30 +00003648 ## Checking Image at 40200000 ...
3649 Image Name: Simple Ramdisk Image
3650 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3651 Data Size: 566530 Bytes = 553 kB = 0 MB
3652 Load Address: 00000000
3653 Entry Point: 00000000
3654 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003655
wdenk2729af92004-05-03 20:45:30 +00003656 => bootm 40100000 40200000
3657 ## Booting Linux kernel at 40100000 ...
3658 Image Name: 2.2.13 for initrd on TQM850L
3659 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3660 Data Size: 335725 Bytes = 327 kB = 0 MB
3661 Load Address: 00000000
3662 Entry Point: 0000000c
3663 Verifying Checksum ... OK
3664 Uncompressing Kernel Image ... OK
3665 ## Loading RAMDisk Image at 40200000 ...
3666 Image Name: Simple Ramdisk Image
3667 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3668 Data Size: 566530 Bytes = 553 kB = 0 MB
3669 Load Address: 00000000
3670 Entry Point: 00000000
3671 Verifying Checksum ... OK
3672 Loading Ramdisk ... OK
3673 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
3674 Boot arguments: root=/dev/ram
3675 time_init: decrementer frequency = 187500000/60
3676 Calibrating delay loop... 49.77 BogoMIPS
3677 ...
3678 RAMDISK: Compressed image found at block 0
3679 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003680
wdenk2729af92004-05-03 20:45:30 +00003681 bash#
wdenkc6097192002-11-03 00:24:07 +00003682
Matthew McClintock02677682006-06-28 10:41:37 -05003683Boot Linux and pass a flat device tree:
3684-----------
3685
3686First, U-Boot must be compiled with the appropriate defines. See the section
3687titled "Linux Kernel Interface" above for a more in depth explanation. The
3688following is an example of how to start a kernel and pass an updated
3689flat device tree:
3690
3691=> print oftaddr
3692oftaddr=0x300000
3693=> print oft
3694oft=oftrees/mpc8540ads.dtb
3695=> tftp $oftaddr $oft
3696Speed: 1000, full duplex
3697Using TSEC0 device
3698TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3699Filename 'oftrees/mpc8540ads.dtb'.
3700Load address: 0x300000
3701Loading: #
3702done
3703Bytes transferred = 4106 (100a hex)
3704=> tftp $loadaddr $bootfile
3705Speed: 1000, full duplex
3706Using TSEC0 device
3707TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3708Filename 'uImage'.
3709Load address: 0x200000
3710Loading:############
3711done
3712Bytes transferred = 1029407 (fb51f hex)
3713=> print loadaddr
3714loadaddr=200000
3715=> print oftaddr
3716oftaddr=0x300000
3717=> bootm $loadaddr - $oftaddr
3718## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003719 Image Name: Linux-2.6.17-dirty
3720 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3721 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003722 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003723 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003724 Verifying Checksum ... OK
3725 Uncompressing Kernel Image ... OK
3726Booting using flat device tree at 0x300000
3727Using MPC85xx ADS machine description
3728Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3729[snip]
3730
3731
wdenk2729af92004-05-03 20:45:30 +00003732More About U-Boot Image Types:
3733------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003734
wdenk2729af92004-05-03 20:45:30 +00003735U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003736
wdenk2729af92004-05-03 20:45:30 +00003737 "Standalone Programs" are directly runnable in the environment
3738 provided by U-Boot; it is expected that (if they behave
3739 well) you can continue to work in U-Boot after return from
3740 the Standalone Program.
3741 "OS Kernel Images" are usually images of some Embedded OS which
3742 will take over control completely. Usually these programs
3743 will install their own set of exception handlers, device
3744 drivers, set up the MMU, etc. - this means, that you cannot
3745 expect to re-enter U-Boot except by resetting the CPU.
3746 "RAMDisk Images" are more or less just data blocks, and their
3747 parameters (address, size) are passed to an OS kernel that is
3748 being started.
3749 "Multi-File Images" contain several images, typically an OS
3750 (Linux) kernel image and one or more data images like
3751 RAMDisks. This construct is useful for instance when you want
3752 to boot over the network using BOOTP etc., where the boot
3753 server provides just a single image file, but you want to get
3754 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003755
wdenk2729af92004-05-03 20:45:30 +00003756 "Multi-File Images" start with a list of image sizes, each
3757 image size (in bytes) specified by an "uint32_t" in network
3758 byte order. This list is terminated by an "(uint32_t)0".
3759 Immediately after the terminating 0 follow the images, one by
3760 one, all aligned on "uint32_t" boundaries (size rounded up to
3761 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003762
wdenk2729af92004-05-03 20:45:30 +00003763 "Firmware Images" are binary images containing firmware (like
3764 U-Boot or FPGA images) which usually will be programmed to
3765 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003766
wdenk2729af92004-05-03 20:45:30 +00003767 "Script files" are command sequences that will be executed by
3768 U-Boot's command interpreter; this feature is especially
3769 useful when you configure U-Boot to use a real shell (hush)
3770 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003771
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773Standalone HOWTO:
3774=================
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776One of the features of U-Boot is that you can dynamically load and
3777run "standalone" applications, which can use some resources of
3778U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003779
wdenk2729af92004-05-03 20:45:30 +00003780Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk2729af92004-05-03 20:45:30 +00003782"Hello World" Demo:
3783-------------------
wdenkc6097192002-11-03 00:24:07 +00003784
wdenk2729af92004-05-03 20:45:30 +00003785'examples/hello_world.c' contains a small "Hello World" Demo
3786application; it is automatically compiled when you build U-Boot.
3787It's configured to run at address 0x00040004, so you can play with it
3788like that:
wdenkc6097192002-11-03 00:24:07 +00003789
wdenk2729af92004-05-03 20:45:30 +00003790 => loads
3791 ## Ready for S-Record download ...
3792 ~>examples/hello_world.srec
3793 1 2 3 4 5 6 7 8 9 10 11 ...
3794 [file transfer complete]
3795 [connected]
3796 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003797
wdenk2729af92004-05-03 20:45:30 +00003798 => go 40004 Hello World! This is a test.
3799 ## Starting application at 0x00040004 ...
3800 Hello World
3801 argc = 7
3802 argv[0] = "40004"
3803 argv[1] = "Hello"
3804 argv[2] = "World!"
3805 argv[3] = "This"
3806 argv[4] = "is"
3807 argv[5] = "a"
3808 argv[6] = "test."
3809 argv[7] = "<NULL>"
3810 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003811
wdenk2729af92004-05-03 20:45:30 +00003812 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003813
wdenk2729af92004-05-03 20:45:30 +00003814Another example, which demonstrates how to register a CPM interrupt
3815handler with the U-Boot code, can be found in 'examples/timer.c'.
3816Here, a CPM timer is set up to generate an interrupt every second.
3817The interrupt service routine is trivial, just printing a '.'
3818character, but this is just a demo program. The application can be
3819controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk2729af92004-05-03 20:45:30 +00003821 ? - print current values og the CPM Timer registers
3822 b - enable interrupts and start timer
3823 e - stop timer and disable interrupts
3824 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk2729af92004-05-03 20:45:30 +00003826 => loads
3827 ## Ready for S-Record download ...
3828 ~>examples/timer.srec
3829 1 2 3 4 5 6 7 8 9 10 11 ...
3830 [file transfer complete]
3831 [connected]
3832 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003833
wdenk2729af92004-05-03 20:45:30 +00003834 => go 40004
3835 ## Starting application at 0x00040004 ...
3836 TIMERS=0xfff00980
3837 Using timer 1
3838 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840Hit 'b':
3841 [q, b, e, ?] Set interval 1000000 us
3842 Enabling timer
3843Hit '?':
3844 [q, b, e, ?] ........
3845 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3846Hit '?':
3847 [q, b, e, ?] .
3848 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3849Hit '?':
3850 [q, b, e, ?] .
3851 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3852Hit '?':
3853 [q, b, e, ?] .
3854 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3855Hit 'e':
3856 [q, b, e, ?] ...Stopping timer
3857Hit 'q':
3858 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003859
3860
wdenk2729af92004-05-03 20:45:30 +00003861Minicom warning:
3862================
wdenk85ec0bc2003-03-31 16:34:49 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864Over time, many people have reported problems when trying to use the
3865"minicom" terminal emulation program for serial download. I (wd)
3866consider minicom to be broken, and recommend not to use it. Under
3867Unix, I recommend to use C-Kermit for general purpose use (and
3868especially for kermit binary protocol download ("loadb" command), and
3869use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003870
wdenk2729af92004-05-03 20:45:30 +00003871Nevertheless, if you absolutely want to use it try adding this
3872configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874 Name Program Name U/D FullScr IO-Red. Multi
3875 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3876 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003877
3878
wdenk2729af92004-05-03 20:45:30 +00003879NetBSD Notes:
3880=============
wdenkc6097192002-11-03 00:24:07 +00003881
wdenk2729af92004-05-03 20:45:30 +00003882Starting at version 0.9.2, U-Boot supports NetBSD both as host
3883(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk2729af92004-05-03 20:45:30 +00003885Building requires a cross environment; it is known to work on
3886NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3887need gmake since the Makefiles are not compatible with BSD make).
3888Note that the cross-powerpc package does not install include files;
3889attempting to build U-Boot will fail because <machine/ansi.h> is
3890missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk2729af92004-05-03 20:45:30 +00003892 # cd /usr/pkg/cross/powerpc-netbsd/include
3893 # mkdir powerpc
3894 # ln -s powerpc machine
3895 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3896 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003897
wdenk2729af92004-05-03 20:45:30 +00003898Native builds *don't* work due to incompatibilities between native
3899and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003900
wdenk2729af92004-05-03 20:45:30 +00003901Booting assumes that (the first part of) the image booted is a
3902stage-2 loader which in turn loads and then invokes the kernel
3903proper. Loader sources will eventually appear in the NetBSD source
3904tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003905meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003906
3907
wdenk2729af92004-05-03 20:45:30 +00003908Implementation Internals:
3909=========================
wdenkc6097192002-11-03 00:24:07 +00003910
wdenk2729af92004-05-03 20:45:30 +00003911The following is not intended to be a complete description of every
3912implementation detail. However, it should help to understand the
3913inner workings of U-Boot and make it easier to port it to custom
3914hardware.
wdenkc6097192002-11-03 00:24:07 +00003915
3916
wdenk2729af92004-05-03 20:45:30 +00003917Initial Stack, Global Data:
3918---------------------------
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk2729af92004-05-03 20:45:30 +00003920The implementation of U-Boot is complicated by the fact that U-Boot
3921starts running out of ROM (flash memory), usually without access to
3922system RAM (because the memory controller is not initialized yet).
3923This means that we don't have writable Data or BSS segments, and BSS
3924is not initialized as zero. To be able to get a C environment working
3925at all, we have to allocate at least a minimal stack. Implementation
3926options for this are defined and restricted by the CPU used: Some CPU
3927models provide on-chip memory (like the IMMR area on MPC8xx and
3928MPC826x processors), on others (parts of) the data cache can be
3929locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003930
Wolfgang Denk218ca722008-03-26 10:40:12 +01003931 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01003932 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00003933
wdenk2729af92004-05-03 20:45:30 +00003934 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3935 From: "Chris Hallinan" <clh@net1plus.com>
3936 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3937 ...
wdenk43d96162003-03-06 00:02:04 +00003938
wdenk2729af92004-05-03 20:45:30 +00003939 Correct me if I'm wrong, folks, but the way I understand it
3940 is this: Using DCACHE as initial RAM for Stack, etc, does not
3941 require any physical RAM backing up the cache. The cleverness
3942 is that the cache is being used as a temporary supply of
3943 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003944 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00003945 can see how this works by studying the cache architecture and
3946 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003947
wdenk2729af92004-05-03 20:45:30 +00003948 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3949 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003950 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00003951 option should work for you. Using CS 4 should be fine if your
3952 board designers haven't used it for something that would
3953 cause you grief during the initial boot! It is frequently not
3954 used.
wdenk43d96162003-03-06 00:02:04 +00003955
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003956 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00003957 with your processor/board/system design. The default value
3958 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003959 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003960 than your SDRAM module. If you have a 64MB SDRAM module, set
3961 it above 400_0000. Just make sure your board has no resources
3962 that are supposed to respond to that address! That code in
3963 start.S has been around a while and should work as is when
3964 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003965
wdenk2729af92004-05-03 20:45:30 +00003966 -Chris Hallinan
3967 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003968
wdenk2729af92004-05-03 20:45:30 +00003969It is essential to remember this, since it has some impact on the C
3970code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003971
wdenk2729af92004-05-03 20:45:30 +00003972* Initialized global data (data segment) is read-only. Do not attempt
3973 to write it.
wdenkc6097192002-11-03 00:24:07 +00003974
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003975* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00003976 as zero data - BSS segment) at all - this is undefined, initiali-
3977 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003978
wdenk2729af92004-05-03 20:45:30 +00003979* Stack space is very limited. Avoid big data buffers or things like
3980 that.
wdenkc6097192002-11-03 00:24:07 +00003981
wdenk2729af92004-05-03 20:45:30 +00003982Having only the stack as writable memory limits means we cannot use
3983normal global data to share information beween the code. But it
3984turned out that the implementation of U-Boot can be greatly
3985simplified by making a global data structure (gd_t) available to all
3986functions. We could pass a pointer to this data as argument to _all_
3987functions, but this would bloat the code. Instead we use a feature of
3988the GCC compiler (Global Register Variables) to share the data: we
3989place a pointer (gd) to the global data into a register which we
3990reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992When choosing a register for such a purpose we are restricted by the
3993relevant (E)ABI specifications for the current architecture, and by
3994GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003995
wdenk2729af92004-05-03 20:45:30 +00003996For PowerPC, the following registers have specific use:
3997 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01003998 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00003999 R3-R4: parameter passing and return values
4000 R5-R10: parameter passing
4001 R13: small data area pointer
4002 R30: GOT pointer
4003 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004004
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004005 (U-Boot also uses R12 as internal GOT pointer. r12
4006 is a volatile register so r12 needs to be reset when
4007 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004008
Wolfgang Denke7670f62008-02-14 22:43:22 +01004009 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004010
wdenk2729af92004-05-03 20:45:30 +00004011 Note: on PPC, we could use a static initializer (since the
4012 address of the global data structure is known at compile time),
4013 but it turned out that reserving a register results in somewhat
4014 smaller code - although the code savings are not that big (on
4015 average for all boards 752 bytes for the whole U-Boot image,
4016 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004017
Robin Getzc4db3352009-08-17 15:23:02 +00004018On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004019 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4020
Robin Getzc4db3352009-08-17 15:23:02 +00004021 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004022
wdenk2729af92004-05-03 20:45:30 +00004023On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004024
wdenk2729af92004-05-03 20:45:30 +00004025 R0: function argument word/integer result
4026 R1-R3: function argument word
4027 R9: GOT pointer
4028 R10: stack limit (used only if stack checking if enabled)
4029 R11: argument (frame) pointer
4030 R12: temporary workspace
4031 R13: stack pointer
4032 R14: link register
4033 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk2729af92004-05-03 20:45:30 +00004035 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004036
Thomas Chou0df01fd2010-05-21 11:08:03 +08004037On Nios II, the ABI is documented here:
4038 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4039
4040 ==> U-Boot will use gp to hold a pointer to the global data
4041
4042 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4043 to access small data sections, so gp is free.
4044
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004045NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4046or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004047
wdenk2729af92004-05-03 20:45:30 +00004048Memory Management:
4049------------------
wdenkc6097192002-11-03 00:24:07 +00004050
wdenk2729af92004-05-03 20:45:30 +00004051U-Boot runs in system state and uses physical addresses, i.e. the
4052MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004053
wdenk2729af92004-05-03 20:45:30 +00004054The available memory is mapped to fixed addresses using the memory
4055controller. In this process, a contiguous block is formed for each
4056memory type (Flash, SDRAM, SRAM), even when it consists of several
4057physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004058
wdenk2729af92004-05-03 20:45:30 +00004059U-Boot is installed in the first 128 kB of the first Flash bank (on
4060TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4061booting and sizing and initializing DRAM, the code relocates itself
4062to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004063memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004064configuration setting]. Below that, a structure with global Board
4065Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004066
wdenk2729af92004-05-03 20:45:30 +00004067Additionally, some exception handler code is copied to the low 8 kB
4068of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004069
wdenk2729af92004-05-03 20:45:30 +00004070So a typical memory configuration with 16 MB of DRAM could look like
4071this:
wdenkc6097192002-11-03 00:24:07 +00004072
wdenk2729af92004-05-03 20:45:30 +00004073 0x0000 0000 Exception Vector code
4074 :
4075 0x0000 1FFF
4076 0x0000 2000 Free for Application Use
4077 :
4078 :
wdenkc6097192002-11-03 00:24:07 +00004079
wdenk2729af92004-05-03 20:45:30 +00004080 :
4081 :
4082 0x00FB FF20 Monitor Stack (Growing downward)
4083 0x00FB FFAC Board Info Data and permanent copy of global data
4084 0x00FC 0000 Malloc Arena
4085 :
4086 0x00FD FFFF
4087 0x00FE 0000 RAM Copy of Monitor Code
4088 ... eventually: LCD or video framebuffer
4089 ... eventually: pRAM (Protected RAM - unchanged by reset)
4090 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004091
4092
wdenk2729af92004-05-03 20:45:30 +00004093System Initialization:
4094----------------------
wdenkc6097192002-11-03 00:24:07 +00004095
wdenk2729af92004-05-03 20:45:30 +00004096In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004097(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004098configuration for CS0# this is a mirror of the onboard Flash memory.
4099To be able to re-map memory U-Boot then jumps to its link address.
4100To be able to implement the initialization code in C, a (small!)
4101initial stack is set up in the internal Dual Ported RAM (in case CPUs
4102which provide such a feature like MPC8xx or MPC8260), or in a locked
4103part of the data cache. After that, U-Boot initializes the CPU core,
4104the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004105
wdenk2729af92004-05-03 20:45:30 +00004106Next, all (potentially) available memory banks are mapped using a
4107preliminary mapping. For example, we put them on 512 MB boundaries
4108(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4109on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4110programmed for SDRAM access. Using the temporary configuration, a
4111simple memory test is run that determines the size of the SDRAM
4112banks.
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114When there is more than one SDRAM bank, and the banks are of
4115different size, the largest is mapped first. For equal size, the first
4116bank (CS2#) is mapped first. The first mapping is always for address
41170x00000000, with any additional banks following immediately to create
4118contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004119
wdenk2729af92004-05-03 20:45:30 +00004120Then, the monitor installs itself at the upper end of the SDRAM area
4121and allocates memory for use by malloc() and for the global Board
4122Info data; also, the exception vector code is copied to the low RAM
4123pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004124
wdenk2729af92004-05-03 20:45:30 +00004125Only after this relocation will you have a "normal" C environment;
4126until that you are restricted in several ways, mostly because you are
4127running from ROM, and because the code will have to be relocated to a
4128new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004129
4130
wdenk2729af92004-05-03 20:45:30 +00004131U-Boot Porting Guide:
4132----------------------
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4135list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004136
4137
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004138int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004139{
4140 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004141
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004142 signal(SIGALRM, no_more_time);
4143 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004144
wdenk2729af92004-05-03 20:45:30 +00004145 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004146 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004147 return 0;
4148 }
4149
wdenk2729af92004-05-03 20:45:30 +00004150 Download latest U-Boot source;
4151
Wolfgang Denk06682362008-12-30 22:56:11 +01004152 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004153
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004154 if (clueless)
4155 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004156
wdenk2729af92004-05-03 20:45:30 +00004157 while (learning) {
4158 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004159 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4160 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004161 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004162 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004163 }
wdenkc6097192002-11-03 00:24:07 +00004164
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004165 if (available_money > toLocalCurrency ($2500))
4166 Buy a BDI3000;
4167 else
wdenk2729af92004-05-03 20:45:30 +00004168 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004169
4170 if (a similar board exists) { /* hopefully... */
4171 cp -a board/<similar> board/<myboard>
4172 cp include/configs/<similar>.h include/configs/<myboard>.h
4173 } else {
4174 Create your own board support subdirectory;
4175 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004176 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004177 Edit new board/<myboard> files
4178 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004179
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004180 while (!accepted) {
4181 while (!running) {
4182 do {
4183 Add / modify source code;
4184 } until (compiles);
4185 Debug;
4186 if (clueless)
4187 email("Hi, I am having problems...");
4188 }
4189 Send patch file to the U-Boot email list;
4190 if (reasonable critiques)
4191 Incorporate improvements from email list code review;
4192 else
4193 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004194 }
wdenkc6097192002-11-03 00:24:07 +00004195
wdenk2729af92004-05-03 20:45:30 +00004196 return 0;
4197}
4198
4199void no_more_time (int sig)
4200{
4201 hire_a_guru();
4202}
wdenkc6097192002-11-03 00:24:07 +00004203
4204
wdenk2729af92004-05-03 20:45:30 +00004205Coding Standards:
4206-----------------
wdenkc6097192002-11-03 00:24:07 +00004207
wdenk2729af92004-05-03 20:45:30 +00004208All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004209coding style; see the file "Documentation/CodingStyle" and the script
4210"scripts/Lindent" in your Linux kernel source directory. In sources
4211originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4212spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004213
Detlev Zundel2c051652006-09-01 15:39:02 +02004214Source files originating from a different project (for example the
4215MTD subsystem) are generally exempt from these guidelines and are not
4216reformated to ease subsequent migration to newer versions of those
4217sources.
4218
4219Please note that U-Boot is implemented in C (and to some small parts in
4220Assembler); no C++ is used, so please do not use C++ style comments (//)
4221in your code.
wdenk2729af92004-05-03 20:45:30 +00004222
4223Please also stick to the following formatting rules:
4224- remove any trailing white space
4225- use TAB characters for indentation, not spaces
4226- make sure NOT to use DOS '\r\n' line feeds
4227- do not add more than 2 empty lines to source files
4228- do not add trailing empty lines to source files
4229
4230Submissions which do not conform to the standards may be returned
4231with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004232
4233
wdenk2729af92004-05-03 20:45:30 +00004234Submitting Patches:
4235-------------------
wdenkc6097192002-11-03 00:24:07 +00004236
wdenk2729af92004-05-03 20:45:30 +00004237Since the number of patches for U-Boot is growing, we need to
4238establish some rules. Submissions which do not conform to these rules
4239may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004240
Magnus Lilja0d28f342008-08-06 19:32:33 +02004241Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004242
Wolfgang Denk06682362008-12-30 22:56:11 +01004243Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4244see http://lists.denx.de/mailman/listinfo/u-boot
4245
wdenk2729af92004-05-03 20:45:30 +00004246When you send a patch, please include the following information with
4247it:
wdenkc6097192002-11-03 00:24:07 +00004248
wdenk2729af92004-05-03 20:45:30 +00004249* For bug fixes: a description of the bug and how your patch fixes
4250 this bug. Please try to include a way of demonstrating that the
4251 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253* For new features: a description of the feature and your
4254 implementation.
wdenkc6097192002-11-03 00:24:07 +00004255
wdenk2729af92004-05-03 20:45:30 +00004256* A CHANGELOG entry as plaintext (separate from the patch)
4257
4258* For major contributions, your entry to the CREDITS file
4259
4260* When you add support for a new board, don't forget to add this
4261 board to the MAKEALL script, too.
4262
4263* If your patch adds new configuration options, don't forget to
4264 document these in the README file.
4265
Wolfgang Denk218ca722008-03-26 10:40:12 +01004266* The patch itself. If you are using git (which is *strongly*
4267 recommended) you can easily generate the patch using the
4268 "git-format-patch". If you then use "git-send-email" to send it to
4269 the U-Boot mailing list, you will avoid most of the common problems
4270 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004271
Wolfgang Denk218ca722008-03-26 10:40:12 +01004272 If you cannot use git, use "diff -purN OLD NEW". If your version of
4273 diff does not support these options, then get the latest version of
4274 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004275
Wolfgang Denk218ca722008-03-26 10:40:12 +01004276 The current directory when running this command shall be the parent
4277 directory of the U-Boot source tree (i. e. please make sure that
4278 your patch includes sufficient directory information for the
4279 affected files).
4280
4281 We prefer patches as plain text. MIME attachments are discouraged,
4282 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004283
4284* If one logical set of modifications affects or creates several
4285 files, all these changes shall be submitted in a SINGLE patch file.
4286
4287* Changesets that contain different, unrelated modifications shall be
4288 submitted as SEPARATE patches, one patch per changeset.
4289
4290
4291Notes:
4292
4293* Before sending the patch, run the MAKEALL script on your patched
4294 source tree and make sure that no errors or warnings are reported
4295 for any of the boards.
4296
4297* Keep your modifications to the necessary minimum: A patch
4298 containing several unrelated changes or arbitrary reformats will be
4299 returned with a request to re-formatting / split it.
4300
4301* If you modify existing code, make sure that your new code does not
4302 add to the memory footprint of the code ;-) Small is beautiful!
4303 When adding new features, these should compile conditionally only
4304 (using #ifdef), and the resulting code with the new feature
4305 disabled must not need more memory than the old code without your
4306 modification.
wdenk90dc6702005-05-03 14:12:25 +00004307
Wolfgang Denk06682362008-12-30 22:56:11 +01004308* Remember that there is a size limit of 100 kB per message on the
4309 u-boot mailing list. Bigger patches will be moderated. If they are
4310 reasonable and not too big, they will be acknowledged. But patches
4311 bigger than the size limit should be avoided.