blob: e005bc5a04bbee5b9d8977d71d8fe66b5b2834e1 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002# (C) Copyright 2000 - 2009
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Wolfgang Denka9046b92010-06-13 17:48:15 +0200150 /at91rm9200 Files specific to Atmel AT91RM9200 CPU
151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
167 /i386 Files generic to i386 architecture
168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
183 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /nios2 Files generic to Altera NIOS2 architecture
185 /cpu CPU specific files
186 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200187 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /cpu CPU specific files
189 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
190 /mpc5xx Files specific to Freescale MPC5xx CPUs
191 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
192 /mpc8xx Files specific to Freescale MPC8xx CPUs
193 /mpc8220 Files specific to Freescale MPC8220 CPUs
194 /mpc824x Files specific to Freescale MPC824x CPUs
195 /mpc8260 Files specific to Freescale MPC8260 CPUs
196 /mpc85xx Files specific to Freescale MPC85xx CPUs
197 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
198 /lib Architecture specific library files
199 /sh Files generic to SH architecture
200 /cpu CPU specific files
201 /sh2 Files specific to sh2 CPUs
202 /sh3 Files specific to sh3 CPUs
203 /sh4 Files specific to sh4 CPUs
204 /lib Architecture specific library files
205 /sparc Files generic to SPARC architecture
206 /cpu CPU specific files
207 /leon2 Files specific to Gaisler LEON2 SPARC CPU
208 /leon3 Files specific to Gaisler LEON3 SPARC CPU
209 /lib Architecture specific library files
210/api Machine/arch independent API for external apps
211/board Board dependent files
212/common Misc architecture independent functions
213/disk Code for disk drive partition handling
214/doc Documentation (don't expect too much)
215/drivers Commonly used device drivers
216/examples Example code for standalone applications, etc.
217/fs Filesystem code (cramfs, ext2, jffs2, etc.)
218/include Header Files
219/lib Files generic to all architectures
220 /libfdt Library files to support flattened device trees
221 /lzma Library files to support LZMA decompression
222 /lzo Library files to support LZO decompression
223/net Networking code
224/post Power On Self Test
225/rtc Real Time Clock drivers
226/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000227
wdenkc6097192002-11-03 00:24:07 +0000228Software Configuration:
229=======================
230
231Configuration is usually done using C preprocessor defines; the
232rationale behind that is to avoid dead code whenever possible.
233
234There are two classes of configuration variables:
235
236* Configuration _OPTIONS_:
237 These are selectable by the user and have names beginning with
238 "CONFIG_".
239
240* Configuration _SETTINGS_:
241 These depend on the hardware etc. and should not be meddled with if
242 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200243 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000244
245Later we will add a configuration tool - probably similar to or even
246identical to what's used for the Linux kernel. Right now, we have to
247do the configuration by hand, which means creating some symbolic
248links and editing some configuration files. We use the TQM8xxL boards
249as an example here.
250
251
252Selection of Processor Architecture and Board Type:
253---------------------------------------------------
254
255For all supported boards there are ready-to-use default
256configurations available; just type "make <board_name>_config".
257
258Example: For a TQM823L module type:
259
260 cd u-boot
261 make TQM823L_config
262
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200263For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000264e.g. "make cogent_mpc8xx_config". And also configure the cogent
265directory according to the instructions in cogent/README.
266
267
268Configuration Options:
269----------------------
270
271Configuration depends on the combination of board and CPU type; all
272such information is kept in a configuration file
273"include/configs/<board_name>.h".
274
275Example: For a TQM823L module, all configuration settings are in
276"include/configs/TQM823L.h".
277
278
wdenk7f6c2cb2002-11-10 22:06:23 +0000279Many of the options are named exactly as the corresponding Linux
280kernel configuration options. The intention is to make it easier to
281build a config tool - later.
282
283
wdenkc6097192002-11-03 00:24:07 +0000284The following options need to be configured:
285
Kim Phillips26281142007-08-10 13:28:25 -0500286- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000287
Kim Phillips26281142007-08-10 13:28:25 -0500288- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200289
290- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100291 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000292
293- CPU Module Type: (if CONFIG_COGENT is defined)
294 Define exactly one of
295 CONFIG_CMA286_60_OLD
296--- FIXME --- not tested yet:
297 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298 CONFIG_CMA287_23, CONFIG_CMA287_50
299
300- Motherboard Type: (if CONFIG_COGENT is defined)
301 Define exactly one of
302 CONFIG_CMA101, CONFIG_CMA102
303
304- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305 Define one or more of
306 CONFIG_CMA302
307
308- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309 Define one or more of
310 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200311 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000312 a "rotator" |\-/|\-/
313
wdenk2535d602003-07-17 23:16:40 +0000314- Board flavour: (if CONFIG_MPC8260ADS is defined)
315 CONFIG_ADSTYPE
316 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200317 CONFIG_SYS_8260ADS - original MPC8260ADS
318 CONFIG_SYS_8266ADS - MPC8266ADS
319 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
320 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000321
wdenkc6097192002-11-03 00:24:07 +0000322- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000323 Define exactly one of
324 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000325
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200326- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000327 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
328 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000329 e.g. if there is no 32KHz
330 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000331 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
332 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000333
wdenk66ca92a2004-09-28 17:59:53 +0000334- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200335 CONFIG_SYS_8xx_CPUCLK_MIN
336 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000337 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000338 See doc/README.MPC866
339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000341
wdenkba56f622004-02-06 23:19:44 +0000342 Define this to measure the actual CPU clock instead
343 of relying on the correctness of the configured
344 values. Mostly useful for board bringup to make sure
345 the PLL is locked at the intended frequency. Note
346 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000348
Heiko Schocher506f3912009-03-12 07:37:15 +0100349 CONFIG_SYS_DELAYED_ICACHE
350
351 Define this option if you want to enable the
352 ICache only when Code runs from RAM.
353
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100354- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200355 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100356
357 Defines the Monahans run mode to oscillator
358 ratio. Valid values are 8, 16, 24, 31. The core
359 frequency is this value multiplied by 13 MHz.
360
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200361 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200362
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100363 Defines the Monahans turbo mode to oscillator
364 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200365 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100366 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200367
wdenk5da627a2003-10-09 20:09:04 +0000368- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000369 CONFIG_CLOCKS_IN_MHZ
370
371 U-Boot stores all clock information in Hz
372 internally. For binary compatibility with older Linux
373 kernels (which expect the clocks passed in the
374 bd_info data to be in MHz) the environment variable
375 "clocks_in_mhz" can be defined so that U-Boot
376 converts clock data to MHZ before passing it to the
377 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000378 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100379 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000380 default environment.
381
wdenk5da627a2003-10-09 20:09:04 +0000382 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
383
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200384 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000385 expect it to be in bytes, others in MB.
386 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
387
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400388 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200389
390 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400391 passed using flattened device trees (based on open firmware
392 concepts).
393
394 CONFIG_OF_LIBFDT
395 * New libfdt-based support
396 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500397 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400398
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200399 OF_CPU - The proper name of the cpus node (only required for
400 MPC512X and MPC5xxx based boards).
401 OF_SOC - The proper name of the soc node (only required for
402 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200403 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600404 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200405
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200406 boards with QUICC Engines require OF_QE to set UCC MAC
407 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500408
Kumar Gala4e253132006-01-11 13:54:17 -0600409 CONFIG_OF_BOARD_SETUP
410
411 Board code has addition modification that it wants to make
412 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000413
Matthew McClintock02677682006-06-28 10:41:37 -0500414 CONFIG_OF_BOOT_CPU
415
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200416 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500417 param header, the default value is zero if undefined.
418
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200419 CONFIG_OF_IDE_FIXUP
420
421 U-Boot can detect if an IDE device is present or not.
422 If not, and this new config option is activated, U-Boot
423 removes the ATA node from the DTS before booting Linux,
424 so the Linux IDE driver does not probe the device and
425 crash. This is needed for buggy hardware (uc101) where
426 no pull down resistor is connected to the signal IDE5V_DD7.
427
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100428- vxWorks boot parameters:
429
430 bootvx constructs a valid bootline using the following
431 environments variables: bootfile, ipaddr, serverip, hostname.
432 It loads the vxWorks image pointed bootfile.
433
434 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
435 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
436 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
437 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
438
439 CONFIG_SYS_VXWORKS_ADD_PARAMS
440
441 Add it at the end of the bootline. E.g "u=username pw=secret"
442
443 Note: If a "bootargs" environment is defined, it will overwride
444 the defaults discussed just above.
445
wdenk6705d812004-08-02 23:22:59 +0000446- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200447 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000448
449 Define this if you want support for Amba PrimeCell PL010 UARTs.
450
Andreas Engel48d01922008-09-08 14:30:53 +0200451 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000452
453 Define this if you want support for Amba PrimeCell PL011 UARTs.
454
455 CONFIG_PL011_CLOCK
456
457 If you have Amba PrimeCell PL011 UARTs, set this variable to
458 the clock speed of the UARTs.
459
460 CONFIG_PL01x_PORTS
461
462 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
463 define this to a list of base addresses for each (supported)
464 port. See e.g. include/configs/versatile.h
465
466
wdenkc6097192002-11-03 00:24:07 +0000467- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000468 Depending on board, define exactly one serial port
469 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
470 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
471 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000472
473 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
474 port routines must be defined elsewhere
475 (i.e. serial_init(), serial_getc(), ...)
476
477 CONFIG_CFB_CONSOLE
478 Enables console device for a color framebuffer. Needs following
479 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
480 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
481 (default big endian)
482 VIDEO_HW_RECTFILL graphic chip supports
483 rectangle fill
484 (cf. smiLynxEM)
485 VIDEO_HW_BITBLT graphic chip supports
486 bit-blit (cf. smiLynxEM)
487 VIDEO_VISIBLE_COLS visible pixel columns
488 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000489 VIDEO_VISIBLE_ROWS visible pixel rows
490 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000491 VIDEO_DATA_FORMAT graphic data format
492 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000493 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000494 VIDEO_KBD_INIT_FCT keyboard int fct
495 (i.e. i8042_kbd_init())
496 VIDEO_TSTC_FCT test char fct
497 (i.e. i8042_tstc)
498 VIDEO_GETC_FCT get char fct
499 (i.e. i8042_getc)
500 CONFIG_CONSOLE_CURSOR cursor drawing on/off
501 (requires blink timer
502 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200503 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000504 CONFIG_CONSOLE_TIME display time/date info in
505 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500506 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000507 CONFIG_VIDEO_LOGO display Linux logo in
508 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000509 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
510 linux_logo.h for logo.
511 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000512 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200513 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000514 the logo
515
wdenk43d96162003-03-06 00:02:04 +0000516 When CONFIG_CFB_CONSOLE is defined, video console is
517 default i/o. Serial console can be forced with
518 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000519
wdenkd4ca31c2004-01-02 14:00:00 +0000520 When CONFIG_SILENT_CONSOLE is defined, all console
521 messages (by U-Boot and Linux!) can be silenced with
522 the "silent" environment variable. See
523 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000524
wdenkc6097192002-11-03 00:24:07 +0000525- Console Baudrate:
526 CONFIG_BAUDRATE - in bps
527 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200528 CONFIG_SYS_BAUDRATE_TABLE, see below.
529 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000530
Heiko Schocherc92fac92009-01-30 12:55:38 +0100531- Console Rx buffer length
532 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
533 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100534 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100535 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
536 must be defined, to setup the maximum idle timeout for
537 the SMC.
538
wdenkc6097192002-11-03 00:24:07 +0000539- Boot Delay: CONFIG_BOOTDELAY - in seconds
540 Delay before automatically booting the default image;
541 set to -1 to disable autoboot.
542
543 See doc/README.autoboot for these options that
544 work with CONFIG_BOOTDELAY. None are required.
545 CONFIG_BOOT_RETRY_TIME
546 CONFIG_BOOT_RETRY_MIN
547 CONFIG_AUTOBOOT_KEYED
548 CONFIG_AUTOBOOT_PROMPT
549 CONFIG_AUTOBOOT_DELAY_STR
550 CONFIG_AUTOBOOT_STOP_STR
551 CONFIG_AUTOBOOT_DELAY_STR2
552 CONFIG_AUTOBOOT_STOP_STR2
553 CONFIG_ZERO_BOOTDELAY_CHECK
554 CONFIG_RESET_TO_RETRY
555
556- Autoboot Command:
557 CONFIG_BOOTCOMMAND
558 Only needed when CONFIG_BOOTDELAY is enabled;
559 define a command string that is automatically executed
560 when no character is read on the console interface
561 within "Boot Delay" after reset.
562
563 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000564 This can be used to pass arguments to the bootm
565 command. The value of CONFIG_BOOTARGS goes into the
566 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000567
568 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000569 The value of these goes into the environment as
570 "ramboot" and "nfsboot" respectively, and can be used
571 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200572 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000573
574- Pre-Boot Commands:
575 CONFIG_PREBOOT
576
577 When this option is #defined, the existence of the
578 environment variable "preboot" will be checked
579 immediately before starting the CONFIG_BOOTDELAY
580 countdown and/or running the auto-boot command resp.
581 entering interactive mode.
582
583 This feature is especially useful when "preboot" is
584 automatically generated or modified. For an example
585 see the LWMON board specific code: here "preboot" is
586 modified when the user holds down a certain
587 combination of keys on the (special) keyboard when
588 booting the systems
589
590- Serial Download Echo Mode:
591 CONFIG_LOADS_ECHO
592 If defined to 1, all characters received during a
593 serial download (using the "loads" command) are
594 echoed back. This might be needed by some terminal
595 emulations (like "cu"), but may as well just take
596 time on others. This setting #define's the initial
597 value of the "loads_echo" environment variable.
598
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500599- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000600 CONFIG_KGDB_BAUDRATE
601 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200602 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000603
604- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500605 Monitor commands can be included or excluded
606 from the build by using the #include files
607 "config_cmd_all.h" and #undef'ing unwanted
608 commands, or using "config_cmd_default.h"
609 and augmenting with additional #define's
610 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000611
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500612 The default command configuration includes all commands
613 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000614
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500615 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500616 CONFIG_CMD_BDI bdinfo
617 CONFIG_CMD_BEDBUG * Include BedBug Debugger
618 CONFIG_CMD_BMP * BMP support
619 CONFIG_CMD_BSP * Board specific commands
620 CONFIG_CMD_BOOTD bootd
621 CONFIG_CMD_CACHE * icache, dcache
622 CONFIG_CMD_CONSOLE coninfo
623 CONFIG_CMD_DATE * support for RTC, date/time...
624 CONFIG_CMD_DHCP * DHCP support
625 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600626 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
627 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
628 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
629 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500630 CONFIG_CMD_DTT * Digital Therm and Thermostat
631 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500632 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500633 CONFIG_CMD_EEPROM * EEPROM read/write support
634 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500635 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500636 CONFIG_CMD_FDC * Floppy Disk Support
637 CONFIG_CMD_FAT * FAT partition support
638 CONFIG_CMD_FDOS * Dos diskette Support
639 CONFIG_CMD_FLASH flinfo, erase, protect
640 CONFIG_CMD_FPGA FPGA device initialization support
641 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
642 CONFIG_CMD_I2C * I2C serial bus support
643 CONFIG_CMD_IDE * IDE harddisk support
644 CONFIG_CMD_IMI iminfo
645 CONFIG_CMD_IMLS List all found images
646 CONFIG_CMD_IMMAP * IMMR dump support
647 CONFIG_CMD_IRQ * irqinfo
648 CONFIG_CMD_ITEST Integer/string test of 2 values
649 CONFIG_CMD_JFFS2 * JFFS2 Support
650 CONFIG_CMD_KGDB * kgdb
651 CONFIG_CMD_LOADB loadb
652 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400653 CONFIG_CMD_MD5SUM print md5 message digest
654 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500655 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
656 loop, loopw, mtest
657 CONFIG_CMD_MISC Misc functions like sleep etc
658 CONFIG_CMD_MMC * MMC memory mapped support
659 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100660 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500661 CONFIG_CMD_NAND * NAND support
662 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600663 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
664 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500665 CONFIG_CMD_PCI * pciinfo
666 CONFIG_CMD_PCMCIA * PCMCIA support
667 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
668 host
669 CONFIG_CMD_PORTIO * Port I/O
670 CONFIG_CMD_REGINFO * Register dump
671 CONFIG_CMD_RUN run command in env variable
672 CONFIG_CMD_SAVES * save S record dump
673 CONFIG_CMD_SCSI * SCSI Support
674 CONFIG_CMD_SDRAM * print SDRAM configuration information
675 (requires CONFIG_CMD_I2C)
676 CONFIG_CMD_SETGETDCR Support for DCR Register access
677 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100678 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400679 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200680 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500681 CONFIG_CMD_SPI * SPI serial bus support
682 CONFIG_CMD_USB * USB support
683 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500684 CONFIG_CMD_CDP * Cisco Discover Protocol support
685 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000686
wdenkc6097192002-11-03 00:24:07 +0000687
688 EXAMPLE: If you want all functions except of network
689 support you can write:
690
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500691 #include "config_cmd_all.h"
692 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000693
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400694 Other Commands:
695 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000696
697 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500698 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000699 what you (and your U-Boot users) are doing. Data
700 cache cannot be enabled on systems like the 8xx or
701 8260 (where accesses to the IMMR region must be
702 uncached), and it cannot be disabled on all other
703 systems where we (mis-) use the data cache to hold an
704 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000705
706
707 XXX - this list needs to get updated!
708
709- Watchdog:
710 CONFIG_WATCHDOG
711 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000712 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000713 code for a watchdog. For the 8xx and 8260 CPUs, the
714 SIU Watchdog feature is enabled in the SYPCR
715 register.
716
stroesec1551ea2003-04-04 15:53:41 +0000717- U-Boot Version:
718 CONFIG_VERSION_VARIABLE
719 If this variable is defined, an environment variable
720 named "ver" is created by U-Boot showing the U-Boot
721 version as printed by the "version" command.
722 This variable is readonly.
723
wdenkc6097192002-11-03 00:24:07 +0000724- Real-Time Clock:
725
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500726 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000727 has to be selected, too. Define exactly one of the
728 following options:
729
730 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
731 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200732 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000733 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000734 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000735 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000736 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000737 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100738 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000739 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200740 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000741
wdenkb37c7e52003-06-30 16:24:52 +0000742 Note that if the RTC uses I2C, then the I2C interface
743 must also be configured. See I2C Support, below.
744
Peter Tysere92739d2008-12-17 16:36:21 -0600745- GPIO Support:
746 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
747 CONFIG_PCA953X_INFO - enable pca953x info command
748
Chris Packham5dec49c2010-12-19 10:12:13 +0000749 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
750 chip-ngpio pairs that tell the PCA953X driver the number of
751 pins supported by a particular chip.
752
Peter Tysere92739d2008-12-17 16:36:21 -0600753 Note that if the GPIO device uses I2C, then the I2C interface
754 must also be configured. See I2C Support, below.
755
wdenkc6097192002-11-03 00:24:07 +0000756- Timestamp Support:
757
wdenk43d96162003-03-06 00:02:04 +0000758 When CONFIG_TIMESTAMP is selected, the timestamp
759 (date and time) of an image is printed by image
760 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500761 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000762
763- Partition Support:
764 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400765 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000766
Wolfgang Denk218ca722008-03-26 10:40:12 +0100767 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
768 CONFIG_CMD_SCSI) you must configure support for at
769 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000770
771- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000772 CONFIG_IDE_RESET_ROUTINE - this is defined in several
773 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000774
wdenk4d13cba2004-03-14 14:09:05 +0000775 CONFIG_IDE_RESET - is this is defined, IDE Reset will
776 be performed by calling the function
777 ide_set_reset(int reset)
778 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000779
780- ATAPI Support:
781 CONFIG_ATAPI
782
783 Set this to enable ATAPI support.
784
wdenkc40b2952004-03-13 23:29:43 +0000785- LBA48 Support
786 CONFIG_LBA48
787
788 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100789 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000790 Whithout these , LBA48 support uses 32bit variables and will 'only'
791 support disks up to 2.1TB.
792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200793 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000794 When enabled, makes the IDE subsystem use 64bit sector addresses.
795 Default is 32bit.
796
wdenkc6097192002-11-03 00:24:07 +0000797- SCSI Support:
798 At the moment only there is only support for the
799 SYM53C8XX SCSI controller; define
800 CONFIG_SCSI_SYM53C8XX to enable it.
801
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200802 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
803 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
804 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000805 maximum numbers of LUNs, SCSI ID's and target
806 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200807 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000808
809- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000810 CONFIG_E1000
811 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000812
Andre Schwarzac3315c2008-03-06 16:45:44 +0100813 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200814 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100815
wdenkc6097192002-11-03 00:24:07 +0000816 CONFIG_EEPRO100
817 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200818 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000819 write routine for first time initialisation.
820
821 CONFIG_TULIP
822 Support for Digital 2114x chips.
823 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
824 modem chip initialisation (KS8761/QS6611).
825
826 CONFIG_NATSEMI
827 Support for National dp83815 chips.
828
829 CONFIG_NS8382X
830 Support for National dp8382[01] gigabit chips.
831
wdenk45219c42003-05-12 21:50:16 +0000832- NETWORK Support (other):
833
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100834 CONFIG_DRIVER_AT91EMAC
835 Support for AT91RM9200 EMAC.
836
837 CONFIG_RMII
838 Define this to use reduced MII inteface
839
840 CONFIG_DRIVER_AT91EMAC_QUIET
841 If this defined, the driver is quiet.
842 The driver doen't show link status messages.
843
wdenk45219c42003-05-12 21:50:16 +0000844 CONFIG_DRIVER_LAN91C96
845 Support for SMSC's LAN91C96 chips.
846
847 CONFIG_LAN91C96_BASE
848 Define this to hold the physical address
849 of the LAN91C96's I/O space
850
851 CONFIG_LAN91C96_USE_32_BIT
852 Define this to enable 32 bit addressing
853
wdenkf39748a2004-06-09 13:37:52 +0000854 CONFIG_DRIVER_SMC91111
855 Support for SMSC's LAN91C111 chip
856
857 CONFIG_SMC91111_BASE
858 Define this to hold the physical address
859 of the device (I/O space)
860
861 CONFIG_SMC_USE_32_BIT
862 Define this if data bus is 32 bits
863
864 CONFIG_SMC_USE_IOFUNCS
865 Define this to use i/o functions instead of macros
866 (some hardware wont work with macros)
867
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800868 CONFIG_FTGMAC100
869 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
870
871 CONFIG_FTGMAC100_EGIGA
872 Define this to use GE link update with gigabit PHY.
873 Define this if FTGMAC100 is connected to gigabit PHY.
874 If your system has 10/100 PHY only, it might not occur
875 wrong behavior. Because PHY usually return timeout or
876 useless data when polling gigabit status and gigabit
877 control registers. This behavior won't affect the
878 correctnessof 10/100 link speed update.
879
Mike Rapoportc2fff332009-11-11 10:03:03 +0200880 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200881 Support for SMSC's LAN911x and LAN921x chips
882
Mike Rapoportc2fff332009-11-11 10:03:03 +0200883 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200884 Define this to hold the physical address
885 of the device (I/O space)
886
Mike Rapoportc2fff332009-11-11 10:03:03 +0200887 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200888 Define this if data bus is 32 bits
889
Mike Rapoportc2fff332009-11-11 10:03:03 +0200890 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200891 Define this if data bus is 16 bits. If your processor
892 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200893 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200894
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900895 CONFIG_SH_ETHER
896 Support for Renesas on-chip Ethernet controller
897
898 CONFIG_SH_ETHER_USE_PORT
899 Define the number of ports to be used
900
901 CONFIG_SH_ETHER_PHY_ADDR
902 Define the ETH PHY's address
903
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900904 CONFIG_SH_ETHER_CACHE_WRITEBACK
905 If this option is set, the driver enables cache flush.
906
wdenkc6097192002-11-03 00:24:07 +0000907- USB Support:
908 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000909 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000910 CONFIG_USB_UHCI to enable it.
911 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000912 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000913 storage devices.
914 Note:
915 Supported are USB Keyboards and USB Floppy drives
916 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000917 MPC5200 USB requires additional defines:
918 CONFIG_USB_CLOCK
919 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500920 CONFIG_PSC3_USB
921 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000922 CONFIG_USB_CONFIG
923 for differential drivers: 0x00001000
924 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500925 for differential drivers on PSC3: 0x00000100
926 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200927 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200928 May be defined to allow interrupt polling
929 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000930
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200931- USB Device:
932 Define the below if you wish to use the USB console.
933 Once firmware is rebuilt from a serial console issue the
934 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200935 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200936 it has found a new device. The environment variable usbtty
937 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200938 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200939 Common Device Class Abstract Control Model serial device.
940 If you select usbtty = gserial you should be able to enumerate
941 a Linux host by
942 # modprobe usbserial vendor=0xVendorID product=0xProductID
943 else if using cdc_acm, simply setting the environment
944 variable usbtty to be cdc_acm should suffice. The following
945 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200946
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200947 CONFIG_USB_DEVICE
948 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000949
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200950 CONFIG_USB_TTY
951 Define this to have a tty type of device available to
952 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200953
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200954 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200955 Define this if you want stdin, stdout &/or stderr to
956 be set to usbtty.
957
958 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200959 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200960 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200961 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200962
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200963 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200964 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200965 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200966
Wolfgang Denk386eda02006-06-14 18:14:56 +0200967 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200968 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200969 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200970 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
971 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
972 should pretend to be a Linux device to it's target host.
973
974 CONFIG_USBD_MANUFACTURER
975 Define this string as the name of your company for
976 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200977
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200978 CONFIG_USBD_PRODUCT_NAME
979 Define this string as the name of your product
980 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
981
982 CONFIG_USBD_VENDORID
983 Define this as your assigned Vendor ID from the USB
984 Implementors Forum. This *must* be a genuine Vendor ID
985 to avoid polluting the USB namespace.
986 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200987
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200988 CONFIG_USBD_PRODUCTID
989 Define this as the unique Product ID
990 for your device
991 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000992
993
994- MMC Support:
995 The MMC controller on the Intel PXA is supported. To
996 enable this define CONFIG_MMC. The MMC can be
997 accessed from the boot prompt by mapping the device
998 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500999 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1000 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001001
wdenk6705d812004-08-02 23:22:59 +00001002- Journaling Flash filesystem support:
1003 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1004 CONFIG_JFFS2_NAND_DEV
1005 Define these for a default partition on a NAND device
1006
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001007 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1008 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001009 Define these for a default partition on a NOR device
1010
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001011 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001012 Define this to create an own partition. You have to provide a
1013 function struct part_info* jffs2_part_info(int part_num)
1014
1015 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001016 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001017 to disable the command chpart. This is the default when you
1018 have not defined a custom partition
1019
wdenkc6097192002-11-03 00:24:07 +00001020- Keyboard Support:
1021 CONFIG_ISA_KEYBOARD
1022
1023 Define this to enable standard (PC-Style) keyboard
1024 support
1025
1026 CONFIG_I8042_KBD
1027 Standard PC keyboard driver with US (is default) and
1028 GERMAN key layout (switch via environment 'keymap=de') support.
1029 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1030 for cfb_console. Supports cursor blinking.
1031
1032- Video support:
1033 CONFIG_VIDEO
1034
1035 Define this to enable video support (for output to
1036 video).
1037
1038 CONFIG_VIDEO_CT69000
1039
1040 Enable Chips & Technologies 69000 Video chip
1041
1042 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001043 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001044 video output is selected via environment 'videoout'
1045 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1046 assumed.
wdenkc6097192002-11-03 00:24:07 +00001047
wdenkb79a11c2004-03-25 15:14:43 +00001048 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001049 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001050 are possible:
1051 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001052 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001053
1054 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1055 -------------+---------------------------------------------
1056 8 bits | 0x301* 0x303 0x305 0x161 0x307
1057 15 bits | 0x310 0x313 0x316 0x162 0x319
1058 16 bits | 0x311 0x314 0x317 0x163 0x31A
1059 24 bits | 0x312 0x315 0x318 ? 0x31B
1060 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001061 (i.e. setenv videomode 317; saveenv; reset;)
1062
wdenkb79a11c2004-03-25 15:14:43 +00001063 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001064 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001065
1066
stroesec1551ea2003-04-04 15:53:41 +00001067 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001068 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001069 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1070 or CONFIG_VIDEO_SED13806_16BPP
1071
wdenk682011f2003-06-03 23:54:09 +00001072- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001073 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001074
wdenk8bde7f72003-06-27 21:31:46 +00001075 Define this to enable a custom keyboard support.
1076 This simply calls drv_keyboard_init() which must be
1077 defined in your board-specific files.
1078 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001079
wdenkc6097192002-11-03 00:24:07 +00001080- LCD Support: CONFIG_LCD
1081
1082 Define this to enable LCD support (for output to LCD
1083 display); also select one of the supported displays
1084 by defining one of these:
1085
Stelian Pop39cf4802008-05-09 21:57:18 +02001086 CONFIG_ATMEL_LCD:
1087
1088 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1089
wdenkfd3103b2003-11-25 16:55:19 +00001090 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001091
wdenkfd3103b2003-11-25 16:55:19 +00001092 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001093
wdenkfd3103b2003-11-25 16:55:19 +00001094 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001095
wdenkfd3103b2003-11-25 16:55:19 +00001096 NEC NL6448BC20-08. 6.5", 640x480.
1097 Active, color, single scan.
1098
1099 CONFIG_NEC_NL6448BC33_54
1100
1101 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001102 Active, color, single scan.
1103
1104 CONFIG_SHARP_16x9
1105
1106 Sharp 320x240. Active, color, single scan.
1107 It isn't 16x9, and I am not sure what it is.
1108
1109 CONFIG_SHARP_LQ64D341
1110
1111 Sharp LQ64D341 display, 640x480.
1112 Active, color, single scan.
1113
1114 CONFIG_HLD1045
1115
1116 HLD1045 display, 640x480.
1117 Active, color, single scan.
1118
1119 CONFIG_OPTREX_BW
1120
1121 Optrex CBL50840-2 NF-FW 99 22 M5
1122 or
1123 Hitachi LMG6912RPFC-00T
1124 or
1125 Hitachi SP14Q002
1126
1127 320x240. Black & white.
1128
1129 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001130 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001131
wdenk7152b1d2003-09-05 23:19:14 +00001132- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001133
wdenk8bde7f72003-06-27 21:31:46 +00001134 If this option is set, the environment is checked for
1135 a variable "splashimage". If found, the usual display
1136 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001137 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001138 specified in "splashimage" is loaded instead. The
1139 console is redirected to the "nulldev", too. This
1140 allows for a "silent" boot where a splash screen is
1141 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001142
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001143 CONFIG_SPLASH_SCREEN_ALIGN
1144
1145 If this option is set the splash image can be freely positioned
1146 on the screen. Environment variable "splashpos" specifies the
1147 position as "x,y". If a positive number is given it is used as
1148 number of pixel from left/top. If a negative number is given it
1149 is used as number of pixel from right/bottom. You can also
1150 specify 'm' for centering the image.
1151
1152 Example:
1153 setenv splashpos m,m
1154 => image at center of screen
1155
1156 setenv splashpos 30,20
1157 => image at x = 30 and y = 20
1158
1159 setenv splashpos -10,m
1160 => vertically centered image
1161 at x = dspWidth - bmpWidth - 9
1162
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001163- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1164
1165 If this option is set, additionally to standard BMP
1166 images, gzipped BMP images can be displayed via the
1167 splashscreen support or the bmp command.
1168
Anatolij Gustschind5011762010-03-15 14:50:25 +01001169- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1170
1171 If this option is set, 8-bit RLE compressed BMP images
1172 can be displayed via the splashscreen support or the
1173 bmp command.
1174
wdenkc29fdfc2003-08-29 20:57:53 +00001175- Compression support:
1176 CONFIG_BZIP2
1177
1178 If this option is set, support for bzip2 compressed
1179 images is included. If not, only uncompressed and gzip
1180 compressed images are supported.
1181
wdenk42d1f032003-10-15 23:53:47 +00001182 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001183 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001184 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001185
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001186 CONFIG_LZMA
1187
1188 If this option is set, support for lzma compressed
1189 images is included.
1190
1191 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1192 requires an amount of dynamic memory that is given by the
1193 formula:
1194
1195 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1196
1197 Where lc and lp stand for, respectively, Literal context bits
1198 and Literal pos bits.
1199
1200 This value is upper-bounded by 14MB in the worst case. Anyway,
1201 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1202 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1203 a very small buffer.
1204
1205 Use the lzmainfo tool to determinate the lc and lp values and
1206 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001207 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001208
wdenk17ea1172004-06-06 21:51:03 +00001209- MII/PHY support:
1210 CONFIG_PHY_ADDR
1211
1212 The address of PHY on MII bus.
1213
1214 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1215
1216 The clock frequency of the MII bus
1217
1218 CONFIG_PHY_GIGE
1219
1220 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001221 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001222
1223 CONFIG_PHY_RESET_DELAY
1224
1225 Some PHY like Intel LXT971A need extra delay after
1226 reset before any MII register access is possible.
1227 For such PHY, set this option to the usec delay
1228 required. (minimum 300usec for LXT971A)
1229
1230 CONFIG_PHY_CMD_DELAY (ppc4xx)
1231
1232 Some PHY like Intel LXT971A need extra delay after
1233 command issued before MII status register can be read
1234
wdenkc6097192002-11-03 00:24:07 +00001235- Ethernet address:
1236 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001237 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001238 CONFIG_ETH2ADDR
1239 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001240 CONFIG_ETH4ADDR
1241 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001242
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001243 Define a default value for Ethernet address to use
1244 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001245 is not determined automatically.
1246
1247- IP address:
1248 CONFIG_IPADDR
1249
1250 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001251 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001252 determined through e.g. bootp.
1253
1254- Server IP address:
1255 CONFIG_SERVERIP
1256
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001257 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001258 server to contact when using the "tftboot" command.
1259
Robin Getz97cfe862009-07-21 12:15:28 -04001260 CONFIG_KEEP_SERVERADDR
1261
1262 Keeps the server's MAC address, in the env 'serveraddr'
1263 for passing to bootargs (like Linux's netconsole option)
1264
David Updegraff53a5c422007-06-11 10:41:07 -05001265- Multicast TFTP Mode:
1266 CONFIG_MCAST_TFTP
1267
1268 Defines whether you want to support multicast TFTP as per
1269 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001270 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001271 driver in use must provide a function: mcast() to join/leave a
1272 multicast group.
1273
1274 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001275- BOOTP Recovery Mode:
1276 CONFIG_BOOTP_RANDOM_DELAY
1277
1278 If you have many targets in a network that try to
1279 boot using BOOTP, you may want to avoid that all
1280 systems send out BOOTP requests at precisely the same
1281 moment (which would happen for instance at recovery
1282 from a power failure, when all systems will try to
1283 boot, thus flooding the BOOTP server. Defining
1284 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1285 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001286 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001287
1288 1st BOOTP request: delay 0 ... 1 sec
1289 2nd BOOTP request: delay 0 ... 2 sec
1290 3rd BOOTP request: delay 0 ... 4 sec
1291 4th and following
1292 BOOTP requests: delay 0 ... 8 sec
1293
stroesefe389a82003-08-28 14:17:32 +00001294- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001295 You can fine tune the DHCP functionality by defining
1296 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001297
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001298 CONFIG_BOOTP_SUBNETMASK
1299 CONFIG_BOOTP_GATEWAY
1300 CONFIG_BOOTP_HOSTNAME
1301 CONFIG_BOOTP_NISDOMAIN
1302 CONFIG_BOOTP_BOOTPATH
1303 CONFIG_BOOTP_BOOTFILESIZE
1304 CONFIG_BOOTP_DNS
1305 CONFIG_BOOTP_DNS2
1306 CONFIG_BOOTP_SEND_HOSTNAME
1307 CONFIG_BOOTP_NTPSERVER
1308 CONFIG_BOOTP_TIMEOFFSET
1309 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001310
Wilson Callan5d110f02007-07-28 10:56:13 -04001311 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1312 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001313
1314 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1315 serverip from a DHCP server, it is possible that more
1316 than one DNS serverip is offered to the client.
1317 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1318 serverip will be stored in the additional environment
1319 variable "dnsip2". The first DNS serverip is always
1320 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001321 is defined.
stroesefe389a82003-08-28 14:17:32 +00001322
1323 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1324 to do a dynamic update of a DNS server. To do this, they
1325 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001326 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001327 of the "hostname" environment variable is passed as
1328 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001329
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001330 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1331
1332 A 32bit value in microseconds for a delay between
1333 receiving a "DHCP Offer" and sending the "DHCP Request".
1334 This fixes a problem with certain DHCP servers that don't
1335 respond 100% of the time to a "DHCP request". E.g. On an
1336 AT91RM9200 processor running at 180MHz, this delay needed
1337 to be *at least* 15,000 usec before a Windows Server 2003
1338 DHCP server would reply 100% of the time. I recommend at
1339 least 50,000 usec to be safe. The alternative is to hope
1340 that one of the retries will be successful but note that
1341 the DHCP timeout and retry process takes a longer than
1342 this delay.
1343
wdenka3d991b2004-04-15 21:48:45 +00001344 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001345 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001346
1347 The device id used in CDP trigger frames.
1348
1349 CONFIG_CDP_DEVICE_ID_PREFIX
1350
1351 A two character string which is prefixed to the MAC address
1352 of the device.
1353
1354 CONFIG_CDP_PORT_ID
1355
1356 A printf format string which contains the ascii name of
1357 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001358 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001359
1360 CONFIG_CDP_CAPABILITIES
1361
1362 A 32bit integer which indicates the device capabilities;
1363 0x00000010 for a normal host which does not forwards.
1364
1365 CONFIG_CDP_VERSION
1366
1367 An ascii string containing the version of the software.
1368
1369 CONFIG_CDP_PLATFORM
1370
1371 An ascii string containing the name of the platform.
1372
1373 CONFIG_CDP_TRIGGER
1374
1375 A 32bit integer sent on the trigger.
1376
1377 CONFIG_CDP_POWER_CONSUMPTION
1378
1379 A 16bit integer containing the power consumption of the
1380 device in .1 of milliwatts.
1381
1382 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1383
1384 A byte containing the id of the VLAN.
1385
wdenkc6097192002-11-03 00:24:07 +00001386- Status LED: CONFIG_STATUS_LED
1387
1388 Several configurations allow to display the current
1389 status using a LED. For instance, the LED will blink
1390 fast while running U-Boot code, stop blinking as
1391 soon as a reply to a BOOTP request was received, and
1392 start blinking slow once the Linux kernel is running
1393 (supported by a status LED driver in the Linux
1394 kernel). Defining CONFIG_STATUS_LED enables this
1395 feature in U-Boot.
1396
1397- CAN Support: CONFIG_CAN_DRIVER
1398
1399 Defining CONFIG_CAN_DRIVER enables CAN driver support
1400 on those systems that support this (optional)
1401 feature, like the TQM8xxL modules.
1402
1403- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1404
wdenkb37c7e52003-06-30 16:24:52 +00001405 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001406 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001407 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001408
wdenk945af8d2003-07-16 21:53:01 +00001409 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001410 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001411 CONFIG_COMMANDS) and communicate with i2c based realtime
1412 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001413 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001414
Ben Warrenbb99ad62006-09-07 16:50:54 -04001415 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001416
wdenk945af8d2003-07-16 21:53:01 +00001417 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001418 bit-banging) driver instead of CPM or similar hardware
1419 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001420
wdenk945af8d2003-07-16 21:53:01 +00001421 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001422 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001423
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001424 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001425 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001426 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001427 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001428
Peter Tyser8d321b82010-04-12 22:28:21 -05001429 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001430 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001431 and so its address should therefore be cleared to 0 (See,
1432 eg, MPC823e User's Manual p.16-473). So, set
1433 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001434
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001435 CONFIG_SYS_I2C_INIT_MPC5XXX
1436
1437 When a board is reset during an i2c bus transfer
1438 chips might think that the current transfer is still
1439 in progress. Reset the slave devices by sending start
1440 commands until the slave device responds.
1441
wdenk945af8d2003-07-16 21:53:01 +00001442 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001443
1444 If you use the software i2c interface (CONFIG_SOFT_I2C)
1445 then the following macros need to be defined (examples are
1446 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001447
1448 I2C_INIT
1449
wdenkb37c7e52003-06-30 16:24:52 +00001450 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001451 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001452
wdenkba56f622004-02-06 23:19:44 +00001453 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001454
wdenkc6097192002-11-03 00:24:07 +00001455 I2C_PORT
1456
wdenk43d96162003-03-06 00:02:04 +00001457 (Only for MPC8260 CPU). The I/O port to use (the code
1458 assumes both bits are on the same port). Valid values
1459 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001460
1461 I2C_ACTIVE
1462
1463 The code necessary to make the I2C data line active
1464 (driven). If the data line is open collector, this
1465 define can be null.
1466
wdenkb37c7e52003-06-30 16:24:52 +00001467 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1468
wdenkc6097192002-11-03 00:24:07 +00001469 I2C_TRISTATE
1470
1471 The code necessary to make the I2C data line tri-stated
1472 (inactive). If the data line is open collector, this
1473 define can be null.
1474
wdenkb37c7e52003-06-30 16:24:52 +00001475 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1476
wdenkc6097192002-11-03 00:24:07 +00001477 I2C_READ
1478
1479 Code that returns TRUE if the I2C data line is high,
1480 FALSE if it is low.
1481
wdenkb37c7e52003-06-30 16:24:52 +00001482 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1483
wdenkc6097192002-11-03 00:24:07 +00001484 I2C_SDA(bit)
1485
1486 If <bit> is TRUE, sets the I2C data line high. If it
1487 is FALSE, it clears it (low).
1488
wdenkb37c7e52003-06-30 16:24:52 +00001489 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001490 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001491 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001492
wdenkc6097192002-11-03 00:24:07 +00001493 I2C_SCL(bit)
1494
1495 If <bit> is TRUE, sets the I2C clock line high. If it
1496 is FALSE, it clears it (low).
1497
wdenkb37c7e52003-06-30 16:24:52 +00001498 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001499 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001500 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001501
wdenkc6097192002-11-03 00:24:07 +00001502 I2C_DELAY
1503
1504 This delay is invoked four times per clock cycle so this
1505 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001506 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001507 like:
1508
wdenkb37c7e52003-06-30 16:24:52 +00001509 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001510
Mike Frysinger793b5722010-07-21 13:38:02 -04001511 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1512
1513 If your arch supports the generic GPIO framework (asm/gpio.h),
1514 then you may alternatively define the two GPIOs that are to be
1515 used as SCL / SDA. Any of the previous I2C_xxx macros will
1516 have GPIO-based defaults assigned to them as appropriate.
1517
1518 You should define these to the GPIO value as given directly to
1519 the generic GPIO functions.
1520
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001521 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001522
wdenk8bde7f72003-06-27 21:31:46 +00001523 When a board is reset during an i2c bus transfer
1524 chips might think that the current transfer is still
1525 in progress. On some boards it is possible to access
1526 the i2c SCLK line directly, either by using the
1527 processor pin as a GPIO or by having a second pin
1528 connected to the bus. If this option is defined a
1529 custom i2c_init_board() routine in boards/xxx/board.c
1530 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001531
Richard Retanubun26a33502010-04-12 15:08:17 -04001532 CONFIG_SYS_I2C_BOARD_LATE_INIT
1533
1534 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1535 defined a custom i2c_board_late_init() routine in
1536 boards/xxx/board.c is run AFTER the operations in i2c_init()
1537 is completed. This callpoint can be used to unreset i2c bus
1538 using CPU i2c controller register accesses for CPUs whose i2c
1539 controller provide such a method. It is called at the end of
1540 i2c_init() to allow i2c_init operations to setup the i2c bus
1541 controller on the CPU (e.g. setting bus speed & slave address).
1542
wdenk17ea1172004-06-06 21:51:03 +00001543 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1544
1545 This option enables configuration of bi_iic_fast[] flags
1546 in u-boot bd_info structure based on u-boot environment
1547 variable "i2cfast". (see also i2cfast)
1548
Ben Warrenbb99ad62006-09-07 16:50:54 -04001549 CONFIG_I2C_MULTI_BUS
1550
1551 This option allows the use of multiple I2C buses, each of which
1552 must have a controller. At any point in time, only one bus is
1553 active. To switch to a different bus, use the 'i2c dev' command.
1554 Note that bus numbering is zero-based.
1555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001556 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001557
1558 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001559 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1560 is set, specify a list of bus-device pairs. Otherwise, specify
1561 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001562
1563 e.g.
1564 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001565 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001566
1567 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1568
1569 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001570 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001571
1572 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1573
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001574 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06001575
1576 If defined, then this indicates the I2C bus number for DDR SPD.
1577 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1578
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001579 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001580
1581 If defined, then this indicates the I2C bus number for the RTC.
1582 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1583
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001584 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001585
1586 If defined, then this indicates the I2C bus number for the DTT.
1587 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1588
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001589 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001590
1591 If defined, specifies the I2C address of the DTT device.
1592 If not defined, then U-Boot uses predefined value for
1593 specified DTT device.
1594
Timur Tabibe5e61812006-11-03 19:15:00 -06001595 CONFIG_FSL_I2C
1596
1597 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001598 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e61812006-11-03 19:15:00 -06001599
Heiko Schocher67b23a32008-10-15 09:39:47 +02001600 CONFIG_I2C_MUX
1601
1602 Define this option if you have I2C devices reached over 1 .. n
1603 I2C Muxes like the pca9544a. This option addes a new I2C
1604 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1605 new I2C Bus to the existing I2C Busses. If you select the
1606 new Bus with "i2c dev", u-bbot sends first the commandos for
1607 the muxes to activate this new "bus".
1608
1609 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1610 feature!
1611
1612 Example:
1613 Adding a new I2C Bus reached over 2 pca9544a muxes
1614 The First mux with address 70 and channel 6
1615 The Second mux with address 71 and channel 4
1616
1617 => i2c bus pca9544a:70:6:pca9544a:71:4
1618
1619 Use the "i2c bus" command without parameter, to get a list
1620 of I2C Busses with muxes:
1621
1622 => i2c bus
1623 Busses reached over muxes:
1624 Bus ID: 2
1625 reached over Mux(es):
1626 pca9544a@70 ch: 4
1627 Bus ID: 3
1628 reached over Mux(es):
1629 pca9544a@70 ch: 6
1630 pca9544a@71 ch: 4
1631 =>
1632
1633 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1634 u-boot sends First the Commando to the mux@70 to enable
1635 channel 6, and then the Commando to the mux@71 to enable
1636 the channel 4.
1637
1638 After that, you can use the "normal" i2c commands as
1639 usual, to communicate with your I2C devices behind
1640 the 2 muxes.
1641
1642 This option is actually implemented for the bitbanging
1643 algorithm in common/soft_i2c.c and for the Hardware I2C
1644 Bus on the MPC8260. But it should be not so difficult
1645 to add this option to other architectures.
1646
Andrew Dyer2ac69852008-12-29 17:36:01 -06001647 CONFIG_SOFT_I2C_READ_REPEATED_START
1648
1649 defining this will force the i2c_read() function in
1650 the soft_i2c driver to perform an I2C repeated start
1651 between writing the address pointer and reading the
1652 data. If this define is omitted the default behaviour
1653 of doing a stop-start sequence will be used. Most I2C
1654 devices can use either method, but some require one or
1655 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06001656
wdenkc6097192002-11-03 00:24:07 +00001657- SPI Support: CONFIG_SPI
1658
1659 Enables SPI driver (so far only tested with
1660 SPI EEPROM, also an instance works with Crystal A/D and
1661 D/As on the SACSng board)
1662
1663 CONFIG_SPI_X
1664
1665 Enables extended (16-bit) SPI EEPROM addressing.
1666 (symmetrical to CONFIG_I2C_X)
1667
1668 CONFIG_SOFT_SPI
1669
wdenk43d96162003-03-06 00:02:04 +00001670 Enables a software (bit-bang) SPI driver rather than
1671 using hardware support. This is a general purpose
1672 driver that only requires three general I/O port pins
1673 (two outputs, one input) to function. If this is
1674 defined, the board configuration must define several
1675 SPI configuration items (port pins to use, etc). For
1676 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001677
Ben Warren04a9e112008-01-16 22:37:35 -05001678 CONFIG_HARD_SPI
1679
1680 Enables a hardware SPI driver for general-purpose reads
1681 and writes. As with CONFIG_SOFT_SPI, the board configuration
1682 must define a list of chip-select function pointers.
1683 Currently supported on some MPC8xxx processors. For an
1684 example, see include/configs/mpc8349emds.h.
1685
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001686 CONFIG_MXC_SPI
1687
1688 Enables the driver for the SPI controllers on i.MX and MXC
1689 SoCs. Currently only i.MX31 is supported.
1690
Matthias Fuchs01335022007-12-27 17:12:34 +01001691- FPGA Support: CONFIG_FPGA
1692
1693 Enables FPGA subsystem.
1694
1695 CONFIG_FPGA_<vendor>
1696
1697 Enables support for specific chip vendors.
1698 (ALTERA, XILINX)
1699
1700 CONFIG_FPGA_<family>
1701
1702 Enables support for FPGA family.
1703 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1704
1705 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001706
wdenk43d96162003-03-06 00:02:04 +00001707 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001709 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001710
wdenk8bde7f72003-06-27 21:31:46 +00001711 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001713 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001714
wdenk43d96162003-03-06 00:02:04 +00001715 Enable checks on FPGA configuration interface busy
1716 status by the configuration function. This option
1717 will require a board or device specific function to
1718 be written.
wdenkc6097192002-11-03 00:24:07 +00001719
1720 CONFIG_FPGA_DELAY
1721
1722 If defined, a function that provides delays in the FPGA
1723 configuration driver.
1724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001725 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001726 Allow Control-C to interrupt FPGA configuration
1727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001728 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001729
wdenk43d96162003-03-06 00:02:04 +00001730 Check for configuration errors during FPGA bitfile
1731 loading. For example, abort during Virtex II
1732 configuration if the INIT_B line goes low (which
1733 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001735 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001736
wdenk43d96162003-03-06 00:02:04 +00001737 Maximum time to wait for the INIT_B line to deassert
1738 after PROB_B has been deasserted during a Virtex II
1739 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001740 ms.
wdenkc6097192002-11-03 00:24:07 +00001741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001742 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001743
wdenk43d96162003-03-06 00:02:04 +00001744 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001745 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001746
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001747 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001748
wdenk43d96162003-03-06 00:02:04 +00001749 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001750 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001751
1752- Configuration Management:
1753 CONFIG_IDENT_STRING
1754
wdenk43d96162003-03-06 00:02:04 +00001755 If defined, this string will be added to the U-Boot
1756 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001757
1758- Vendor Parameter Protection:
1759
wdenk43d96162003-03-06 00:02:04 +00001760 U-Boot considers the values of the environment
1761 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001762 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001763 are set once by the board vendor / manufacturer, and
1764 protects these variables from casual modification by
1765 the user. Once set, these variables are read-only,
1766 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001767 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001768
1769 If CONFIG_ENV_OVERWRITE is #defined in your config
1770 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001771 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001772 these parameters.
1773
1774 Alternatively, if you #define _both_ CONFIG_ETHADDR
1775 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001776 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001777 which can be changed exactly ONCE by the user. [The
1778 serial# is unaffected by this, i. e. it remains
1779 read-only.]
1780
1781- Protected RAM:
1782 CONFIG_PRAM
1783
1784 Define this variable to enable the reservation of
1785 "protected RAM", i. e. RAM which is not overwritten
1786 by U-Boot. Define CONFIG_PRAM to hold the number of
1787 kB you want to reserve for pRAM. You can overwrite
1788 this default value by defining an environment
1789 variable "pram" to the number of kB you want to
1790 reserve. Note that the board info structure will
1791 still show the full amount of RAM. If pRAM is
1792 reserved, a new environment variable "mem" will
1793 automatically be defined to hold the amount of
1794 remaining RAM in a form that can be passed as boot
1795 argument to Linux, for instance like that:
1796
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001797 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001798 saveenv
1799
1800 This way you can tell Linux not to use this memory,
1801 either, which results in a memory region that will
1802 not be affected by reboots.
1803
1804 *WARNING* If your board configuration uses automatic
1805 detection of the RAM size, you must make sure that
1806 this memory test is non-destructive. So far, the
1807 following board configurations are known to be
1808 "pRAM-clean":
1809
1810 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1811 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001812 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001813
1814- Error Recovery:
1815 CONFIG_PANIC_HANG
1816
1817 Define this variable to stop the system in case of a
1818 fatal error, so that you have to reset it manually.
1819 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001820 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001821 automatically as fast as possible, but it may be
1822 useful during development since you can try to debug
1823 the conditions that lead to the situation.
1824
1825 CONFIG_NET_RETRY_COUNT
1826
wdenk43d96162003-03-06 00:02:04 +00001827 This variable defines the number of retries for
1828 network operations like ARP, RARP, TFTP, or BOOTP
1829 before giving up the operation. If not defined, a
1830 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001831
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001832 CONFIG_ARP_TIMEOUT
1833
1834 Timeout waiting for an ARP reply in milliseconds.
1835
wdenkc6097192002-11-03 00:24:07 +00001836- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001837 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001838
1839 Enable auto completion of commands using TAB.
1840
Wolfgang Denka9398e02006-11-27 15:32:42 +01001841 Note that this feature has NOT been implemented yet
1842 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001843
1844
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001845 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001846
1847 Define this variable to enable the "hush" shell (from
1848 Busybox) as command line interpreter, thus enabling
1849 powerful command line syntax like
1850 if...then...else...fi conditionals or `&&' and '||'
1851 constructs ("shell scripts").
1852
1853 If undefined, you get the old, much simpler behaviour
1854 with a somewhat smaller memory footprint.
1855
1856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001857 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001858
1859 This defines the secondary prompt string, which is
1860 printed when the command interpreter needs more input
1861 to complete a command. Usually "> ".
1862
1863 Note:
1864
wdenk8bde7f72003-06-27 21:31:46 +00001865 In the current implementation, the local variables
1866 space and global environment variables space are
1867 separated. Local variables are those you define by
1868 simply typing `name=value'. To access a local
1869 variable later on, you have write `$name' or
1870 `${name}'; to execute the contents of a variable
1871 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001872
wdenk43d96162003-03-06 00:02:04 +00001873 Global environment variables are those you use
1874 setenv/printenv to work with. To run a command stored
1875 in such a variable, you need to use the run command,
1876 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001877
1878 To store commands and special characters in a
1879 variable, please use double quotation marks
1880 surrounding the whole text of the variable, instead
1881 of the backslashes before semicolons and special
1882 symbols.
1883
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001884- Commandline Editing and History:
1885 CONFIG_CMDLINE_EDITING
1886
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001887 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001888 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001889
wdenka8c7c702003-12-06 19:49:23 +00001890- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001891 CONFIG_EXTRA_ENV_SETTINGS
1892
wdenk43d96162003-03-06 00:02:04 +00001893 Define this to contain any number of null terminated
1894 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001895 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001896
wdenk43d96162003-03-06 00:02:04 +00001897 For example, place something like this in your
1898 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001899
1900 #define CONFIG_EXTRA_ENV_SETTINGS \
1901 "myvar1=value1\0" \
1902 "myvar2=value2\0"
1903
wdenk43d96162003-03-06 00:02:04 +00001904 Warning: This method is based on knowledge about the
1905 internal format how the environment is stored by the
1906 U-Boot code. This is NOT an official, exported
1907 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001908 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001909 You better know what you are doing here.
1910
wdenk43d96162003-03-06 00:02:04 +00001911 Note: overly (ab)use of the default environment is
1912 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001913 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001914 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001915
wdenka8c7c702003-12-06 19:49:23 +00001916- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001917 CONFIG_HAS_DATAFLASH
1918
wdenk8bde7f72003-06-27 21:31:46 +00001919 Defining this option enables DataFlash features and
1920 allows to read/write in Dataflash via the standard
1921 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001922
wdenk3f85ce22004-02-23 16:11:30 +00001923- SystemACE Support:
1924 CONFIG_SYSTEMACE
1925
1926 Adding this option adds support for Xilinx SystemACE
1927 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001928 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001929 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001930
1931 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001932 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001933
1934 When SystemACE support is added, the "ace" device type
1935 becomes available to the fat commands, i.e. fatls.
1936
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001937- TFTP Fixed UDP Port:
1938 CONFIG_TFTP_PORT
1939
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001940 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001941 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001942 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001943 number generator is used.
1944
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001945 Also, the environment variable tftpdstp is used to supply
1946 the TFTP UDP destination port value. If tftpdstp isn't
1947 defined, the normal port 69 is used.
1948
1949 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001950 blindly start the TFTP transfer using the pre-configured
1951 target IP address and UDP port. This has the effect of
1952 "punching through" the (Windows XP) firewall, allowing
1953 the remainder of the TFTP transfer to proceed normally.
1954 A better solution is to properly configure the firewall,
1955 but sometimes that is not allowed.
1956
wdenka8c7c702003-12-06 19:49:23 +00001957- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001958 CONFIG_SHOW_BOOT_PROGRESS
1959
wdenk43d96162003-03-06 00:02:04 +00001960 Defining this option allows to add some board-
1961 specific code (calling a user-provided function
1962 "show_boot_progress(int)") that enables you to show
1963 the system's boot progress on some display (for
1964 example, some LED's) on your board. At the moment,
1965 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001966
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001967Legacy uImage format:
1968
wdenkc6097192002-11-03 00:24:07 +00001969 Arg Where When
1970 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001971 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001972 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001973 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001974 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001975 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001976 4 common/cmd_bootm.c Image data has correct checksum
1977 -4 common/cmd_bootm.c Image is for unsupported architecture
1978 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001979 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001980 6 common/cmd_bootm.c Image Type check OK
1981 -6 common/cmd_bootm.c gunzip uncompression error
1982 -7 common/cmd_bootm.c Unimplemented compression type
1983 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001984 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001985 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001986
1987 9 common/image.c Start initial ramdisk verification
1988 -10 common/image.c Ramdisk header has bad magic number
1989 -11 common/image.c Ramdisk header has bad checksum
1990 10 common/image.c Ramdisk header is OK
1991 -12 common/image.c Ramdisk data has bad checksum
1992 11 common/image.c Ramdisk data has correct checksum
1993 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001994 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001995 13 common/image.c Start multifile image verification
1996 14 common/image.c No initial ramdisk, no multifile, continue.
1997
Peter Tyserea0364f2010-04-12 22:28:04 -05001998 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001999
Stefan Roesea47a12b2010-04-15 16:07:28 +02002000 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002001 -31 post/post.c POST test failed, detected by post_output_backlog()
2002 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002003
Heiko Schocher566a4942007-06-22 19:11:54 +02002004 34 common/cmd_doc.c before loading a Image from a DOC device
2005 -35 common/cmd_doc.c Bad usage of "doc" command
2006 35 common/cmd_doc.c correct usage of "doc" command
2007 -36 common/cmd_doc.c No boot device
2008 36 common/cmd_doc.c correct boot device
2009 -37 common/cmd_doc.c Unknown Chip ID on boot device
2010 37 common/cmd_doc.c correct chip ID found, device available
2011 -38 common/cmd_doc.c Read Error on boot device
2012 38 common/cmd_doc.c reading Image header from DOC device OK
2013 -39 common/cmd_doc.c Image header has bad magic number
2014 39 common/cmd_doc.c Image header has correct magic number
2015 -40 common/cmd_doc.c Error reading Image from DOC device
2016 40 common/cmd_doc.c Image header has correct magic number
2017 41 common/cmd_ide.c before loading a Image from a IDE device
2018 -42 common/cmd_ide.c Bad usage of "ide" command
2019 42 common/cmd_ide.c correct usage of "ide" command
2020 -43 common/cmd_ide.c No boot device
2021 43 common/cmd_ide.c boot device found
2022 -44 common/cmd_ide.c Device not available
2023 44 common/cmd_ide.c Device available
2024 -45 common/cmd_ide.c wrong partition selected
2025 45 common/cmd_ide.c partition selected
2026 -46 common/cmd_ide.c Unknown partition table
2027 46 common/cmd_ide.c valid partition table found
2028 -47 common/cmd_ide.c Invalid partition type
2029 47 common/cmd_ide.c correct partition type
2030 -48 common/cmd_ide.c Error reading Image Header on boot device
2031 48 common/cmd_ide.c reading Image Header from IDE device OK
2032 -49 common/cmd_ide.c Image header has bad magic number
2033 49 common/cmd_ide.c Image header has correct magic number
2034 -50 common/cmd_ide.c Image header has bad checksum
2035 50 common/cmd_ide.c Image header has correct checksum
2036 -51 common/cmd_ide.c Error reading Image from IDE device
2037 51 common/cmd_ide.c reading Image from IDE device OK
2038 52 common/cmd_nand.c before loading a Image from a NAND device
2039 -53 common/cmd_nand.c Bad usage of "nand" command
2040 53 common/cmd_nand.c correct usage of "nand" command
2041 -54 common/cmd_nand.c No boot device
2042 54 common/cmd_nand.c boot device found
2043 -55 common/cmd_nand.c Unknown Chip ID on boot device
2044 55 common/cmd_nand.c correct chip ID found, device available
2045 -56 common/cmd_nand.c Error reading Image Header on boot device
2046 56 common/cmd_nand.c reading Image Header from NAND device OK
2047 -57 common/cmd_nand.c Image header has bad magic number
2048 57 common/cmd_nand.c Image header has correct magic number
2049 -58 common/cmd_nand.c Error reading Image from NAND device
2050 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002051
Heiko Schocher566a4942007-06-22 19:11:54 +02002052 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002053
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002054 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002055 -64 net/eth.c no Ethernet found.
2056 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002057
Heiko Schocher566a4942007-06-22 19:11:54 +02002058 -80 common/cmd_net.c usage wrong
2059 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002060 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002061 81 common/cmd_net.c NetLoop() back without error
2062 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2063 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002064 83 common/cmd_net.c running "source" command
2065 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002066 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002067
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002068FIT uImage format:
2069
2070 Arg Where When
2071 100 common/cmd_bootm.c Kernel FIT Image has correct format
2072 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2073 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2074 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2075 102 common/cmd_bootm.c Kernel unit name specified
2076 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002077 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002078 104 common/cmd_bootm.c Got kernel subimage node offset
2079 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2080 105 common/cmd_bootm.c Kernel subimage hash verification OK
2081 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2082 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002083 -106 common/cmd_bootm.c Kernel subimage has wrong type
2084 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002085 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2086 108 common/cmd_bootm.c Got kernel subimage data/size
2087 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2088 -109 common/cmd_bootm.c Can't get kernel subimage type
2089 -110 common/cmd_bootm.c Can't get kernel subimage comp
2090 -111 common/cmd_bootm.c Can't get kernel subimage os
2091 -112 common/cmd_bootm.c Can't get kernel subimage load address
2092 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2093
2094 120 common/image.c Start initial ramdisk verification
2095 -120 common/image.c Ramdisk FIT image has incorrect format
2096 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002097 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002098 -122 common/image.c Can't get configuration for ramdisk subimage
2099 123 common/image.c Ramdisk unit name specified
2100 -124 common/image.c Can't get ramdisk subimage node offset
2101 125 common/image.c Got ramdisk subimage node offset
2102 -125 common/image.c Ramdisk subimage hash verification failed
2103 126 common/image.c Ramdisk subimage hash verification OK
2104 -126 common/image.c Ramdisk subimage for unsupported architecture
2105 127 common/image.c Architecture check OK
2106 -127 common/image.c Can't get ramdisk subimage data/size
2107 128 common/image.c Got ramdisk subimage data/size
2108 129 common/image.c Can't get ramdisk load address
2109 -129 common/image.c Got ramdisk load address
2110
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002111 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002112 131 common/cmd_doc.c FIT image format OK
2113
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002114 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002115 141 common/cmd_ide.c FIT image format OK
2116
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002117 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002118 151 common/cmd_nand.c FIT image format OK
2119
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002120- Automatic software updates via TFTP server
2121 CONFIG_UPDATE_TFTP
2122 CONFIG_UPDATE_TFTP_CNT_MAX
2123 CONFIG_UPDATE_TFTP_MSEC_MAX
2124
2125 These options enable and control the auto-update feature;
2126 for a more detailed description refer to doc/README.update.
2127
2128- MTD Support (mtdparts command, UBI support)
2129 CONFIG_MTD_DEVICE
2130
2131 Adds the MTD device infrastructure from the Linux kernel.
2132 Needed for mtdparts command support.
2133
2134 CONFIG_MTD_PARTITIONS
2135
2136 Adds the MTD partitioning infrastructure from the Linux
2137 kernel. Needed for UBI support.
2138
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002139
wdenkc6097192002-11-03 00:24:07 +00002140Modem Support:
2141--------------
2142
wdenk85ec0bc2003-03-31 16:34:49 +00002143[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002144
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002145- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002146 CONFIG_MODEM_SUPPORT
2147
2148- RTS/CTS Flow control enable:
2149 CONFIG_HWFLOW
2150
2151- Modem debug support:
2152 CONFIG_MODEM_SUPPORT_DEBUG
2153
wdenk43d96162003-03-06 00:02:04 +00002154 Enables debugging stuff (char screen[1024], dbg())
2155 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002156
wdenka8c7c702003-12-06 19:49:23 +00002157- Interrupt support (PPC):
2158
wdenkd4ca31c2004-01-02 14:00:00 +00002159 There are common interrupt_init() and timer_interrupt()
2160 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002161 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002162 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002163 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002164 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002165 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002166 specific handling. If board has watchdog / status_led
2167 / other_activity_monitor it works automatically from
2168 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002169
wdenkc6097192002-11-03 00:24:07 +00002170- General:
2171
wdenk43d96162003-03-06 00:02:04 +00002172 In the target system modem support is enabled when a
2173 specific key (key combination) is pressed during
2174 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002175 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002176 board_init(). Currently key_pressed() is a dummy
2177 function, returning 1 and thus enabling modem
2178 initialization.
wdenkc6097192002-11-03 00:24:07 +00002179
wdenk43d96162003-03-06 00:02:04 +00002180 If there are no modem init strings in the
2181 environment, U-Boot proceed to autoboot; the
2182 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002183 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002184
2185 See also: doc/README.Modem
2186
2187
wdenkc6097192002-11-03 00:24:07 +00002188Configuration Settings:
2189-----------------------
2190
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002191- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002192 undefine this when you're short of memory.
2193
Peter Tyser2fb26042009-01-27 18:03:12 -06002194- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2195 width of the commands listed in the 'help' command output.
2196
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002197- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002198 prompt for user input.
2199
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002200- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002201
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002202- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002204- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002206- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002207 the application (usually a Linux kernel) when it is
2208 booted
2209
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002210- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002211 List of legal baudrate settings for this board.
2212
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002213- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002214 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002216- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002217 If the board specific function
2218 extern int overwrite_console (void);
2219 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002220 serial port, else the settings in the environment are used.
2221
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002222- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002223 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002224
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002225- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002226 Enable overwrite of previous console environment settings.
2227
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002228- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002229 Begin and End addresses of the area used by the
2230 simple memory test.
2231
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002232- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002233 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002234
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002235- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002236 Scratch address used by the alternate memory test
2237 You only need to set this if address zero isn't writeable
2238
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002239- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2240 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002241 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002242 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002243 fixing up gd->ram_size the Linux kernel should gets passed
2244 the now "corrected" memory size and won't touch it either.
2245 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002246 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002247 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002248 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002249
2250 This option can be used as a workaround for the 440EPx/GRx
2251 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2252 be touched.
2253
2254 WARNING: Please make sure that this value is a multiple of
2255 the Linux page size (normally 4k). If this is not the case,
2256 then the end address of the Linux memory will be located at a
2257 non page size aligned address and this could cause major
2258 problems.
2259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002260- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002261 Default load address for network file downloads
2262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002263- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002264 Enable temporary baudrate change while serial download
2265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002266- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002267 Physical start address of SDRAM. _Must_ be 0 here.
2268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002269- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002270 Physical start address of Motherboard I/O (if using a
2271 Cogent motherboard)
2272
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002273- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002274 Physical start address of Flash memory.
2275
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002276- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002277 Physical start address of boot monitor code (set by
2278 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002279 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002280 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002282- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002283 Size of memory reserved for monitor code, used to
2284 determine _at_compile_time_ (!) if the environment is
2285 embedded within the U-Boot image, or in a separate
2286 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002287
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002288- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002289 Size of DRAM reserved for malloc() use.
2290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002291- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002292 Normally compressed uImages are limited to an
2293 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002294 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002295 to adjust this setting to your needs.
2296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002297- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002298 Maximum size of memory mapped by the startup code of
2299 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002300 the Linux kernel (bd_info, boot arguments, FDT blob if
2301 used) must be put below this limit, unless "bootm_low"
2302 enviroment variable is defined and non-zero. In such case
2303 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002304 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002305
John Rigbyfca43cc2010-10-13 13:57:35 -06002306- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2307 Enable initrd_high functionality. If defined then the
2308 initrd_high feature is enabled and the bootm ramdisk subcommand
2309 is enabled.
2310
2311- CONFIG_SYS_BOOT_GET_CMDLINE:
2312 Enables allocating and saving kernel cmdline in space between
2313 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2314
2315- CONFIG_SYS_BOOT_GET_KBD:
2316 Enables allocating and saving a kernel copy of the bd_info in
2317 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2318
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002319- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002320 Max number of Flash memory banks
2321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002322- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002323 Max number of sectors on a Flash chip
2324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002325- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002326 Timeout for Flash erase operations (in ms)
2327
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002328- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002329 Timeout for Flash write operations (in ms)
2330
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002331- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002332 Timeout for Flash set sector lock bit operation (in ms)
2333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002334- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002335 Timeout for Flash clear lock bits operation (in ms)
2336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002337- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002338 If defined, hardware flash sectors protection is used
2339 instead of U-Boot software protection.
2340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002341- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002342
2343 Enable TFTP transfers directly to flash memory;
2344 without this option such a download has to be
2345 performed in two steps: (1) download to RAM, and (2)
2346 copy from RAM to flash.
2347
2348 The two-step approach is usually more reliable, since
2349 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002350 the flash, but in some situations (when system RAM is
2351 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002352 downloaded image) this option may be very useful.
2353
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002354- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002355 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002356 common flash structure for storing flash geometry.
2357
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002358- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002359 This option also enables the building of the cfi_flash driver
2360 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002361
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002362- CONFIG_FLASH_CFI_MTD
2363 This option enables the building of the cfi_mtd driver
2364 in the drivers directory. The driver exports CFI flash
2365 to the MTD layer.
2366
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002367- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002368 Use buffered writes to flash.
2369
2370- CONFIG_FLASH_SPANSION_S29WS_N
2371 s29ws-n MirrorBit flash has non-standard addresses for buffered
2372 write commands.
2373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002374- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002375 If this option is defined, the common CFI flash doesn't
2376 print it's warning upon not recognized FLASH banks. This
2377 is useful, if some of the configured banks are only
2378 optionally available.
2379
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002380- CONFIG_FLASH_SHOW_PROGRESS
2381 If defined (must be an integer), print out countdown
2382 digits and dots. Recommended value: 45 (9..1) for 80
2383 column displays, 15 (3..1) for 40 column displays.
2384
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002385- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002386 Defines the number of Ethernet receive buffers. On some
2387 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002388 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2389 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002390 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002391 Defaults to 4 if not defined.
2392
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002393- CONFIG_ENV_MAX_ENTRIES
2394
Wolfgang Denk071bc922010-10-27 22:48:30 +02002395 Maximum number of entries in the hash table that is used
2396 internally to store the environment settings. The default
2397 setting is supposed to be generous and should work in most
2398 cases. This setting can be used to tune behaviour; see
2399 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002400
wdenkc6097192002-11-03 00:24:07 +00002401The following definitions that deal with the placement and management
2402of environment data (variable area); in general, we support the
2403following configurations:
2404
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002405- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002406
2407 Define this if the environment is in flash memory.
2408
2409 a) The environment occupies one whole flash sector, which is
2410 "embedded" in the text segment with the U-Boot code. This
2411 happens usually with "bottom boot sector" or "top boot
2412 sector" type flash chips, which have several smaller
2413 sectors at the start or the end. For instance, such a
2414 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2415 such a case you would place the environment in one of the
2416 4 kB sectors - with U-Boot code before and after it. With
2417 "top boot sector" type flash chips, you would put the
2418 environment in one of the last sectors, leaving a gap
2419 between U-Boot and the environment.
2420
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002421 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002422
2423 Offset of environment data (variable area) to the
2424 beginning of flash memory; for instance, with bottom boot
2425 type flash chips the second sector can be used: the offset
2426 for this sector is given here.
2427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002428 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002429
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002430 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002431
2432 This is just another way to specify the start address of
2433 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002434 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002435
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002436 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002437
2438 Size of the sector containing the environment.
2439
2440
2441 b) Sometimes flash chips have few, equal sized, BIG sectors.
2442 In such a case you don't want to spend a whole sector for
2443 the environment.
2444
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002445 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002446
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002447 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002448 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002449 of this flash sector for the environment. This saves
2450 memory for the RAM copy of the environment.
2451
2452 It may also save flash memory if you decide to use this
2453 when your environment is "embedded" within U-Boot code,
2454 since then the remainder of the flash sector could be used
2455 for U-Boot code. It should be pointed out that this is
2456 STRONGLY DISCOURAGED from a robustness point of view:
2457 updating the environment in flash makes it always
2458 necessary to erase the WHOLE sector. If something goes
2459 wrong before the contents has been restored from a copy in
2460 RAM, your target system will be dead.
2461
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002462 - CONFIG_ENV_ADDR_REDUND
2463 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002464
wdenk43d96162003-03-06 00:02:04 +00002465 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002466 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002467 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002468 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002469
2470BE CAREFUL! Any changes to the flash layout, and some changes to the
2471source code will make it necessary to adapt <board>/u-boot.lds*
2472accordingly!
2473
2474
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002475- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002476
2477 Define this if you have some non-volatile memory device
2478 (NVRAM, battery buffered SRAM) which you want to use for the
2479 environment.
2480
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002481 - CONFIG_ENV_ADDR:
2482 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002483
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002484 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002485 want to use for environment. It is assumed that this memory
2486 can just be read and written to, without any special
2487 provision.
2488
2489BE CAREFUL! The first access to the environment happens quite early
2490in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002491console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002492U-Boot will hang.
2493
2494Please note that even with NVRAM we still use a copy of the
2495environment in RAM: we could work on NVRAM directly, but we want to
2496keep settings there always unmodified except somebody uses "saveenv"
2497to save the current settings.
2498
2499
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002500- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002501
2502 Use this if you have an EEPROM or similar serial access
2503 device and a driver for it.
2504
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002505 - CONFIG_ENV_OFFSET:
2506 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002507
2508 These two #defines specify the offset and size of the
2509 environment area within the total memory of your EEPROM.
2510
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002511 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002512 If defined, specified the chip address of the EEPROM device.
2513 The default address is zero.
2514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002515 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002516 If defined, the number of bits used to address bytes in a
2517 single page in the EEPROM device. A 64 byte page, for example
2518 would require six bits.
2519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002520 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002521 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002522 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002524 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002525 The length in bytes of the EEPROM memory array address. Note
2526 that this is NOT the chip address length!
2527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002528 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002529 EEPROM chips that implement "address overflow" are ones
2530 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2531 address and the extra bits end up in the "chip address" bit
2532 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2533 byte chips.
2534
2535 Note that we consider the length of the address field to
2536 still be one byte because the extra address bits are hidden
2537 in the chip address.
2538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002539 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002540 The size in bytes of the EEPROM device.
2541
Heiko Schocher548738b2010-01-07 08:55:40 +01002542 - CONFIG_ENV_EEPROM_IS_ON_I2C
2543 define this, if you have I2C and SPI activated, and your
2544 EEPROM, which holds the environment, is on the I2C bus.
2545
2546 - CONFIG_I2C_ENV_EEPROM_BUS
2547 if you have an Environment on an EEPROM reached over
2548 I2C muxes, you can define here, how to reach this
2549 EEPROM. For example:
2550
Wolfgang Denka9046b92010-06-13 17:48:15 +02002551 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002552
2553 EEPROM which holds the environment, is reached over
2554 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002555
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002556- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002557
wdenkd4ca31c2004-01-02 14:00:00 +00002558 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002559 want to use for the environment.
2560
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002561 - CONFIG_ENV_OFFSET:
2562 - CONFIG_ENV_ADDR:
2563 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002564
2565 These three #defines specify the offset and size of the
2566 environment area within the total memory of your DataFlash placed
2567 at the specified address.
2568
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002569- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002570
2571 Define this if you have a NAND device which you want to use
2572 for the environment.
2573
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002574 - CONFIG_ENV_OFFSET:
2575 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002576
2577 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002578 area within the first NAND device. CONFIG_ENV_OFFSET must be
2579 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002580
Scott Woodfdd813d2010-09-17 14:38:37 -05002581 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002582
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002583 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002584 size used to hold a redundant copy of the environment data, so
2585 that there is a valid backup copy in case there is a power failure
2586 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2587 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002588
Scott Woodfdd813d2010-09-17 14:38:37 -05002589 - CONFIG_ENV_RANGE (optional):
2590
2591 Specifies the length of the region in which the environment
2592 can be written. This should be a multiple of the NAND device's
2593 block size. Specifying a range with more erase blocks than
2594 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2595 the range to be avoided.
2596
2597 - CONFIG_ENV_OFFSET_OOB (optional):
2598
2599 Enables support for dynamically retrieving the offset of the
2600 environment from block zero's out-of-band data. The
2601 "nand env.oob" command can be used to record this offset.
2602 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2603 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002604
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002605- CONFIG_NAND_ENV_DST
2606
2607 Defines address in RAM to which the nand_spl code should copy the
2608 environment. If redundant environment is used, it will be copied to
2609 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002611- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002612
2613 Defines offset to the initial SPI buffer area in DPRAM. The
2614 area is used at an early stage (ROM part) if the environment
2615 is configured to reside in the SPI EEPROM: We need a 520 byte
2616 scratch DPRAM area. It is used between the two initialization
2617 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2618 to be a good choice since it makes it far enough from the
2619 start of the data area as well as from the stack pointer.
2620
Bruce Adlere881cb52007-11-02 13:15:42 -07002621Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002622has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002623created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002624until then to read environment variables.
2625
wdenk85ec0bc2003-03-31 16:34:49 +00002626The environment is protected by a CRC32 checksum. Before the monitor
2627is relocated into RAM, as a result of a bad CRC you will be working
2628with the compiled-in default environment - *silently*!!! [This is
2629necessary, because the first environment variable we need is the
2630"baudrate" setting for the console - if we have a bad CRC, we don't
2631have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002632
2633Note: once the monitor has been relocated, then it will complain if
2634the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002635use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002636
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002637- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002638 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002639
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002640 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002641 also needs to be defined.
2642
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002643- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002644 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002645
Ron Madridf5675aa2009-02-18 14:30:44 -08002646- CONFIG_NS16550_MIN_FUNCTIONS:
2647 Define this if you desire to only have use of the NS16550_init
2648 and NS16550_putc functions for the serial driver located at
2649 drivers/serial/ns16550.c. This option is useful for saving
2650 space for already greatly restricted images, including but not
2651 limited to NAND_SPL configurations.
2652
wdenkc6097192002-11-03 00:24:07 +00002653Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002654---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002656- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002657 Cache Line Size of the CPU.
2658
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002659- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002660 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002661
wdenk42d1f032003-10-15 23:53:47 +00002662 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2663 and RPXsuper) to be able to adjust the position of
2664 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002665
wdenk7f6c2cb2002-11-10 22:06:23 +00002666- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002667 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002668
2669 the default drive number (default value 0)
2670
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002671 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002672
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002673 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002674 (default value 1)
2675
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002676 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002677
wdenk43d96162003-03-06 00:02:04 +00002678 defines the offset of register from address. It
2679 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002680 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002681
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002682 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2683 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002684 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002686 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002687 fdc_hw_init() is called at the beginning of the FDC
2688 setup. fdc_hw_init() must be provided by the board
2689 source code. It is used to make hardware dependant
2690 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002691
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002692- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002693 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002694 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002695
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002696- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002697
wdenk7152b1d2003-09-05 23:19:14 +00002698 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002699 initial data and stack; please note that this must be
2700 writable memory that is working WITHOUT special
2701 initialization, i. e. you CANNOT use normal RAM which
2702 will become available only after programming the
2703 memory controller and running certain initialization
2704 sequences.
2705
2706 U-Boot uses the following memory types:
2707 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2708 - MPC824X: data cache
2709 - PPC4xx: data cache
2710
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002711- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002712
2713 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002714 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2715 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002716 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002717 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002718 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2719 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2720 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002721
2722 Note:
2723 On the MPC824X (or other systems that use the data
2724 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002726 point to an otherwise UNUSED address space between
2727 the top of RAM and the start of the PCI space.
2728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002729- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002731- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002735- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002736
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002737- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002739- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002740
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002741- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002742 SDRAM timing
2743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002744- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002745 periodic timer for refresh
2746
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002747- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002748
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002749- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2750 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2751 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2752 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002753 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2754
2755- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002756 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2757 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002758 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2759
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002760- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2761 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002762 Machine Mode Register and Memory Periodic Timer
2763 Prescaler definitions (SDRAM timing)
2764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002765- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002766 enable I2C microcode relocation patch (MPC8xx);
2767 define relocation offset in DPRAM [DSP2]
2768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002769- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002770 enable SMC microcode relocation patch (MPC8xx);
2771 define relocation offset in DPRAM [SMC1]
2772
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002773- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002774 enable SPI microcode relocation patch (MPC8xx);
2775 define relocation offset in DPRAM [SCC4]
2776
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002777- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002778 Use OSCM clock mode on MBX8xx board. Be careful,
2779 wrong setting might damage your board. Read
2780 doc/README.MBX before setting this variable!
2781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002782- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002783 Offset of the bootmode word in DPRAM used by post
2784 (Power On Self Tests). This definition overrides
2785 #define'd default value in commproc.h resp.
2786 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002787
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002788- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2789 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2790 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2791 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2792 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2793 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2794 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2795 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002796 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002797
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002798- CONFIG_PCI_DISABLE_PCIE:
2799 Disable PCI-Express on systems where it is supported but not
2800 required.
2801
Kumar Galaa09b9b62010-12-30 12:09:53 -06002802- CONFIG_SYS_SRIO:
2803 Chip has SRIO or not
2804
2805- CONFIG_SRIO1:
2806 Board has SRIO 1 port available
2807
2808- CONFIG_SRIO2:
2809 Board has SRIO 2 port available
2810
2811- CONFIG_SYS_SRIOn_MEM_VIRT:
2812 Virtual Address of SRIO port 'n' memory region
2813
2814- CONFIG_SYS_SRIOn_MEM_PHYS:
2815 Physical Address of SRIO port 'n' memory region
2816
2817- CONFIG_SYS_SRIOn_MEM_SIZE:
2818 Size of SRIO port 'n' memory region
2819
Ben Warrenbb99ad62006-09-07 16:50:54 -04002820- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002821 Get DDR timing information from an I2C EEPROM. Common
2822 with pluggable memory modules such as SODIMMs
2823
Ben Warrenbb99ad62006-09-07 16:50:54 -04002824 SPD_EEPROM_ADDRESS
2825 I2C address of the SPD EEPROM
2826
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002827- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002828 If SPD EEPROM is on an I2C bus other than the first
2829 one, specify here. Note that the value must resolve
2830 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002832- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002833 Only for 83xx systems. If specified, then DDR should
2834 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002835
wdenkc26e4542004-04-18 10:13:26 +00002836- CONFIG_ETHER_ON_FEC[12]
2837 Define to enable FEC[12] on a 8xx series processor.
2838
2839- CONFIG_FEC[12]_PHY
2840 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002841 to the given FEC; i. e.
2842 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002843 means that the PHY with address 4 is connected to FEC1
2844
2845 When set to -1, means to probe for first available.
2846
2847- CONFIG_FEC[12]_PHY_NORXERR
2848 The PHY does not have a RXERR line (RMII only).
2849 (so program the FEC to ignore it).
2850
2851- CONFIG_RMII
2852 Enable RMII mode for all FECs.
2853 Note that this is a global option, we can't
2854 have one FEC in standard MII mode and another in RMII mode.
2855
wdenk5cf91d62004-04-23 20:32:05 +00002856- CONFIG_CRC32_VERIFY
2857 Add a verify option to the crc32 command.
2858 The syntax is:
2859
2860 => crc32 -v <address> <count> <crc32>
2861
2862 Where address/count indicate a memory area
2863 and crc32 is the correct crc32 which the
2864 area should have.
2865
wdenk56523f12004-07-11 17:40:54 +00002866- CONFIG_LOOPW
2867 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002868 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002869
stroese7b466642004-12-16 18:46:55 +00002870- CONFIG_MX_CYCLIC
2871 Add the "mdc" and "mwc" memory commands. These are cyclic
2872 "md/mw" commands.
2873 Examples:
2874
wdenkefe2a4d2004-12-16 21:44:03 +00002875 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002876 This command will print 4 bytes (10,11,12,13) each 500 ms.
2877
wdenkefe2a4d2004-12-16 21:44:03 +00002878 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002879 This command will write 12345678 to address 100 all 10 ms.
2880
wdenkefe2a4d2004-12-16 21:44:03 +00002881 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002882 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002883
wdenk8aa1a2d2005-04-04 12:44:11 +00002884- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002885 [ARM only] If this variable is defined, then certain
2886 low level initializations (like setting up the memory
2887 controller) are omitted and/or U-Boot does not
2888 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002889
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002890 Normally this variable MUST NOT be defined. The only
2891 exception is when U-Boot is loaded (to RAM) by some
2892 other boot loader or by a debugger which performs
2893 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002894
Magnus Liljadf812382009-06-13 20:50:00 +02002895- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02002896 Modifies the behaviour of start.S when compiling a loader
2897 that is executed before the actual U-Boot. E.g. when
2898 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002899
wdenkc6097192002-11-03 00:24:07 +00002900Building the Software:
2901======================
2902
Wolfgang Denk218ca722008-03-26 10:40:12 +01002903Building U-Boot has been tested in several native build environments
2904and in many different cross environments. Of course we cannot support
2905all possibly existing versions of cross development tools in all
2906(potentially obsolete) versions. In case of tool chain problems we
2907recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2908which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002909
Wolfgang Denk218ca722008-03-26 10:40:12 +01002910If you are not using a native environment, it is assumed that you
2911have GNU cross compiling tools available in your path. In this case,
2912you must set the environment variable CROSS_COMPILE in your shell.
2913Note that no changes to the Makefile or any other source files are
2914necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002915
Wolfgang Denk218ca722008-03-26 10:40:12 +01002916 $ CROSS_COMPILE=ppc_4xx-
2917 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002918
Peter Tyser2f8d3962009-03-13 18:54:51 -05002919Note: If you wish to generate Windows versions of the utilities in
2920 the tools directory you can use the MinGW toolchain
2921 (http://www.mingw.org). Set your HOST tools to the MinGW
2922 toolchain and execute 'make tools'. For example:
2923
2924 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2925
2926 Binaries such as tools/mkimage.exe will be created which can
2927 be executed on computers running Windows.
2928
Wolfgang Denk218ca722008-03-26 10:40:12 +01002929U-Boot is intended to be simple to build. After installing the
2930sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002931is done by typing:
2932
2933 make NAME_config
2934
Wolfgang Denk218ca722008-03-26 10:40:12 +01002935where "NAME_config" is the name of one of the existing configu-
2936rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002937
wdenk2729af92004-05-03 20:45:30 +00002938Note: for some board special configuration names may exist; check if
2939 additional information is available from the board vendor; for
2940 instance, the TQM823L systems are available without (standard)
2941 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002942 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002943
wdenk2729af92004-05-03 20:45:30 +00002944 make TQM823L_config
2945 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002946
wdenk2729af92004-05-03 20:45:30 +00002947 make TQM823L_LCD_config
2948 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002949
wdenk2729af92004-05-03 20:45:30 +00002950 etc.
wdenkc6097192002-11-03 00:24:07 +00002951
wdenkc6097192002-11-03 00:24:07 +00002952
wdenk2729af92004-05-03 20:45:30 +00002953Finally, type "make all", and you should get some working U-Boot
2954images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002955
wdenk2729af92004-05-03 20:45:30 +00002956- "u-boot.bin" is a raw binary image
2957- "u-boot" is an image in ELF binary format
2958- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002959
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002960By default the build is performed locally and the objects are saved
2961in the source directory. One of the two methods can be used to change
2962this behavior and build U-Boot to some external directory:
2963
29641. Add O= to the make command line invocations:
2965
2966 make O=/tmp/build distclean
2967 make O=/tmp/build NAME_config
2968 make O=/tmp/build all
2969
29702. Set environment variable BUILD_DIR to point to the desired location:
2971
2972 export BUILD_DIR=/tmp/build
2973 make distclean
2974 make NAME_config
2975 make all
2976
2977Note that the command line "O=" setting overrides the BUILD_DIR environment
2978variable.
2979
wdenkc6097192002-11-03 00:24:07 +00002980
wdenk2729af92004-05-03 20:45:30 +00002981Please be aware that the Makefiles assume you are using GNU make, so
2982for instance on NetBSD you might need to use "gmake" instead of
2983native "make".
wdenkc6097192002-11-03 00:24:07 +00002984
wdenkc6097192002-11-03 00:24:07 +00002985
wdenk2729af92004-05-03 20:45:30 +00002986If the system board that you have is not listed, then you will need
2987to port U-Boot to your hardware platform. To do this, follow these
2988steps:
wdenkc6097192002-11-03 00:24:07 +00002989
wdenk2729af92004-05-03 20:45:30 +000029901. Add a new configuration option for your board to the toplevel
2991 "Makefile" and to the "MAKEALL" script, using the existing
2992 entries as examples. Note that here and at many other places
2993 boards and other names are listed in alphabetical sort order. Please
2994 keep this order.
29952. Create a new directory to hold your board specific code. Add any
2996 files you need. In your board directory, you will need at least
2997 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
29983. Create a new configuration file "include/configs/<board>.h" for
2999 your board
30003. If you're porting U-Boot to a new CPU, then also create a new
3001 directory to hold your CPU specific code. Add any files you need.
30024. Run "make <board>_config" with your new name.
30035. Type "make", and you should get a working "u-boot.srec" file
3004 to be installed on your target system.
30056. Debug and solve any problems that might arise.
3006 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003007
wdenkc6097192002-11-03 00:24:07 +00003008
wdenk2729af92004-05-03 20:45:30 +00003009Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3010==============================================================
wdenkc6097192002-11-03 00:24:07 +00003011
Wolfgang Denk218ca722008-03-26 10:40:12 +01003012If you have modified U-Boot sources (for instance added a new board
3013or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003014provide feedback to the other developers. The feedback normally takes
3015the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003016official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003017
Wolfgang Denk218ca722008-03-26 10:40:12 +01003018But before you submit such a patch, please verify that your modifi-
3019cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003020the supported boards compile WITHOUT ANY compiler warnings. To do so,
3021just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003022for ALL supported system. Be warned, this will take a while. You can
3023select which (cross) compiler to use by passing a `CROSS_COMPILE'
3024environment variable to the script, i. e. to use the ELDK cross tools
3025you can type
wdenkc6097192002-11-03 00:24:07 +00003026
wdenk2729af92004-05-03 20:45:30 +00003027 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003028
wdenk2729af92004-05-03 20:45:30 +00003029or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003030
wdenk2729af92004-05-03 20:45:30 +00003031 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003032
Wolfgang Denk218ca722008-03-26 10:40:12 +01003033When using the MAKEALL script, the default behaviour is to build
3034U-Boot in the source directory. This location can be changed by
3035setting the BUILD_DIR environment variable. Also, for each target
3036built, the MAKEALL script saves two log files (<target>.ERR and
3037<target>.MAKEALL) in the <source dir>/LOG directory. This default
3038location can be changed by setting the MAKEALL_LOGDIR environment
3039variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003040
3041 export BUILD_DIR=/tmp/build
3042 export MAKEALL_LOGDIR=/tmp/log
3043 CROSS_COMPILE=ppc_8xx- MAKEALL
3044
Wolfgang Denk218ca722008-03-26 10:40:12 +01003045With the above settings build objects are saved in the /tmp/build,
3046log files are saved in the /tmp/log and the source tree remains clean
3047during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003048
3049
wdenk2729af92004-05-03 20:45:30 +00003050See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003051
wdenkc6097192002-11-03 00:24:07 +00003052
wdenk2729af92004-05-03 20:45:30 +00003053Monitor Commands - Overview:
3054============================
wdenkc6097192002-11-03 00:24:07 +00003055
wdenk2729af92004-05-03 20:45:30 +00003056go - start application at address 'addr'
3057run - run commands in an environment variable
3058bootm - boot application image from memory
3059bootp - boot image via network using BootP/TFTP protocol
3060tftpboot- boot image via network using TFTP protocol
3061 and env variables "ipaddr" and "serverip"
3062 (and eventually "gatewayip")
3063rarpboot- boot image via network using RARP/TFTP protocol
3064diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3065loads - load S-Record file over serial line
3066loadb - load binary file over serial line (kermit mode)
3067md - memory display
3068mm - memory modify (auto-incrementing)
3069nm - memory modify (constant address)
3070mw - memory write (fill)
3071cp - memory copy
3072cmp - memory compare
3073crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003074i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003075sspi - SPI utility commands
3076base - print or set address offset
3077printenv- print environment variables
3078setenv - set environment variables
3079saveenv - save environment variables to persistent storage
3080protect - enable or disable FLASH write protection
3081erase - erase FLASH memory
3082flinfo - print FLASH memory information
3083bdinfo - print Board Info structure
3084iminfo - print header information for application image
3085coninfo - print console devices and informations
3086ide - IDE sub-system
3087loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003088loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003089mtest - simple RAM test
3090icache - enable or disable instruction cache
3091dcache - enable or disable data cache
3092reset - Perform RESET of the CPU
3093echo - echo args to console
3094version - print monitor version
3095help - print online help
3096? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003097
wdenkc6097192002-11-03 00:24:07 +00003098
wdenk2729af92004-05-03 20:45:30 +00003099Monitor Commands - Detailed Description:
3100========================================
wdenkc6097192002-11-03 00:24:07 +00003101
wdenk2729af92004-05-03 20:45:30 +00003102TODO.
wdenkc6097192002-11-03 00:24:07 +00003103
wdenk2729af92004-05-03 20:45:30 +00003104For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003105
3106
wdenk2729af92004-05-03 20:45:30 +00003107Environment Variables:
3108======================
wdenkc6097192002-11-03 00:24:07 +00003109
wdenk2729af92004-05-03 20:45:30 +00003110U-Boot supports user configuration using Environment Variables which
3111can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003112
wdenk2729af92004-05-03 20:45:30 +00003113Environment Variables are set using "setenv", printed using
3114"printenv", and saved to Flash using "saveenv". Using "setenv"
3115without a value can be used to delete a variable from the
3116environment. As long as you don't save the environment you are
3117working with an in-memory copy. In case the Flash area containing the
3118environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003119
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003120Some configuration options can be set using Environment Variables.
3121
3122List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003123
wdenk2729af92004-05-03 20:45:30 +00003124 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003125
wdenk2729af92004-05-03 20:45:30 +00003126 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003127
wdenk2729af92004-05-03 20:45:30 +00003128 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003129
wdenk2729af92004-05-03 20:45:30 +00003130 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003131
wdenk2729af92004-05-03 20:45:30 +00003132 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003133
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003134 bootm_low - Memory range available for image processing in the bootm
3135 command can be restricted. This variable is given as
3136 a hexadecimal number and defines lowest address allowed
3137 for use by the bootm command. See also "bootm_size"
3138 environment variable. Address defined by "bootm_low" is
3139 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003140 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003141
3142 bootm_size - Memory range available for image processing in the bootm
3143 command can be restricted. This variable is given as
3144 a hexadecimal number and defines the size of the region
3145 allowed for use by the bootm command. See also "bootm_low"
3146 environment variable.
3147
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003148 updatefile - Location of the software update file on a TFTP server, used
3149 by the automatic software update feature. Please refer to
3150 documentation in doc/README.update for more details.
3151
wdenk2729af92004-05-03 20:45:30 +00003152 autoload - if set to "no" (any string beginning with 'n'),
3153 "bootp" will just load perform a lookup of the
3154 configuration from the BOOTP server, but not try to
3155 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003156
wdenk2729af92004-05-03 20:45:30 +00003157 autostart - if set to "yes", an image loaded using the "bootp",
3158 "rarpboot", "tftpboot" or "diskboot" commands will
3159 be automatically started (by internally calling
3160 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003161
wdenk2729af92004-05-03 20:45:30 +00003162 If set to "no", a standalone image passed to the
3163 "bootm" command will be copied to the load address
3164 (and eventually uncompressed), but NOT be started.
3165 This can be used to load and uncompress arbitrary
3166 data.
wdenkc6097192002-11-03 00:24:07 +00003167
wdenk17ea1172004-06-06 21:51:03 +00003168 i2cfast - (PPC405GP|PPC405EP only)
3169 if set to 'y' configures Linux I2C driver for fast
3170 mode (400kHZ). This environment variable is used in
3171 initialization code. So, for changes to be effective
3172 it must be saved and board must be reset.
3173
wdenk2729af92004-05-03 20:45:30 +00003174 initrd_high - restrict positioning of initrd images:
3175 If this variable is not set, initrd images will be
3176 copied to the highest possible address in RAM; this
3177 is usually what you want since it allows for
3178 maximum initrd size. If for some reason you want to
3179 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003180 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003181 variable to a value of "no" or "off" or "0".
3182 Alternatively, you can set it to a maximum upper
3183 address to use (U-Boot will still check that it
3184 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003185
wdenk2729af92004-05-03 20:45:30 +00003186 For instance, when you have a system with 16 MB
3187 RAM, and want to reserve 4 MB from use by Linux,
3188 you can do this by adding "mem=12M" to the value of
3189 the "bootargs" variable. However, now you must make
3190 sure that the initrd image is placed in the first
3191 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003192
wdenk2729af92004-05-03 20:45:30 +00003193 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003194
wdenk2729af92004-05-03 20:45:30 +00003195 If you set initrd_high to 0xFFFFFFFF, this is an
3196 indication to U-Boot that all addresses are legal
3197 for the Linux kernel, including addresses in flash
3198 memory. In this case U-Boot will NOT COPY the
3199 ramdisk at all. This may be useful to reduce the
3200 boot time on your system, but requires that this
3201 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003202
wdenk2729af92004-05-03 20:45:30 +00003203 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003204
wdenk2729af92004-05-03 20:45:30 +00003205 loadaddr - Default load address for commands like "bootp",
3206 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003207
wdenk2729af92004-05-03 20:45:30 +00003208 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003209
wdenk2729af92004-05-03 20:45:30 +00003210 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003211
wdenk2729af92004-05-03 20:45:30 +00003212 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003213
wdenk2729af92004-05-03 20:45:30 +00003214 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003215
wdenk2729af92004-05-03 20:45:30 +00003216 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003217
wdenk2729af92004-05-03 20:45:30 +00003218 ethprime - When CONFIG_NET_MULTI is enabled controls which
3219 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003220
wdenk2729af92004-05-03 20:45:30 +00003221 ethact - When CONFIG_NET_MULTI is enabled controls which
3222 interface is currently active. For example you
3223 can do the following
wdenkc6097192002-11-03 00:24:07 +00003224
Heiko Schocher48690d82010-07-20 17:45:02 +02003225 => setenv ethact FEC
3226 => ping 192.168.0.1 # traffic sent on FEC
3227 => setenv ethact SCC
3228 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003229
Matthias Fuchse1692572008-01-17 07:45:05 +01003230 ethrotate - When set to "no" U-Boot does not go through all
3231 available network interfaces.
3232 It just stays at the currently selected interface.
3233
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003234 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003235 either succeed or fail without retrying.
3236 When set to "once" the network operation will
3237 fail when all the available network interfaces
3238 are tried once without success.
3239 Useful on scripts which control the retry operation
3240 themselves.
wdenkc6097192002-11-03 00:24:07 +00003241
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003242 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003243
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003244 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003245 UDP source port.
3246
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003247 tftpdstport - If this is set, the value is used for TFTP's UDP
3248 destination port instead of the Well Know Port 69.
3249
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003250 tftpblocksize - Block size to use for TFTP transfers; if not set,
3251 we use the TFTP server's default block size
3252
3253 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3254 seconds, minimum value is 1000 = 1 second). Defines
3255 when a packet is considered to be lost so it has to
3256 be retransmitted. The default is 5000 = 5 seconds.
3257 Lowering this value may make downloads succeed
3258 faster in networks with high packet loss rates or
3259 with unreliable TFTP servers.
3260
3261 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003262 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003263 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003264
wdenk2729af92004-05-03 20:45:30 +00003265The following environment variables may be used and automatically
3266updated by the network boot commands ("bootp" and "rarpboot"),
3267depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003268
wdenk2729af92004-05-03 20:45:30 +00003269 bootfile - see above
3270 dnsip - IP address of your Domain Name Server
3271 dnsip2 - IP address of your secondary Domain Name Server
3272 gatewayip - IP address of the Gateway (Router) to use
3273 hostname - Target hostname
3274 ipaddr - see above
3275 netmask - Subnet Mask
3276 rootpath - Pathname of the root filesystem on the NFS server
3277 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003278
wdenka3d991b2004-04-15 21:48:45 +00003279
wdenk2729af92004-05-03 20:45:30 +00003280There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk2729af92004-05-03 20:45:30 +00003282 serial# - contains hardware identification information such
3283 as type string and/or serial number
3284 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003285
wdenk2729af92004-05-03 20:45:30 +00003286These variables can be set only once (usually during manufacturing of
3287the board). U-Boot refuses to delete or overwrite these variables
3288once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003289
3290
wdenk2729af92004-05-03 20:45:30 +00003291Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk2729af92004-05-03 20:45:30 +00003293 ver - Contains the U-Boot version string as printed
3294 with the "version" command. This variable is
3295 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003296
wdenkc6097192002-11-03 00:24:07 +00003297
wdenk2729af92004-05-03 20:45:30 +00003298Please note that changes to some configuration parameters may take
3299only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003300
stroesec1551ea2003-04-04 15:53:41 +00003301
wdenk2729af92004-05-03 20:45:30 +00003302Command Line Parsing:
3303=====================
stroesec1551ea2003-04-04 15:53:41 +00003304
wdenk2729af92004-05-03 20:45:30 +00003305There are two different command line parsers available with U-Boot:
3306the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003307
wdenk2729af92004-05-03 20:45:30 +00003308Old, simple command line parser:
3309--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003310
wdenk2729af92004-05-03 20:45:30 +00003311- supports environment variables (through setenv / saveenv commands)
3312- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003313- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003314- special characters ('$', ';') can be escaped by prefixing with '\',
3315 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003316 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003317- You can also escape text by enclosing in single apostrophes, for example:
3318 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003319
wdenk2729af92004-05-03 20:45:30 +00003320Hush shell:
3321-----------
wdenkf07771c2003-05-28 08:06:31 +00003322
wdenk2729af92004-05-03 20:45:30 +00003323- similar to Bourne shell, with control structures like
3324 if...then...else...fi, for...do...done; while...do...done,
3325 until...do...done, ...
3326- supports environment ("global") variables (through setenv / saveenv
3327 commands) and local shell variables (through standard shell syntax
3328 "name=value"); only environment variables can be used with "run"
3329 command
wdenkf07771c2003-05-28 08:06:31 +00003330
wdenk2729af92004-05-03 20:45:30 +00003331General rules:
3332--------------
wdenkf07771c2003-05-28 08:06:31 +00003333
wdenk2729af92004-05-03 20:45:30 +00003334(1) If a command line (or an environment variable executed by a "run"
3335 command) contains several commands separated by semicolon, and
3336 one of these commands fails, then the remaining commands will be
3337 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003338
wdenk2729af92004-05-03 20:45:30 +00003339(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003340 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003341 command will cause "run" to terminate, i. e. the remaining
3342 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003343
wdenk2729af92004-05-03 20:45:30 +00003344Note for Redundant Ethernet Interfaces:
3345=======================================
wdenkf07771c2003-05-28 08:06:31 +00003346
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003347Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003348such configurations and is capable of automatic selection of a
3349"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003350
wdenk2729af92004-05-03 20:45:30 +00003351Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3352MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3353"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003354
wdenk2729af92004-05-03 20:45:30 +00003355If the network interface stores some valid MAC address (for instance
3356in SROM), this is used as default address if there is NO correspon-
3357ding setting in the environment; if the corresponding environment
3358variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003359
wdenk2729af92004-05-03 20:45:30 +00003360o If the SROM has a valid MAC address, and there is no address in the
3361 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003362
wdenk2729af92004-05-03 20:45:30 +00003363o If there is no valid address in the SROM, and a definition in the
3364 environment exists, then the value from the environment variable is
3365 used.
wdenkc6097192002-11-03 00:24:07 +00003366
wdenk2729af92004-05-03 20:45:30 +00003367o If both the SROM and the environment contain a MAC address, and
3368 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003369
wdenk2729af92004-05-03 20:45:30 +00003370o If both the SROM and the environment contain a MAC address, and the
3371 addresses differ, the value from the environment is used and a
3372 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003373
wdenk2729af92004-05-03 20:45:30 +00003374o If neither SROM nor the environment contain a MAC address, an error
3375 is raised.
wdenkc6097192002-11-03 00:24:07 +00003376
Ben Warrenecee9322010-04-26 11:11:46 -07003377If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3378will be programmed into hardware as part of the initialization process. This
3379may be skipped by setting the appropriate 'ethmacskip' environment variable.
3380The naming convention is as follows:
3381"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003382
wdenk2729af92004-05-03 20:45:30 +00003383Image Formats:
3384==============
wdenkc6097192002-11-03 00:24:07 +00003385
Marian Balakowicz3310c542008-03-12 12:13:13 +01003386U-Boot is capable of booting (and performing other auxiliary operations on)
3387images in two formats:
3388
3389New uImage format (FIT)
3390-----------------------
3391
3392Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3393to Flattened Device Tree). It allows the use of images with multiple
3394components (several kernels, ramdisks, etc.), with contents protected by
3395SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3396
3397
3398Old uImage format
3399-----------------
3400
3401Old image format is based on binary files which can be basically anything,
3402preceded by a special header; see the definitions in include/image.h for
3403details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003404
wdenk2729af92004-05-03 20:45:30 +00003405* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3406 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003407 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3408 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3409 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003410* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003411 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3412 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003413* Compression Type (uncompressed, gzip, bzip2)
3414* Load Address
3415* Entry Point
3416* Image Name
3417* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003418
wdenk2729af92004-05-03 20:45:30 +00003419The header is marked by a special Magic Number, and both the header
3420and the data portions of the image are secured against corruption by
3421CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003422
wdenkc6097192002-11-03 00:24:07 +00003423
wdenk2729af92004-05-03 20:45:30 +00003424Linux Support:
3425==============
wdenkc6097192002-11-03 00:24:07 +00003426
wdenk2729af92004-05-03 20:45:30 +00003427Although U-Boot should support any OS or standalone application
3428easily, the main focus has always been on Linux during the design of
3429U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003430
wdenk2729af92004-05-03 20:45:30 +00003431U-Boot includes many features that so far have been part of some
3432special "boot loader" code within the Linux kernel. Also, any
3433"initrd" images to be used are no longer part of one big Linux image;
3434instead, kernel and "initrd" are separate images. This implementation
3435serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003436
wdenk2729af92004-05-03 20:45:30 +00003437- the same features can be used for other OS or standalone
3438 applications (for instance: using compressed images to reduce the
3439 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003440
wdenk2729af92004-05-03 20:45:30 +00003441- it becomes much easier to port new Linux kernel versions because
3442 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003443
wdenk2729af92004-05-03 20:45:30 +00003444- the same Linux kernel image can now be used with different "initrd"
3445 images; of course this also means that different kernel images can
3446 be run with the same "initrd". This makes testing easier (you don't
3447 have to build a new "zImage.initrd" Linux image when you just
3448 change a file in your "initrd"). Also, a field-upgrade of the
3449 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003450
wdenkc6097192002-11-03 00:24:07 +00003451
wdenk2729af92004-05-03 20:45:30 +00003452Linux HOWTO:
3453============
wdenkc6097192002-11-03 00:24:07 +00003454
wdenk2729af92004-05-03 20:45:30 +00003455Porting Linux to U-Boot based systems:
3456---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003457
wdenk2729af92004-05-03 20:45:30 +00003458U-Boot cannot save you from doing all the necessary modifications to
3459configure the Linux device drivers for use with your target hardware
3460(no, we don't intend to provide a full virtual machine interface to
3461Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003462
Stefan Roesea47a12b2010-04-15 16:07:28 +02003463But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003464
wdenk2729af92004-05-03 20:45:30 +00003465Just make sure your machine specific header file (for instance
3466include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003467Information structure as we define in include/asm-<arch>/u-boot.h,
3468and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003469as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003470
wdenkc6097192002-11-03 00:24:07 +00003471
wdenk2729af92004-05-03 20:45:30 +00003472Configuring the Linux kernel:
3473-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003474
wdenk2729af92004-05-03 20:45:30 +00003475No specific requirements for U-Boot. Make sure you have some root
3476device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003477
wdenkc6097192002-11-03 00:24:07 +00003478
wdenk2729af92004-05-03 20:45:30 +00003479Building a Linux Image:
3480-----------------------
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk2729af92004-05-03 20:45:30 +00003482With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3483not used. If you use recent kernel source, a new build target
3484"uImage" will exist which automatically builds an image usable by
3485U-Boot. Most older kernels also have support for a "pImage" target,
3486which was introduced for our predecessor project PPCBoot and uses a
3487100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003488
wdenk2729af92004-05-03 20:45:30 +00003489Example:
wdenkc6097192002-11-03 00:24:07 +00003490
wdenk2729af92004-05-03 20:45:30 +00003491 make TQM850L_config
3492 make oldconfig
3493 make dep
3494 make uImage
wdenkc6097192002-11-03 00:24:07 +00003495
wdenk2729af92004-05-03 20:45:30 +00003496The "uImage" build target uses a special tool (in 'tools/mkimage') to
3497encapsulate a compressed Linux kernel image with header information,
3498CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003499
wdenk2729af92004-05-03 20:45:30 +00003500* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003501
wdenk2729af92004-05-03 20:45:30 +00003502* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504 ${CROSS_COMPILE}-objcopy -O binary \
3505 -R .note -R .comment \
3506 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk2729af92004-05-03 20:45:30 +00003508* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003511
wdenk2729af92004-05-03 20:45:30 +00003512* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003513
wdenk2729af92004-05-03 20:45:30 +00003514 mkimage -A ppc -O linux -T kernel -C gzip \
3515 -a 0 -e 0 -n "Linux Kernel Image" \
3516 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003517
wdenk24ee89b2002-11-03 17:56:27 +00003518
wdenk2729af92004-05-03 20:45:30 +00003519The "mkimage" tool can also be used to create ramdisk images for use
3520with U-Boot, either separated from the Linux kernel image, or
3521combined into one file. "mkimage" encapsulates the images with a 64
3522byte header containing information about target architecture,
3523operating system, image type, compression method, entry points, time
3524stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003525
wdenk2729af92004-05-03 20:45:30 +00003526"mkimage" can be called in two ways: to verify existing images and
3527print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003528
wdenk2729af92004-05-03 20:45:30 +00003529In the first form (with "-l" option) mkimage lists the information
3530contained in the header of an existing U-Boot image; this includes
3531checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003532
wdenk2729af92004-05-03 20:45:30 +00003533 tools/mkimage -l image
3534 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003535
wdenk2729af92004-05-03 20:45:30 +00003536The second form (with "-d" option) is used to build a U-Boot image
3537from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003538
wdenk2729af92004-05-03 20:45:30 +00003539 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3540 -n name -d data_file image
3541 -A ==> set architecture to 'arch'
3542 -O ==> set operating system to 'os'
3543 -T ==> set image type to 'type'
3544 -C ==> set compression type 'comp'
3545 -a ==> set load address to 'addr' (hex)
3546 -e ==> set entry point to 'ep' (hex)
3547 -n ==> set image name to 'name'
3548 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003549
wdenk69459792004-05-29 16:53:29 +00003550Right now, all Linux kernels for PowerPC systems use the same load
3551address (0x00000000), but the entry point address depends on the
3552kernel version:
wdenkc6097192002-11-03 00:24:07 +00003553
wdenk2729af92004-05-03 20:45:30 +00003554- 2.2.x kernels have the entry point at 0x0000000C,
3555- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003556
wdenk2729af92004-05-03 20:45:30 +00003557So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003558
wdenk2729af92004-05-03 20:45:30 +00003559 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3560 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003561 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003562 > examples/uImage.TQM850L
3563 Image Name: 2.4.4 kernel for TQM850L
3564 Created: Wed Jul 19 02:34:59 2000
3565 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3566 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3567 Load Address: 0x00000000
3568 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003569
wdenk2729af92004-05-03 20:45:30 +00003570To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003571
wdenk2729af92004-05-03 20:45:30 +00003572 -> tools/mkimage -l examples/uImage.TQM850L
3573 Image Name: 2.4.4 kernel for TQM850L
3574 Created: Wed Jul 19 02:34:59 2000
3575 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3576 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3577 Load Address: 0x00000000
3578 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003579
wdenk2729af92004-05-03 20:45:30 +00003580NOTE: for embedded systems where boot time is critical you can trade
3581speed for memory and install an UNCOMPRESSED image instead: this
3582needs more space in Flash, but boots much faster since it does not
3583need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003584
Stefan Roesea47a12b2010-04-15 16:07:28 +02003585 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003586 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3587 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003588 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003589 > examples/uImage.TQM850L-uncompressed
3590 Image Name: 2.4.4 kernel for TQM850L
3591 Created: Wed Jul 19 02:34:59 2000
3592 Image Type: PowerPC Linux Kernel Image (uncompressed)
3593 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3594 Load Address: 0x00000000
3595 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003596
wdenkc6097192002-11-03 00:24:07 +00003597
wdenk2729af92004-05-03 20:45:30 +00003598Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3599when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003600
wdenk2729af92004-05-03 20:45:30 +00003601 -> tools/mkimage -n 'Simple Ramdisk Image' \
3602 > -A ppc -O linux -T ramdisk -C gzip \
3603 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3604 Image Name: Simple Ramdisk Image
3605 Created: Wed Jan 12 14:01:50 2000
3606 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3607 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3608 Load Address: 0x00000000
3609 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003610
wdenkdb01a2e2004-04-15 23:14:49 +00003611
wdenk2729af92004-05-03 20:45:30 +00003612Installing a Linux Image:
3613-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003614
wdenk2729af92004-05-03 20:45:30 +00003615To downloading a U-Boot image over the serial (console) interface,
3616you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003617
wdenk2729af92004-05-03 20:45:30 +00003618 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003619
wdenk2729af92004-05-03 20:45:30 +00003620The 'objcopy' does not understand the information in the U-Boot
3621image header, so the resulting S-Record file will be relative to
3622address 0x00000000. To load it to a given address, you need to
3623specify the target address as 'offset' parameter with the 'loads'
3624command.
wdenkc6097192002-11-03 00:24:07 +00003625
wdenk2729af92004-05-03 20:45:30 +00003626Example: install the image to address 0x40100000 (which on the
3627TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003628
wdenk2729af92004-05-03 20:45:30 +00003629 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003630
wdenk2729af92004-05-03 20:45:30 +00003631 .......... done
3632 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003633
wdenk2729af92004-05-03 20:45:30 +00003634 => loads 40100000
3635 ## Ready for S-Record download ...
3636 ~>examples/image.srec
3637 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3638 ...
3639 15989 15990 15991 15992
3640 [file transfer complete]
3641 [connected]
3642 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003643
3644
wdenk2729af92004-05-03 20:45:30 +00003645You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003646this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003647corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003648
wdenk2729af92004-05-03 20:45:30 +00003649 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003650
wdenk2729af92004-05-03 20:45:30 +00003651 ## Checking Image at 40100000 ...
3652 Image Name: 2.2.13 for initrd on TQM850L
3653 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3654 Data Size: 335725 Bytes = 327 kB = 0 MB
3655 Load Address: 00000000
3656 Entry Point: 0000000c
3657 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003658
3659
wdenk2729af92004-05-03 20:45:30 +00003660Boot Linux:
3661-----------
wdenkc6097192002-11-03 00:24:07 +00003662
wdenk2729af92004-05-03 20:45:30 +00003663The "bootm" command is used to boot an application that is stored in
3664memory (RAM or Flash). In case of a Linux kernel image, the contents
3665of the "bootargs" environment variable is passed to the kernel as
3666parameters. You can check and modify this variable using the
3667"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003668
3669
wdenk2729af92004-05-03 20:45:30 +00003670 => printenv bootargs
3671 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003672
wdenk2729af92004-05-03 20:45:30 +00003673 => 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 +00003674
wdenk2729af92004-05-03 20:45:30 +00003675 => printenv bootargs
3676 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 +00003677
wdenk2729af92004-05-03 20:45:30 +00003678 => bootm 40020000
3679 ## Booting Linux kernel at 40020000 ...
3680 Image Name: 2.2.13 for NFS on TQM850L
3681 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3682 Data Size: 381681 Bytes = 372 kB = 0 MB
3683 Load Address: 00000000
3684 Entry Point: 0000000c
3685 Verifying Checksum ... OK
3686 Uncompressing Kernel Image ... OK
3687 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
3688 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3689 time_init: decrementer frequency = 187500000/60
3690 Calibrating delay loop... 49.77 BogoMIPS
3691 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3692 ...
wdenkc6097192002-11-03 00:24:07 +00003693
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003694If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003695the memory addresses of both the kernel and the initrd image (PPBCOOT
3696format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003697
wdenk2729af92004-05-03 20:45:30 +00003698 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk2729af92004-05-03 20:45:30 +00003700 ## Checking Image at 40100000 ...
3701 Image Name: 2.2.13 for initrd on TQM850L
3702 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3703 Data Size: 335725 Bytes = 327 kB = 0 MB
3704 Load Address: 00000000
3705 Entry Point: 0000000c
3706 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003707
wdenk2729af92004-05-03 20:45:30 +00003708 ## Checking Image at 40200000 ...
3709 Image Name: Simple Ramdisk Image
3710 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3711 Data Size: 566530 Bytes = 553 kB = 0 MB
3712 Load Address: 00000000
3713 Entry Point: 00000000
3714 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003715
wdenk2729af92004-05-03 20:45:30 +00003716 => bootm 40100000 40200000
3717 ## Booting Linux kernel at 40100000 ...
3718 Image Name: 2.2.13 for initrd on TQM850L
3719 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3720 Data Size: 335725 Bytes = 327 kB = 0 MB
3721 Load Address: 00000000
3722 Entry Point: 0000000c
3723 Verifying Checksum ... OK
3724 Uncompressing Kernel Image ... OK
3725 ## Loading RAMDisk Image at 40200000 ...
3726 Image Name: Simple Ramdisk Image
3727 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3728 Data Size: 566530 Bytes = 553 kB = 0 MB
3729 Load Address: 00000000
3730 Entry Point: 00000000
3731 Verifying Checksum ... OK
3732 Loading Ramdisk ... OK
3733 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
3734 Boot arguments: root=/dev/ram
3735 time_init: decrementer frequency = 187500000/60
3736 Calibrating delay loop... 49.77 BogoMIPS
3737 ...
3738 RAMDISK: Compressed image found at block 0
3739 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003740
wdenk2729af92004-05-03 20:45:30 +00003741 bash#
wdenkc6097192002-11-03 00:24:07 +00003742
Matthew McClintock02677682006-06-28 10:41:37 -05003743Boot Linux and pass a flat device tree:
3744-----------
3745
3746First, U-Boot must be compiled with the appropriate defines. See the section
3747titled "Linux Kernel Interface" above for a more in depth explanation. The
3748following is an example of how to start a kernel and pass an updated
3749flat device tree:
3750
3751=> print oftaddr
3752oftaddr=0x300000
3753=> print oft
3754oft=oftrees/mpc8540ads.dtb
3755=> tftp $oftaddr $oft
3756Speed: 1000, full duplex
3757Using TSEC0 device
3758TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3759Filename 'oftrees/mpc8540ads.dtb'.
3760Load address: 0x300000
3761Loading: #
3762done
3763Bytes transferred = 4106 (100a hex)
3764=> tftp $loadaddr $bootfile
3765Speed: 1000, full duplex
3766Using TSEC0 device
3767TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3768Filename 'uImage'.
3769Load address: 0x200000
3770Loading:############
3771done
3772Bytes transferred = 1029407 (fb51f hex)
3773=> print loadaddr
3774loadaddr=200000
3775=> print oftaddr
3776oftaddr=0x300000
3777=> bootm $loadaddr - $oftaddr
3778## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003779 Image Name: Linux-2.6.17-dirty
3780 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3781 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003782 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003783 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003784 Verifying Checksum ... OK
3785 Uncompressing Kernel Image ... OK
3786Booting using flat device tree at 0x300000
3787Using MPC85xx ADS machine description
3788Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3789[snip]
3790
3791
wdenk2729af92004-05-03 20:45:30 +00003792More About U-Boot Image Types:
3793------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003794
wdenk2729af92004-05-03 20:45:30 +00003795U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003796
wdenk2729af92004-05-03 20:45:30 +00003797 "Standalone Programs" are directly runnable in the environment
3798 provided by U-Boot; it is expected that (if they behave
3799 well) you can continue to work in U-Boot after return from
3800 the Standalone Program.
3801 "OS Kernel Images" are usually images of some Embedded OS which
3802 will take over control completely. Usually these programs
3803 will install their own set of exception handlers, device
3804 drivers, set up the MMU, etc. - this means, that you cannot
3805 expect to re-enter U-Boot except by resetting the CPU.
3806 "RAMDisk Images" are more or less just data blocks, and their
3807 parameters (address, size) are passed to an OS kernel that is
3808 being started.
3809 "Multi-File Images" contain several images, typically an OS
3810 (Linux) kernel image and one or more data images like
3811 RAMDisks. This construct is useful for instance when you want
3812 to boot over the network using BOOTP etc., where the boot
3813 server provides just a single image file, but you want to get
3814 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003815
wdenk2729af92004-05-03 20:45:30 +00003816 "Multi-File Images" start with a list of image sizes, each
3817 image size (in bytes) specified by an "uint32_t" in network
3818 byte order. This list is terminated by an "(uint32_t)0".
3819 Immediately after the terminating 0 follow the images, one by
3820 one, all aligned on "uint32_t" boundaries (size rounded up to
3821 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003822
wdenk2729af92004-05-03 20:45:30 +00003823 "Firmware Images" are binary images containing firmware (like
3824 U-Boot or FPGA images) which usually will be programmed to
3825 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003826
wdenk2729af92004-05-03 20:45:30 +00003827 "Script files" are command sequences that will be executed by
3828 U-Boot's command interpreter; this feature is especially
3829 useful when you configure U-Boot to use a real shell (hush)
3830 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003831
wdenkc6097192002-11-03 00:24:07 +00003832
wdenk2729af92004-05-03 20:45:30 +00003833Standalone HOWTO:
3834=================
wdenkc6097192002-11-03 00:24:07 +00003835
wdenk2729af92004-05-03 20:45:30 +00003836One of the features of U-Boot is that you can dynamically load and
3837run "standalone" applications, which can use some resources of
3838U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003841
wdenk2729af92004-05-03 20:45:30 +00003842"Hello World" Demo:
3843-------------------
wdenkc6097192002-11-03 00:24:07 +00003844
wdenk2729af92004-05-03 20:45:30 +00003845'examples/hello_world.c' contains a small "Hello World" Demo
3846application; it is automatically compiled when you build U-Boot.
3847It's configured to run at address 0x00040004, so you can play with it
3848like that:
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk2729af92004-05-03 20:45:30 +00003850 => loads
3851 ## Ready for S-Record download ...
3852 ~>examples/hello_world.srec
3853 1 2 3 4 5 6 7 8 9 10 11 ...
3854 [file transfer complete]
3855 [connected]
3856 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003857
wdenk2729af92004-05-03 20:45:30 +00003858 => go 40004 Hello World! This is a test.
3859 ## Starting application at 0x00040004 ...
3860 Hello World
3861 argc = 7
3862 argv[0] = "40004"
3863 argv[1] = "Hello"
3864 argv[2] = "World!"
3865 argv[3] = "This"
3866 argv[4] = "is"
3867 argv[5] = "a"
3868 argv[6] = "test."
3869 argv[7] = "<NULL>"
3870 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk2729af92004-05-03 20:45:30 +00003872 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874Another example, which demonstrates how to register a CPM interrupt
3875handler with the U-Boot code, can be found in 'examples/timer.c'.
3876Here, a CPM timer is set up to generate an interrupt every second.
3877The interrupt service routine is trivial, just printing a '.'
3878character, but this is just a demo program. The application can be
3879controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003880
wdenk2729af92004-05-03 20:45:30 +00003881 ? - print current values og the CPM Timer registers
3882 b - enable interrupts and start timer
3883 e - stop timer and disable interrupts
3884 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003885
wdenk2729af92004-05-03 20:45:30 +00003886 => loads
3887 ## Ready for S-Record download ...
3888 ~>examples/timer.srec
3889 1 2 3 4 5 6 7 8 9 10 11 ...
3890 [file transfer complete]
3891 [connected]
3892 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003893
wdenk2729af92004-05-03 20:45:30 +00003894 => go 40004
3895 ## Starting application at 0x00040004 ...
3896 TIMERS=0xfff00980
3897 Using timer 1
3898 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003899
wdenk2729af92004-05-03 20:45:30 +00003900Hit 'b':
3901 [q, b, e, ?] Set interval 1000000 us
3902 Enabling timer
3903Hit '?':
3904 [q, b, e, ?] ........
3905 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3906Hit '?':
3907 [q, b, e, ?] .
3908 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3909Hit '?':
3910 [q, b, e, ?] .
3911 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3912Hit '?':
3913 [q, b, e, ?] .
3914 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3915Hit 'e':
3916 [q, b, e, ?] ...Stopping timer
3917Hit 'q':
3918 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003919
3920
wdenk2729af92004-05-03 20:45:30 +00003921Minicom warning:
3922================
wdenk85ec0bc2003-03-31 16:34:49 +00003923
wdenk2729af92004-05-03 20:45:30 +00003924Over time, many people have reported problems when trying to use the
3925"minicom" terminal emulation program for serial download. I (wd)
3926consider minicom to be broken, and recommend not to use it. Under
3927Unix, I recommend to use C-Kermit for general purpose use (and
3928especially for kermit binary protocol download ("loadb" command), and
3929use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003930
wdenk2729af92004-05-03 20:45:30 +00003931Nevertheless, if you absolutely want to use it try adding this
3932configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003933
wdenk2729af92004-05-03 20:45:30 +00003934 Name Program Name U/D FullScr IO-Red. Multi
3935 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3936 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003937
3938
wdenk2729af92004-05-03 20:45:30 +00003939NetBSD Notes:
3940=============
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk2729af92004-05-03 20:45:30 +00003942Starting at version 0.9.2, U-Boot supports NetBSD both as host
3943(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945Building requires a cross environment; it is known to work on
3946NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3947need gmake since the Makefiles are not compatible with BSD make).
3948Note that the cross-powerpc package does not install include files;
3949attempting to build U-Boot will fail because <machine/ansi.h> is
3950missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003951
wdenk2729af92004-05-03 20:45:30 +00003952 # cd /usr/pkg/cross/powerpc-netbsd/include
3953 # mkdir powerpc
3954 # ln -s powerpc machine
3955 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3956 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003957
wdenk2729af92004-05-03 20:45:30 +00003958Native builds *don't* work due to incompatibilities between native
3959and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003960
wdenk2729af92004-05-03 20:45:30 +00003961Booting assumes that (the first part of) the image booted is a
3962stage-2 loader which in turn loads and then invokes the kernel
3963proper. Loader sources will eventually appear in the NetBSD source
3964tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003965meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003966
3967
wdenk2729af92004-05-03 20:45:30 +00003968Implementation Internals:
3969=========================
wdenkc6097192002-11-03 00:24:07 +00003970
wdenk2729af92004-05-03 20:45:30 +00003971The following is not intended to be a complete description of every
3972implementation detail. However, it should help to understand the
3973inner workings of U-Boot and make it easier to port it to custom
3974hardware.
wdenkc6097192002-11-03 00:24:07 +00003975
3976
wdenk2729af92004-05-03 20:45:30 +00003977Initial Stack, Global Data:
3978---------------------------
wdenkc6097192002-11-03 00:24:07 +00003979
wdenk2729af92004-05-03 20:45:30 +00003980The implementation of U-Boot is complicated by the fact that U-Boot
3981starts running out of ROM (flash memory), usually without access to
3982system RAM (because the memory controller is not initialized yet).
3983This means that we don't have writable Data or BSS segments, and BSS
3984is not initialized as zero. To be able to get a C environment working
3985at all, we have to allocate at least a minimal stack. Implementation
3986options for this are defined and restricted by the CPU used: Some CPU
3987models provide on-chip memory (like the IMMR area on MPC8xx and
3988MPC826x processors), on others (parts of) the data cache can be
3989locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003990
Wolfgang Denk218ca722008-03-26 10:40:12 +01003991 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01003992 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00003993
wdenk2729af92004-05-03 20:45:30 +00003994 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3995 From: "Chris Hallinan" <clh@net1plus.com>
3996 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3997 ...
wdenk43d96162003-03-06 00:02:04 +00003998
wdenk2729af92004-05-03 20:45:30 +00003999 Correct me if I'm wrong, folks, but the way I understand it
4000 is this: Using DCACHE as initial RAM for Stack, etc, does not
4001 require any physical RAM backing up the cache. The cleverness
4002 is that the cache is being used as a temporary supply of
4003 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004004 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004005 can see how this works by studying the cache architecture and
4006 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004007
wdenk2729af92004-05-03 20:45:30 +00004008 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4009 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004010 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004011 option should work for you. Using CS 4 should be fine if your
4012 board designers haven't used it for something that would
4013 cause you grief during the initial boot! It is frequently not
4014 used.
wdenk43d96162003-03-06 00:02:04 +00004015
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004016 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004017 with your processor/board/system design. The default value
4018 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004019 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004020 than your SDRAM module. If you have a 64MB SDRAM module, set
4021 it above 400_0000. Just make sure your board has no resources
4022 that are supposed to respond to that address! That code in
4023 start.S has been around a while and should work as is when
4024 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004025
wdenk2729af92004-05-03 20:45:30 +00004026 -Chris Hallinan
4027 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004028
wdenk2729af92004-05-03 20:45:30 +00004029It is essential to remember this, since it has some impact on the C
4030code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004031
wdenk2729af92004-05-03 20:45:30 +00004032* Initialized global data (data segment) is read-only. Do not attempt
4033 to write it.
wdenkc6097192002-11-03 00:24:07 +00004034
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004035* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004036 as zero data - BSS segment) at all - this is undefined, initiali-
4037 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004038
wdenk2729af92004-05-03 20:45:30 +00004039* Stack space is very limited. Avoid big data buffers or things like
4040 that.
wdenkc6097192002-11-03 00:24:07 +00004041
wdenk2729af92004-05-03 20:45:30 +00004042Having only the stack as writable memory limits means we cannot use
4043normal global data to share information beween the code. But it
4044turned out that the implementation of U-Boot can be greatly
4045simplified by making a global data structure (gd_t) available to all
4046functions. We could pass a pointer to this data as argument to _all_
4047functions, but this would bloat the code. Instead we use a feature of
4048the GCC compiler (Global Register Variables) to share the data: we
4049place a pointer (gd) to the global data into a register which we
4050reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004051
wdenk2729af92004-05-03 20:45:30 +00004052When choosing a register for such a purpose we are restricted by the
4053relevant (E)ABI specifications for the current architecture, and by
4054GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004055
wdenk2729af92004-05-03 20:45:30 +00004056For PowerPC, the following registers have specific use:
4057 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004058 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004059 R3-R4: parameter passing and return values
4060 R5-R10: parameter passing
4061 R13: small data area pointer
4062 R30: GOT pointer
4063 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004064
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004065 (U-Boot also uses R12 as internal GOT pointer. r12
4066 is a volatile register so r12 needs to be reset when
4067 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004068
Wolfgang Denke7670f62008-02-14 22:43:22 +01004069 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071 Note: on PPC, we could use a static initializer (since the
4072 address of the global data structure is known at compile time),
4073 but it turned out that reserving a register results in somewhat
4074 smaller code - although the code savings are not that big (on
4075 average for all boards 752 bytes for the whole U-Boot image,
4076 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004077
Robin Getzc4db3352009-08-17 15:23:02 +00004078On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004079 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4080
Robin Getzc4db3352009-08-17 15:23:02 +00004081 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004082
wdenk2729af92004-05-03 20:45:30 +00004083On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004084
wdenk2729af92004-05-03 20:45:30 +00004085 R0: function argument word/integer result
4086 R1-R3: function argument word
4087 R9: GOT pointer
4088 R10: stack limit (used only if stack checking if enabled)
4089 R11: argument (frame) pointer
4090 R12: temporary workspace
4091 R13: stack pointer
4092 R14: link register
4093 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004096
Thomas Chou0df01fd2010-05-21 11:08:03 +08004097On Nios II, the ABI is documented here:
4098 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4099
4100 ==> U-Boot will use gp to hold a pointer to the global data
4101
4102 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4103 to access small data sections, so gp is free.
4104
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004105NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4106or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108Memory Management:
4109------------------
wdenkc6097192002-11-03 00:24:07 +00004110
wdenk2729af92004-05-03 20:45:30 +00004111U-Boot runs in system state and uses physical addresses, i.e. the
4112MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114The available memory is mapped to fixed addresses using the memory
4115controller. In this process, a contiguous block is formed for each
4116memory type (Flash, SDRAM, SRAM), even when it consists of several
4117physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004118
wdenk2729af92004-05-03 20:45:30 +00004119U-Boot is installed in the first 128 kB of the first Flash bank (on
4120TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4121booting and sizing and initializing DRAM, the code relocates itself
4122to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004123memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004124configuration setting]. Below that, a structure with global Board
4125Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004126
wdenk2729af92004-05-03 20:45:30 +00004127Additionally, some exception handler code is copied to the low 8 kB
4128of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk2729af92004-05-03 20:45:30 +00004130So a typical memory configuration with 16 MB of DRAM could look like
4131this:
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk2729af92004-05-03 20:45:30 +00004133 0x0000 0000 Exception Vector code
4134 :
4135 0x0000 1FFF
4136 0x0000 2000 Free for Application Use
4137 :
4138 :
wdenkc6097192002-11-03 00:24:07 +00004139
wdenk2729af92004-05-03 20:45:30 +00004140 :
4141 :
4142 0x00FB FF20 Monitor Stack (Growing downward)
4143 0x00FB FFAC Board Info Data and permanent copy of global data
4144 0x00FC 0000 Malloc Arena
4145 :
4146 0x00FD FFFF
4147 0x00FE 0000 RAM Copy of Monitor Code
4148 ... eventually: LCD or video framebuffer
4149 ... eventually: pRAM (Protected RAM - unchanged by reset)
4150 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004151
4152
wdenk2729af92004-05-03 20:45:30 +00004153System Initialization:
4154----------------------
wdenkc6097192002-11-03 00:24:07 +00004155
wdenk2729af92004-05-03 20:45:30 +00004156In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004157(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004158configuration for CS0# this is a mirror of the onboard Flash memory.
4159To be able to re-map memory U-Boot then jumps to its link address.
4160To be able to implement the initialization code in C, a (small!)
4161initial stack is set up in the internal Dual Ported RAM (in case CPUs
4162which provide such a feature like MPC8xx or MPC8260), or in a locked
4163part of the data cache. After that, U-Boot initializes the CPU core,
4164the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166Next, all (potentially) available memory banks are mapped using a
4167preliminary mapping. For example, we put them on 512 MB boundaries
4168(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4169on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4170programmed for SDRAM access. Using the temporary configuration, a
4171simple memory test is run that determines the size of the SDRAM
4172banks.
wdenkc6097192002-11-03 00:24:07 +00004173
wdenk2729af92004-05-03 20:45:30 +00004174When there is more than one SDRAM bank, and the banks are of
4175different size, the largest is mapped first. For equal size, the first
4176bank (CS2#) is mapped first. The first mapping is always for address
41770x00000000, with any additional banks following immediately to create
4178contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004179
wdenk2729af92004-05-03 20:45:30 +00004180Then, the monitor installs itself at the upper end of the SDRAM area
4181and allocates memory for use by malloc() and for the global Board
4182Info data; also, the exception vector code is copied to the low RAM
4183pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004184
wdenk2729af92004-05-03 20:45:30 +00004185Only after this relocation will you have a "normal" C environment;
4186until that you are restricted in several ways, mostly because you are
4187running from ROM, and because the code will have to be relocated to a
4188new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004189
4190
wdenk2729af92004-05-03 20:45:30 +00004191U-Boot Porting Guide:
4192----------------------
wdenkc6097192002-11-03 00:24:07 +00004193
wdenk2729af92004-05-03 20:45:30 +00004194[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4195list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004196
4197
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004198int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004199{
4200 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004201
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004202 signal(SIGALRM, no_more_time);
4203 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004204
wdenk2729af92004-05-03 20:45:30 +00004205 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004206 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004207 return 0;
4208 }
4209
wdenk2729af92004-05-03 20:45:30 +00004210 Download latest U-Boot source;
4211
Wolfgang Denk06682362008-12-30 22:56:11 +01004212 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004213
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004214 if (clueless)
4215 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004216
wdenk2729af92004-05-03 20:45:30 +00004217 while (learning) {
4218 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004219 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4220 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004221 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004222 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004223 }
wdenkc6097192002-11-03 00:24:07 +00004224
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004225 if (available_money > toLocalCurrency ($2500))
4226 Buy a BDI3000;
4227 else
wdenk2729af92004-05-03 20:45:30 +00004228 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004229
4230 if (a similar board exists) { /* hopefully... */
4231 cp -a board/<similar> board/<myboard>
4232 cp include/configs/<similar>.h include/configs/<myboard>.h
4233 } else {
4234 Create your own board support subdirectory;
4235 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004236 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004237 Edit new board/<myboard> files
4238 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004239
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004240 while (!accepted) {
4241 while (!running) {
4242 do {
4243 Add / modify source code;
4244 } until (compiles);
4245 Debug;
4246 if (clueless)
4247 email("Hi, I am having problems...");
4248 }
4249 Send patch file to the U-Boot email list;
4250 if (reasonable critiques)
4251 Incorporate improvements from email list code review;
4252 else
4253 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004254 }
wdenkc6097192002-11-03 00:24:07 +00004255
wdenk2729af92004-05-03 20:45:30 +00004256 return 0;
4257}
4258
4259void no_more_time (int sig)
4260{
4261 hire_a_guru();
4262}
wdenkc6097192002-11-03 00:24:07 +00004263
4264
wdenk2729af92004-05-03 20:45:30 +00004265Coding Standards:
4266-----------------
wdenkc6097192002-11-03 00:24:07 +00004267
wdenk2729af92004-05-03 20:45:30 +00004268All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004269coding style; see the file "Documentation/CodingStyle" and the script
4270"scripts/Lindent" in your Linux kernel source directory. In sources
4271originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4272spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004273
Detlev Zundel2c051652006-09-01 15:39:02 +02004274Source files originating from a different project (for example the
4275MTD subsystem) are generally exempt from these guidelines and are not
4276reformated to ease subsequent migration to newer versions of those
4277sources.
4278
4279Please note that U-Boot is implemented in C (and to some small parts in
4280Assembler); no C++ is used, so please do not use C++ style comments (//)
4281in your code.
wdenk2729af92004-05-03 20:45:30 +00004282
4283Please also stick to the following formatting rules:
4284- remove any trailing white space
4285- use TAB characters for indentation, not spaces
4286- make sure NOT to use DOS '\r\n' line feeds
4287- do not add more than 2 empty lines to source files
4288- do not add trailing empty lines to source files
4289
4290Submissions which do not conform to the standards may be returned
4291with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004292
4293
wdenk2729af92004-05-03 20:45:30 +00004294Submitting Patches:
4295-------------------
wdenkc6097192002-11-03 00:24:07 +00004296
wdenk2729af92004-05-03 20:45:30 +00004297Since the number of patches for U-Boot is growing, we need to
4298establish some rules. Submissions which do not conform to these rules
4299may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004300
Magnus Lilja0d28f342008-08-06 19:32:33 +02004301Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004302
Wolfgang Denk06682362008-12-30 22:56:11 +01004303Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4304see http://lists.denx.de/mailman/listinfo/u-boot
4305
wdenk2729af92004-05-03 20:45:30 +00004306When you send a patch, please include the following information with
4307it:
wdenkc6097192002-11-03 00:24:07 +00004308
wdenk2729af92004-05-03 20:45:30 +00004309* For bug fixes: a description of the bug and how your patch fixes
4310 this bug. Please try to include a way of demonstrating that the
4311 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004312
wdenk2729af92004-05-03 20:45:30 +00004313* For new features: a description of the feature and your
4314 implementation.
wdenkc6097192002-11-03 00:24:07 +00004315
wdenk2729af92004-05-03 20:45:30 +00004316* A CHANGELOG entry as plaintext (separate from the patch)
4317
4318* For major contributions, your entry to the CREDITS file
4319
4320* When you add support for a new board, don't forget to add this
4321 board to the MAKEALL script, too.
4322
4323* If your patch adds new configuration options, don't forget to
4324 document these in the README file.
4325
Wolfgang Denk218ca722008-03-26 10:40:12 +01004326* The patch itself. If you are using git (which is *strongly*
4327 recommended) you can easily generate the patch using the
4328 "git-format-patch". If you then use "git-send-email" to send it to
4329 the U-Boot mailing list, you will avoid most of the common problems
4330 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004331
Wolfgang Denk218ca722008-03-26 10:40:12 +01004332 If you cannot use git, use "diff -purN OLD NEW". If your version of
4333 diff does not support these options, then get the latest version of
4334 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004335
Wolfgang Denk218ca722008-03-26 10:40:12 +01004336 The current directory when running this command shall be the parent
4337 directory of the U-Boot source tree (i. e. please make sure that
4338 your patch includes sufficient directory information for the
4339 affected files).
4340
4341 We prefer patches as plain text. MIME attachments are discouraged,
4342 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004343
4344* If one logical set of modifications affects or creates several
4345 files, all these changes shall be submitted in a SINGLE patch file.
4346
4347* Changesets that contain different, unrelated modifications shall be
4348 submitted as SEPARATE patches, one patch per changeset.
4349
4350
4351Notes:
4352
4353* Before sending the patch, run the MAKEALL script on your patched
4354 source tree and make sure that no errors or warnings are reported
4355 for any of the boards.
4356
4357* Keep your modifications to the necessary minimum: A patch
4358 containing several unrelated changes or arbitrary reformats will be
4359 returned with a request to re-formatting / split it.
4360
4361* If you modify existing code, make sure that your new code does not
4362 add to the memory footprint of the code ;-) Small is beautiful!
4363 When adding new features, these should compile conditionally only
4364 (using #ifdef), and the resulting code with the new feature
4365 disabled must not need more memory than the old code without your
4366 modification.
wdenk90dc6702005-05-03 14:12:25 +00004367
Wolfgang Denk06682362008-12-30 22:56:11 +01004368* Remember that there is a size limit of 100 kB per message on the
4369 u-boot mailing list. Bigger patches will be moderated. If they are
4370 reasonable and not too big, they will be acknowledged. But patches
4371 bigger than the size limit should be avoided.