blob: cdd81d4efe3efafd8e8e3653303eec1af2e599f5 [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
129U-Boot uses a 3 level version number containing a version, a
130sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
131sub-version "34", and patchlevel "4".
132
133The patchlevel is used to indicate certain stages of development
134between released versions, i. e. officially released versions of
135U-Boot will always have a patchlevel of "0".
136
137
wdenkc6097192002-11-03 00:24:07 +0000138Directory Hierarchy:
139====================
140
Peter Tyser8d321b82010-04-12 22:28:21 -0500141/arch Architecture specific files
142 /arm Files generic to ARM architecture
143 /cpu CPU specific files
144 /arm720t Files specific to ARM 720 CPUs
145 /arm920t Files specific to ARM 920 CPUs
146 /at91rm9200 Files specific to Atmel AT91RM9200 CPU
147 /imx Files specific to Freescale MC9328 i.MX CPUs
148 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
149 /arm925t Files specific to ARM 925 CPUs
150 /arm926ejs Files specific to ARM 926 CPUs
151 /arm1136 Files specific to ARM 1136 CPUs
152 /ixp Files specific to Intel XScale IXP CPUs
153 /pxa Files specific to Intel XScale PXA CPUs
154 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
155 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
156 /lib Architecture specific library files
157 /avr32 Files generic to AVR32 architecture
158 /cpu CPU specific files
159 /lib Architecture specific library files
160 /blackfin Files generic to Analog Devices Blackfin architecture
161 /cpu CPU specific files
162 /lib Architecture specific library files
163 /i386 Files generic to i386 architecture
164 /cpu CPU specific files
165 /lib Architecture specific library files
166 /m68k Files generic to m68k architecture
167 /cpu CPU specific files
168 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
169 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
170 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
171 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
172 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
173 /lib Architecture specific library files
174 /microblaze Files generic to microblaze architecture
175 /cpu CPU specific files
176 /lib Architecture specific library files
177 /mips Files generic to MIPS architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
180 /nios Files generic to Altera NIOS architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
183 /nios2 Files generic to Altera NIOS2 architecture
184 /cpu CPU specific files
185 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200186 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500187 /cpu CPU specific files
188 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
189 /mpc5xx Files specific to Freescale MPC5xx CPUs
190 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
191 /mpc8xx Files specific to Freescale MPC8xx CPUs
192 /mpc8220 Files specific to Freescale MPC8220 CPUs
193 /mpc824x Files specific to Freescale MPC824x CPUs
194 /mpc8260 Files specific to Freescale MPC8260 CPUs
195 /mpc85xx Files specific to Freescale MPC85xx CPUs
196 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
197 /lib Architecture specific library files
198 /sh Files generic to SH architecture
199 /cpu CPU specific files
200 /sh2 Files specific to sh2 CPUs
201 /sh3 Files specific to sh3 CPUs
202 /sh4 Files specific to sh4 CPUs
203 /lib Architecture specific library files
204 /sparc Files generic to SPARC architecture
205 /cpu CPU specific files
206 /leon2 Files specific to Gaisler LEON2 SPARC CPU
207 /leon3 Files specific to Gaisler LEON3 SPARC CPU
208 /lib Architecture specific library files
209/api Machine/arch independent API for external apps
210/board Board dependent files
211/common Misc architecture independent functions
212/disk Code for disk drive partition handling
213/doc Documentation (don't expect too much)
214/drivers Commonly used device drivers
215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
224/rtc Real Time Clock drivers
225/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000226
wdenkc6097192002-11-03 00:24:07 +0000227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200242 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
255configurations available; just type "make <board_name>_config".
256
257Example: For a TQM823L module type:
258
259 cd u-boot
260 make TQM823L_config
261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000263e.g. "make cogent_mpc8xx_config". And also configure the cogent
264directory according to the instructions in cogent/README.
265
266
267Configuration Options:
268----------------------
269
270Configuration depends on the combination of board and CPU type; all
271such information is kept in a configuration file
272"include/configs/<board_name>.h".
273
274Example: For a TQM823L module, all configuration settings are in
275"include/configs/TQM823L.h".
276
277
wdenk7f6c2cb2002-11-10 22:06:23 +0000278Many of the options are named exactly as the corresponding Linux
279kernel configuration options. The intention is to make it easier to
280build a config tool - later.
281
282
wdenkc6097192002-11-03 00:24:07 +0000283The following options need to be configured:
284
Kim Phillips26281142007-08-10 13:28:25 -0500285- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000286
Kim Phillips26281142007-08-10 13:28:25 -0500287- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200288
289- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100290 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000291
292- CPU Module Type: (if CONFIG_COGENT is defined)
293 Define exactly one of
294 CONFIG_CMA286_60_OLD
295--- FIXME --- not tested yet:
296 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
297 CONFIG_CMA287_23, CONFIG_CMA287_50
298
299- Motherboard Type: (if CONFIG_COGENT is defined)
300 Define exactly one of
301 CONFIG_CMA101, CONFIG_CMA102
302
303- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
304 Define one or more of
305 CONFIG_CMA302
306
307- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
308 Define one or more of
309 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200310 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000311 a "rotator" |\-/|\-/
312
wdenk2535d602003-07-17 23:16:40 +0000313- Board flavour: (if CONFIG_MPC8260ADS is defined)
314 CONFIG_ADSTYPE
315 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200316 CONFIG_SYS_8260ADS - original MPC8260ADS
317 CONFIG_SYS_8266ADS - MPC8266ADS
318 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
319 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000320
wdenkc6097192002-11-03 00:24:07 +0000321- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000322 Define exactly one of
323 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000324
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200325- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000326 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
327 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000328 e.g. if there is no 32KHz
329 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000330 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
331 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000332
wdenk66ca92a2004-09-28 17:59:53 +0000333- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200334 CONFIG_SYS_8xx_CPUCLK_MIN
335 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000336 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000337 See doc/README.MPC866
338
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200339 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000340
wdenkba56f622004-02-06 23:19:44 +0000341 Define this to measure the actual CPU clock instead
342 of relying on the correctness of the configured
343 values. Mostly useful for board bringup to make sure
344 the PLL is locked at the intended frequency. Note
345 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000347
Heiko Schocher506f3912009-03-12 07:37:15 +0100348 CONFIG_SYS_DELAYED_ICACHE
349
350 Define this option if you want to enable the
351 ICache only when Code runs from RAM.
352
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100353- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200354 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100355
356 Defines the Monahans run mode to oscillator
357 ratio. Valid values are 8, 16, 24, 31. The core
358 frequency is this value multiplied by 13 MHz.
359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200360 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200361
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100362 Defines the Monahans turbo mode to oscillator
363 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200364 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100365 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200366
wdenk5da627a2003-10-09 20:09:04 +0000367- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000368 CONFIG_CLOCKS_IN_MHZ
369
370 U-Boot stores all clock information in Hz
371 internally. For binary compatibility with older Linux
372 kernels (which expect the clocks passed in the
373 bd_info data to be in MHz) the environment variable
374 "clocks_in_mhz" can be defined so that U-Boot
375 converts clock data to MHZ before passing it to the
376 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000377 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100378 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000379 default environment.
380
wdenk5da627a2003-10-09 20:09:04 +0000381 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
382
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200383 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000384 expect it to be in bytes, others in MB.
385 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
386
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400387 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200388
389 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400390 passed using flattened device trees (based on open firmware
391 concepts).
392
393 CONFIG_OF_LIBFDT
394 * New libfdt-based support
395 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500396 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400397
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200398 OF_CPU - The proper name of the cpus node (only required for
399 MPC512X and MPC5xxx based boards).
400 OF_SOC - The proper name of the soc node (only required for
401 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200402 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600403 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200404
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200405 boards with QUICC Engines require OF_QE to set UCC MAC
406 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500407
Kumar Gala4e253132006-01-11 13:54:17 -0600408 CONFIG_OF_BOARD_SETUP
409
410 Board code has addition modification that it wants to make
411 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000412
Matthew McClintock02677682006-06-28 10:41:37 -0500413 CONFIG_OF_BOOT_CPU
414
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200415 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500416 param header, the default value is zero if undefined.
417
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200418 CONFIG_OF_IDE_FIXUP
419
420 U-Boot can detect if an IDE device is present or not.
421 If not, and this new config option is activated, U-Boot
422 removes the ATA node from the DTS before booting Linux,
423 so the Linux IDE driver does not probe the device and
424 crash. This is needed for buggy hardware (uc101) where
425 no pull down resistor is connected to the signal IDE5V_DD7.
426
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100427- vxWorks boot parameters:
428
429 bootvx constructs a valid bootline using the following
430 environments variables: bootfile, ipaddr, serverip, hostname.
431 It loads the vxWorks image pointed bootfile.
432
433 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
434 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
435 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
436 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
437
438 CONFIG_SYS_VXWORKS_ADD_PARAMS
439
440 Add it at the end of the bootline. E.g "u=username pw=secret"
441
442 Note: If a "bootargs" environment is defined, it will overwride
443 the defaults discussed just above.
444
wdenk6705d812004-08-02 23:22:59 +0000445- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200446 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000447
448 Define this if you want support for Amba PrimeCell PL010 UARTs.
449
Andreas Engel48d01922008-09-08 14:30:53 +0200450 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000451
452 Define this if you want support for Amba PrimeCell PL011 UARTs.
453
454 CONFIG_PL011_CLOCK
455
456 If you have Amba PrimeCell PL011 UARTs, set this variable to
457 the clock speed of the UARTs.
458
459 CONFIG_PL01x_PORTS
460
461 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
462 define this to a list of base addresses for each (supported)
463 port. See e.g. include/configs/versatile.h
464
465
wdenkc6097192002-11-03 00:24:07 +0000466- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000467 Depending on board, define exactly one serial port
468 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
469 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
470 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000471
472 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
473 port routines must be defined elsewhere
474 (i.e. serial_init(), serial_getc(), ...)
475
476 CONFIG_CFB_CONSOLE
477 Enables console device for a color framebuffer. Needs following
478 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
479 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
480 (default big endian)
481 VIDEO_HW_RECTFILL graphic chip supports
482 rectangle fill
483 (cf. smiLynxEM)
484 VIDEO_HW_BITBLT graphic chip supports
485 bit-blit (cf. smiLynxEM)
486 VIDEO_VISIBLE_COLS visible pixel columns
487 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000488 VIDEO_VISIBLE_ROWS visible pixel rows
489 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000490 VIDEO_DATA_FORMAT graphic data format
491 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000492 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000493 VIDEO_KBD_INIT_FCT keyboard int fct
494 (i.e. i8042_kbd_init())
495 VIDEO_TSTC_FCT test char fct
496 (i.e. i8042_tstc)
497 VIDEO_GETC_FCT get char fct
498 (i.e. i8042_getc)
499 CONFIG_CONSOLE_CURSOR cursor drawing on/off
500 (requires blink timer
501 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200502 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000503 CONFIG_CONSOLE_TIME display time/date info in
504 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500505 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000506 CONFIG_VIDEO_LOGO display Linux logo in
507 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000508 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
509 linux_logo.h for logo.
510 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000511 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200512 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000513 the logo
514
wdenk43d96162003-03-06 00:02:04 +0000515 When CONFIG_CFB_CONSOLE is defined, video console is
516 default i/o. Serial console can be forced with
517 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000518
wdenkd4ca31c2004-01-02 14:00:00 +0000519 When CONFIG_SILENT_CONSOLE is defined, all console
520 messages (by U-Boot and Linux!) can be silenced with
521 the "silent" environment variable. See
522 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000523
wdenkc6097192002-11-03 00:24:07 +0000524- Console Baudrate:
525 CONFIG_BAUDRATE - in bps
526 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200527 CONFIG_SYS_BAUDRATE_TABLE, see below.
528 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000529
Heiko Schocherc92fac92009-01-30 12:55:38 +0100530- Console Rx buffer length
531 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
532 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100533 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100534 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
535 must be defined, to setup the maximum idle timeout for
536 the SMC.
537
wdenkc6097192002-11-03 00:24:07 +0000538- Interrupt driven serial port input:
539 CONFIG_SERIAL_SOFTWARE_FIFO
540
541 PPC405GP only.
542 Use an interrupt handler for receiving data on the
543 serial port. It also enables using hardware handshake
544 (RTS/CTS) and UART's built-in FIFO. Set the number of
545 bytes the interrupt driven input buffer should have.
546
wdenk109c0e32004-03-23 21:43:07 +0000547 Leave undefined to disable this feature, including
548 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000549
stroese1d49b1f2003-05-23 11:39:05 +0000550- Console UART Number:
551 CONFIG_UART1_CONSOLE
552
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200553 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000554 If defined internal UART1 (and not UART0) is used
555 as default U-Boot console.
556
wdenkc6097192002-11-03 00:24:07 +0000557- Boot Delay: CONFIG_BOOTDELAY - in seconds
558 Delay before automatically booting the default image;
559 set to -1 to disable autoboot.
560
561 See doc/README.autoboot for these options that
562 work with CONFIG_BOOTDELAY. None are required.
563 CONFIG_BOOT_RETRY_TIME
564 CONFIG_BOOT_RETRY_MIN
565 CONFIG_AUTOBOOT_KEYED
566 CONFIG_AUTOBOOT_PROMPT
567 CONFIG_AUTOBOOT_DELAY_STR
568 CONFIG_AUTOBOOT_STOP_STR
569 CONFIG_AUTOBOOT_DELAY_STR2
570 CONFIG_AUTOBOOT_STOP_STR2
571 CONFIG_ZERO_BOOTDELAY_CHECK
572 CONFIG_RESET_TO_RETRY
573
574- Autoboot Command:
575 CONFIG_BOOTCOMMAND
576 Only needed when CONFIG_BOOTDELAY is enabled;
577 define a command string that is automatically executed
578 when no character is read on the console interface
579 within "Boot Delay" after reset.
580
581 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000582 This can be used to pass arguments to the bootm
583 command. The value of CONFIG_BOOTARGS goes into the
584 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000585
586 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000587 The value of these goes into the environment as
588 "ramboot" and "nfsboot" respectively, and can be used
589 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200590 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000591
592- Pre-Boot Commands:
593 CONFIG_PREBOOT
594
595 When this option is #defined, the existence of the
596 environment variable "preboot" will be checked
597 immediately before starting the CONFIG_BOOTDELAY
598 countdown and/or running the auto-boot command resp.
599 entering interactive mode.
600
601 This feature is especially useful when "preboot" is
602 automatically generated or modified. For an example
603 see the LWMON board specific code: here "preboot" is
604 modified when the user holds down a certain
605 combination of keys on the (special) keyboard when
606 booting the systems
607
608- Serial Download Echo Mode:
609 CONFIG_LOADS_ECHO
610 If defined to 1, all characters received during a
611 serial download (using the "loads" command) are
612 echoed back. This might be needed by some terminal
613 emulations (like "cu"), but may as well just take
614 time on others. This setting #define's the initial
615 value of the "loads_echo" environment variable.
616
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500617- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000618 CONFIG_KGDB_BAUDRATE
619 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200620 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000621
622- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500623 Monitor commands can be included or excluded
624 from the build by using the #include files
625 "config_cmd_all.h" and #undef'ing unwanted
626 commands, or using "config_cmd_default.h"
627 and augmenting with additional #define's
628 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000629
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500630 The default command configuration includes all commands
631 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000632
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500633 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500634 CONFIG_CMD_BDI bdinfo
635 CONFIG_CMD_BEDBUG * Include BedBug Debugger
636 CONFIG_CMD_BMP * BMP support
637 CONFIG_CMD_BSP * Board specific commands
638 CONFIG_CMD_BOOTD bootd
639 CONFIG_CMD_CACHE * icache, dcache
640 CONFIG_CMD_CONSOLE coninfo
641 CONFIG_CMD_DATE * support for RTC, date/time...
642 CONFIG_CMD_DHCP * DHCP support
643 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600644 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
645 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
646 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
647 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500648 CONFIG_CMD_DTT * Digital Therm and Thermostat
649 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500650 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500651 CONFIG_CMD_EEPROM * EEPROM read/write support
652 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500653 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500654 CONFIG_CMD_FDC * Floppy Disk Support
655 CONFIG_CMD_FAT * FAT partition support
656 CONFIG_CMD_FDOS * Dos diskette Support
657 CONFIG_CMD_FLASH flinfo, erase, protect
658 CONFIG_CMD_FPGA FPGA device initialization support
659 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
660 CONFIG_CMD_I2C * I2C serial bus support
661 CONFIG_CMD_IDE * IDE harddisk support
662 CONFIG_CMD_IMI iminfo
663 CONFIG_CMD_IMLS List all found images
664 CONFIG_CMD_IMMAP * IMMR dump support
665 CONFIG_CMD_IRQ * irqinfo
666 CONFIG_CMD_ITEST Integer/string test of 2 values
667 CONFIG_CMD_JFFS2 * JFFS2 Support
668 CONFIG_CMD_KGDB * kgdb
669 CONFIG_CMD_LOADB loadb
670 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400671 CONFIG_CMD_MD5SUM print md5 message digest
672 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500673 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
674 loop, loopw, mtest
675 CONFIG_CMD_MISC Misc functions like sleep etc
676 CONFIG_CMD_MMC * MMC memory mapped support
677 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100678 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500679 CONFIG_CMD_NAND * NAND support
680 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600681 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
682 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500683 CONFIG_CMD_PCI * pciinfo
684 CONFIG_CMD_PCMCIA * PCMCIA support
685 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
686 host
687 CONFIG_CMD_PORTIO * Port I/O
688 CONFIG_CMD_REGINFO * Register dump
689 CONFIG_CMD_RUN run command in env variable
690 CONFIG_CMD_SAVES * save S record dump
691 CONFIG_CMD_SCSI * SCSI Support
692 CONFIG_CMD_SDRAM * print SDRAM configuration information
693 (requires CONFIG_CMD_I2C)
694 CONFIG_CMD_SETGETDCR Support for DCR Register access
695 (4xx only)
Robin Getz02c9aa12009-07-27 00:07:59 -0400696 CONFIG_CMD_SHA1 print sha1 memory digest
697 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200698 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500699 CONFIG_CMD_SPI * SPI serial bus support
700 CONFIG_CMD_USB * USB support
701 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500702 CONFIG_CMD_CDP * Cisco Discover Protocol support
703 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000704
wdenkc6097192002-11-03 00:24:07 +0000705
706 EXAMPLE: If you want all functions except of network
707 support you can write:
708
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500709 #include "config_cmd_all.h"
710 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000711
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400712 Other Commands:
713 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000714
715 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500716 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000717 what you (and your U-Boot users) are doing. Data
718 cache cannot be enabled on systems like the 8xx or
719 8260 (where accesses to the IMMR region must be
720 uncached), and it cannot be disabled on all other
721 systems where we (mis-) use the data cache to hold an
722 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000723
724
725 XXX - this list needs to get updated!
726
727- Watchdog:
728 CONFIG_WATCHDOG
729 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000730 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000731 code for a watchdog. For the 8xx and 8260 CPUs, the
732 SIU Watchdog feature is enabled in the SYPCR
733 register.
734
stroesec1551ea2003-04-04 15:53:41 +0000735- U-Boot Version:
736 CONFIG_VERSION_VARIABLE
737 If this variable is defined, an environment variable
738 named "ver" is created by U-Boot showing the U-Boot
739 version as printed by the "version" command.
740 This variable is readonly.
741
wdenkc6097192002-11-03 00:24:07 +0000742- Real-Time Clock:
743
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500744 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000745 has to be selected, too. Define exactly one of the
746 following options:
747
748 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
749 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200750 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000751 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000752 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000753 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000754 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000755 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100756 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000757 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200758 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000759
wdenkb37c7e52003-06-30 16:24:52 +0000760 Note that if the RTC uses I2C, then the I2C interface
761 must also be configured. See I2C Support, below.
762
Peter Tysere92739d2008-12-17 16:36:21 -0600763- GPIO Support:
764 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
765 CONFIG_PCA953X_INFO - enable pca953x info command
766
767 Note that if the GPIO device uses I2C, then the I2C interface
768 must also be configured. See I2C Support, below.
769
wdenkc6097192002-11-03 00:24:07 +0000770- Timestamp Support:
771
wdenk43d96162003-03-06 00:02:04 +0000772 When CONFIG_TIMESTAMP is selected, the timestamp
773 (date and time) of an image is printed by image
774 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500775 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000776
777- Partition Support:
778 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400779 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000780
Wolfgang Denk218ca722008-03-26 10:40:12 +0100781 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
782 CONFIG_CMD_SCSI) you must configure support for at
783 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000784
785- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000786 CONFIG_IDE_RESET_ROUTINE - this is defined in several
787 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000788
wdenk4d13cba2004-03-14 14:09:05 +0000789 CONFIG_IDE_RESET - is this is defined, IDE Reset will
790 be performed by calling the function
791 ide_set_reset(int reset)
792 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000793
794- ATAPI Support:
795 CONFIG_ATAPI
796
797 Set this to enable ATAPI support.
798
wdenkc40b2952004-03-13 23:29:43 +0000799- LBA48 Support
800 CONFIG_LBA48
801
802 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100803 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000804 Whithout these , LBA48 support uses 32bit variables and will 'only'
805 support disks up to 2.1TB.
806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200807 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000808 When enabled, makes the IDE subsystem use 64bit sector addresses.
809 Default is 32bit.
810
wdenkc6097192002-11-03 00:24:07 +0000811- SCSI Support:
812 At the moment only there is only support for the
813 SYM53C8XX SCSI controller; define
814 CONFIG_SCSI_SYM53C8XX to enable it.
815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200816 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
817 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
818 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000819 maximum numbers of LUNs, SCSI ID's and target
820 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200821 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000822
823- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000824 CONFIG_E1000
825 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000826
Andre Schwarzac3315c2008-03-06 16:45:44 +0100827 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200828 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100829
wdenkc6097192002-11-03 00:24:07 +0000830 CONFIG_EEPRO100
831 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200832 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000833 write routine for first time initialisation.
834
835 CONFIG_TULIP
836 Support for Digital 2114x chips.
837 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
838 modem chip initialisation (KS8761/QS6611).
839
840 CONFIG_NATSEMI
841 Support for National dp83815 chips.
842
843 CONFIG_NS8382X
844 Support for National dp8382[01] gigabit chips.
845
wdenk45219c42003-05-12 21:50:16 +0000846- NETWORK Support (other):
847
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100848 CONFIG_DRIVER_AT91EMAC
849 Support for AT91RM9200 EMAC.
850
851 CONFIG_RMII
852 Define this to use reduced MII inteface
853
854 CONFIG_DRIVER_AT91EMAC_QUIET
855 If this defined, the driver is quiet.
856 The driver doen't show link status messages.
857
wdenk45219c42003-05-12 21:50:16 +0000858 CONFIG_DRIVER_LAN91C96
859 Support for SMSC's LAN91C96 chips.
860
861 CONFIG_LAN91C96_BASE
862 Define this to hold the physical address
863 of the LAN91C96's I/O space
864
865 CONFIG_LAN91C96_USE_32_BIT
866 Define this to enable 32 bit addressing
867
wdenkf39748a2004-06-09 13:37:52 +0000868 CONFIG_DRIVER_SMC91111
869 Support for SMSC's LAN91C111 chip
870
871 CONFIG_SMC91111_BASE
872 Define this to hold the physical address
873 of the device (I/O space)
874
875 CONFIG_SMC_USE_32_BIT
876 Define this if data bus is 32 bits
877
878 CONFIG_SMC_USE_IOFUNCS
879 Define this to use i/o functions instead of macros
880 (some hardware wont work with macros)
881
Mike Rapoportc2fff332009-11-11 10:03:03 +0200882 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200883 Support for SMSC's LAN911x and LAN921x chips
884
Mike Rapoportc2fff332009-11-11 10:03:03 +0200885 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200886 Define this to hold the physical address
887 of the device (I/O space)
888
Mike Rapoportc2fff332009-11-11 10:03:03 +0200889 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200890 Define this if data bus is 32 bits
891
Mike Rapoportc2fff332009-11-11 10:03:03 +0200892 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200893 Define this if data bus is 16 bits. If your processor
894 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200895 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200896
wdenkc6097192002-11-03 00:24:07 +0000897- USB Support:
898 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000899 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000900 CONFIG_USB_UHCI to enable it.
901 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000902 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000903 storage devices.
904 Note:
905 Supported are USB Keyboards and USB Floppy drives
906 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000907 MPC5200 USB requires additional defines:
908 CONFIG_USB_CLOCK
909 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500910 CONFIG_PSC3_USB
911 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000912 CONFIG_USB_CONFIG
913 for differential drivers: 0x00001000
914 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500915 for differential drivers on PSC3: 0x00000100
916 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200917 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200918 May be defined to allow interrupt polling
919 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000920
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200921- USB Device:
922 Define the below if you wish to use the USB console.
923 Once firmware is rebuilt from a serial console issue the
924 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200925 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200926 it has found a new device. The environment variable usbtty
927 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200928 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200929 Common Device Class Abstract Control Model serial device.
930 If you select usbtty = gserial you should be able to enumerate
931 a Linux host by
932 # modprobe usbserial vendor=0xVendorID product=0xProductID
933 else if using cdc_acm, simply setting the environment
934 variable usbtty to be cdc_acm should suffice. The following
935 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200936
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200937 CONFIG_USB_DEVICE
938 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000939
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200940 CONFIG_USB_TTY
941 Define this to have a tty type of device available to
942 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200944 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200945 Define this if you want stdin, stdout &/or stderr to
946 be set to usbtty.
947
948 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200949 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200950 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200951 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200953 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200954 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200955 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200956
Wolfgang Denk386eda02006-06-14 18:14:56 +0200957 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200958 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200959 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200960 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
961 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
962 should pretend to be a Linux device to it's target host.
963
964 CONFIG_USBD_MANUFACTURER
965 Define this string as the name of your company for
966 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200967
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200968 CONFIG_USBD_PRODUCT_NAME
969 Define this string as the name of your product
970 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
971
972 CONFIG_USBD_VENDORID
973 Define this as your assigned Vendor ID from the USB
974 Implementors Forum. This *must* be a genuine Vendor ID
975 to avoid polluting the USB namespace.
976 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200977
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200978 CONFIG_USBD_PRODUCTID
979 Define this as the unique Product ID
980 for your device
981 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000982
983
984- MMC Support:
985 The MMC controller on the Intel PXA is supported. To
986 enable this define CONFIG_MMC. The MMC can be
987 accessed from the boot prompt by mapping the device
988 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500989 enabled with CONFIG_CMD_MMC. The MMC driver also works with
990 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000991
wdenk6705d812004-08-02 23:22:59 +0000992- Journaling Flash filesystem support:
993 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
994 CONFIG_JFFS2_NAND_DEV
995 Define these for a default partition on a NAND device
996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200997 CONFIG_SYS_JFFS2_FIRST_SECTOR,
998 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +0000999 Define these for a default partition on a NOR device
1000
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001001 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001002 Define this to create an own partition. You have to provide a
1003 function struct part_info* jffs2_part_info(int part_num)
1004
1005 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001006 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001007 to disable the command chpart. This is the default when you
1008 have not defined a custom partition
1009
wdenkc6097192002-11-03 00:24:07 +00001010- Keyboard Support:
1011 CONFIG_ISA_KEYBOARD
1012
1013 Define this to enable standard (PC-Style) keyboard
1014 support
1015
1016 CONFIG_I8042_KBD
1017 Standard PC keyboard driver with US (is default) and
1018 GERMAN key layout (switch via environment 'keymap=de') support.
1019 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1020 for cfb_console. Supports cursor blinking.
1021
1022- Video support:
1023 CONFIG_VIDEO
1024
1025 Define this to enable video support (for output to
1026 video).
1027
1028 CONFIG_VIDEO_CT69000
1029
1030 Enable Chips & Technologies 69000 Video chip
1031
1032 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001033 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001034 video output is selected via environment 'videoout'
1035 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1036 assumed.
wdenkc6097192002-11-03 00:24:07 +00001037
wdenkb79a11c2004-03-25 15:14:43 +00001038 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001039 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001040 are possible:
1041 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001042 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001043
1044 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1045 -------------+---------------------------------------------
1046 8 bits | 0x301* 0x303 0x305 0x161 0x307
1047 15 bits | 0x310 0x313 0x316 0x162 0x319
1048 16 bits | 0x311 0x314 0x317 0x163 0x31A
1049 24 bits | 0x312 0x315 0x318 ? 0x31B
1050 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001051 (i.e. setenv videomode 317; saveenv; reset;)
1052
wdenkb79a11c2004-03-25 15:14:43 +00001053 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001054 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001055
1056
stroesec1551ea2003-04-04 15:53:41 +00001057 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001058 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001059 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1060 or CONFIG_VIDEO_SED13806_16BPP
1061
wdenk682011f2003-06-03 23:54:09 +00001062- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001063 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001064
wdenk8bde7f72003-06-27 21:31:46 +00001065 Define this to enable a custom keyboard support.
1066 This simply calls drv_keyboard_init() which must be
1067 defined in your board-specific files.
1068 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001069
wdenkc6097192002-11-03 00:24:07 +00001070- LCD Support: CONFIG_LCD
1071
1072 Define this to enable LCD support (for output to LCD
1073 display); also select one of the supported displays
1074 by defining one of these:
1075
Stelian Pop39cf4802008-05-09 21:57:18 +02001076 CONFIG_ATMEL_LCD:
1077
1078 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1079
wdenkfd3103b2003-11-25 16:55:19 +00001080 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001081
wdenkfd3103b2003-11-25 16:55:19 +00001082 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001083
wdenkfd3103b2003-11-25 16:55:19 +00001084 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001085
wdenkfd3103b2003-11-25 16:55:19 +00001086 NEC NL6448BC20-08. 6.5", 640x480.
1087 Active, color, single scan.
1088
1089 CONFIG_NEC_NL6448BC33_54
1090
1091 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001092 Active, color, single scan.
1093
1094 CONFIG_SHARP_16x9
1095
1096 Sharp 320x240. Active, color, single scan.
1097 It isn't 16x9, and I am not sure what it is.
1098
1099 CONFIG_SHARP_LQ64D341
1100
1101 Sharp LQ64D341 display, 640x480.
1102 Active, color, single scan.
1103
1104 CONFIG_HLD1045
1105
1106 HLD1045 display, 640x480.
1107 Active, color, single scan.
1108
1109 CONFIG_OPTREX_BW
1110
1111 Optrex CBL50840-2 NF-FW 99 22 M5
1112 or
1113 Hitachi LMG6912RPFC-00T
1114 or
1115 Hitachi SP14Q002
1116
1117 320x240. Black & white.
1118
1119 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001120 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001121
wdenk7152b1d2003-09-05 23:19:14 +00001122- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001123
wdenk8bde7f72003-06-27 21:31:46 +00001124 If this option is set, the environment is checked for
1125 a variable "splashimage". If found, the usual display
1126 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001127 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001128 specified in "splashimage" is loaded instead. The
1129 console is redirected to the "nulldev", too. This
1130 allows for a "silent" boot where a splash screen is
1131 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001132
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001133 CONFIG_SPLASH_SCREEN_ALIGN
1134
1135 If this option is set the splash image can be freely positioned
1136 on the screen. Environment variable "splashpos" specifies the
1137 position as "x,y". If a positive number is given it is used as
1138 number of pixel from left/top. If a negative number is given it
1139 is used as number of pixel from right/bottom. You can also
1140 specify 'm' for centering the image.
1141
1142 Example:
1143 setenv splashpos m,m
1144 => image at center of screen
1145
1146 setenv splashpos 30,20
1147 => image at x = 30 and y = 20
1148
1149 setenv splashpos -10,m
1150 => vertically centered image
1151 at x = dspWidth - bmpWidth - 9
1152
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001153- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1154
1155 If this option is set, additionally to standard BMP
1156 images, gzipped BMP images can be displayed via the
1157 splashscreen support or the bmp command.
1158
Anatolij Gustschind5011762010-03-15 14:50:25 +01001159- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1160
1161 If this option is set, 8-bit RLE compressed BMP images
1162 can be displayed via the splashscreen support or the
1163 bmp command.
1164
wdenkc29fdfc2003-08-29 20:57:53 +00001165- Compression support:
1166 CONFIG_BZIP2
1167
1168 If this option is set, support for bzip2 compressed
1169 images is included. If not, only uncompressed and gzip
1170 compressed images are supported.
1171
wdenk42d1f032003-10-15 23:53:47 +00001172 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001173 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001174 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001175
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001176 CONFIG_LZMA
1177
1178 If this option is set, support for lzma compressed
1179 images is included.
1180
1181 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1182 requires an amount of dynamic memory that is given by the
1183 formula:
1184
1185 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1186
1187 Where lc and lp stand for, respectively, Literal context bits
1188 and Literal pos bits.
1189
1190 This value is upper-bounded by 14MB in the worst case. Anyway,
1191 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1192 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1193 a very small buffer.
1194
1195 Use the lzmainfo tool to determinate the lc and lp values and
1196 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001197 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001198
wdenk17ea1172004-06-06 21:51:03 +00001199- MII/PHY support:
1200 CONFIG_PHY_ADDR
1201
1202 The address of PHY on MII bus.
1203
1204 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1205
1206 The clock frequency of the MII bus
1207
1208 CONFIG_PHY_GIGE
1209
1210 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001211 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001212
1213 CONFIG_PHY_RESET_DELAY
1214
1215 Some PHY like Intel LXT971A need extra delay after
1216 reset before any MII register access is possible.
1217 For such PHY, set this option to the usec delay
1218 required. (minimum 300usec for LXT971A)
1219
1220 CONFIG_PHY_CMD_DELAY (ppc4xx)
1221
1222 Some PHY like Intel LXT971A need extra delay after
1223 command issued before MII status register can be read
1224
wdenkc6097192002-11-03 00:24:07 +00001225- Ethernet address:
1226 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001227 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001228 CONFIG_ETH2ADDR
1229 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001230 CONFIG_ETH4ADDR
1231 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001232
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001233 Define a default value for Ethernet address to use
1234 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001235 is not determined automatically.
1236
1237- IP address:
1238 CONFIG_IPADDR
1239
1240 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001241 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001242 determined through e.g. bootp.
1243
1244- Server IP address:
1245 CONFIG_SERVERIP
1246
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001247 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001248 server to contact when using the "tftboot" command.
1249
Robin Getz97cfe862009-07-21 12:15:28 -04001250 CONFIG_KEEP_SERVERADDR
1251
1252 Keeps the server's MAC address, in the env 'serveraddr'
1253 for passing to bootargs (like Linux's netconsole option)
1254
David Updegraff53a5c422007-06-11 10:41:07 -05001255- Multicast TFTP Mode:
1256 CONFIG_MCAST_TFTP
1257
1258 Defines whether you want to support multicast TFTP as per
1259 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001260 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001261 driver in use must provide a function: mcast() to join/leave a
1262 multicast group.
1263
1264 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001265- BOOTP Recovery Mode:
1266 CONFIG_BOOTP_RANDOM_DELAY
1267
1268 If you have many targets in a network that try to
1269 boot using BOOTP, you may want to avoid that all
1270 systems send out BOOTP requests at precisely the same
1271 moment (which would happen for instance at recovery
1272 from a power failure, when all systems will try to
1273 boot, thus flooding the BOOTP server. Defining
1274 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1275 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001276 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001277
1278 1st BOOTP request: delay 0 ... 1 sec
1279 2nd BOOTP request: delay 0 ... 2 sec
1280 3rd BOOTP request: delay 0 ... 4 sec
1281 4th and following
1282 BOOTP requests: delay 0 ... 8 sec
1283
stroesefe389a82003-08-28 14:17:32 +00001284- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001285 You can fine tune the DHCP functionality by defining
1286 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001287
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001288 CONFIG_BOOTP_SUBNETMASK
1289 CONFIG_BOOTP_GATEWAY
1290 CONFIG_BOOTP_HOSTNAME
1291 CONFIG_BOOTP_NISDOMAIN
1292 CONFIG_BOOTP_BOOTPATH
1293 CONFIG_BOOTP_BOOTFILESIZE
1294 CONFIG_BOOTP_DNS
1295 CONFIG_BOOTP_DNS2
1296 CONFIG_BOOTP_SEND_HOSTNAME
1297 CONFIG_BOOTP_NTPSERVER
1298 CONFIG_BOOTP_TIMEOFFSET
1299 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001300
Wilson Callan5d110f02007-07-28 10:56:13 -04001301 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1302 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001303
1304 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1305 serverip from a DHCP server, it is possible that more
1306 than one DNS serverip is offered to the client.
1307 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1308 serverip will be stored in the additional environment
1309 variable "dnsip2". The first DNS serverip is always
1310 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001311 is defined.
stroesefe389a82003-08-28 14:17:32 +00001312
1313 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1314 to do a dynamic update of a DNS server. To do this, they
1315 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001316 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001317 of the "hostname" environment variable is passed as
1318 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001319
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001320 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1321
1322 A 32bit value in microseconds for a delay between
1323 receiving a "DHCP Offer" and sending the "DHCP Request".
1324 This fixes a problem with certain DHCP servers that don't
1325 respond 100% of the time to a "DHCP request". E.g. On an
1326 AT91RM9200 processor running at 180MHz, this delay needed
1327 to be *at least* 15,000 usec before a Windows Server 2003
1328 DHCP server would reply 100% of the time. I recommend at
1329 least 50,000 usec to be safe. The alternative is to hope
1330 that one of the retries will be successful but note that
1331 the DHCP timeout and retry process takes a longer than
1332 this delay.
1333
wdenka3d991b2004-04-15 21:48:45 +00001334 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001335 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001336
1337 The device id used in CDP trigger frames.
1338
1339 CONFIG_CDP_DEVICE_ID_PREFIX
1340
1341 A two character string which is prefixed to the MAC address
1342 of the device.
1343
1344 CONFIG_CDP_PORT_ID
1345
1346 A printf format string which contains the ascii name of
1347 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001348 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001349
1350 CONFIG_CDP_CAPABILITIES
1351
1352 A 32bit integer which indicates the device capabilities;
1353 0x00000010 for a normal host which does not forwards.
1354
1355 CONFIG_CDP_VERSION
1356
1357 An ascii string containing the version of the software.
1358
1359 CONFIG_CDP_PLATFORM
1360
1361 An ascii string containing the name of the platform.
1362
1363 CONFIG_CDP_TRIGGER
1364
1365 A 32bit integer sent on the trigger.
1366
1367 CONFIG_CDP_POWER_CONSUMPTION
1368
1369 A 16bit integer containing the power consumption of the
1370 device in .1 of milliwatts.
1371
1372 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1373
1374 A byte containing the id of the VLAN.
1375
wdenkc6097192002-11-03 00:24:07 +00001376- Status LED: CONFIG_STATUS_LED
1377
1378 Several configurations allow to display the current
1379 status using a LED. For instance, the LED will blink
1380 fast while running U-Boot code, stop blinking as
1381 soon as a reply to a BOOTP request was received, and
1382 start blinking slow once the Linux kernel is running
1383 (supported by a status LED driver in the Linux
1384 kernel). Defining CONFIG_STATUS_LED enables this
1385 feature in U-Boot.
1386
1387- CAN Support: CONFIG_CAN_DRIVER
1388
1389 Defining CONFIG_CAN_DRIVER enables CAN driver support
1390 on those systems that support this (optional)
1391 feature, like the TQM8xxL modules.
1392
1393- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1394
wdenkb37c7e52003-06-30 16:24:52 +00001395 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001396 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001397 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001398
wdenk945af8d2003-07-16 21:53:01 +00001399 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001400 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001401 CONFIG_COMMANDS) and communicate with i2c based realtime
1402 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001403 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001404
Ben Warrenbb99ad62006-09-07 16:50:54 -04001405 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001406
wdenk945af8d2003-07-16 21:53:01 +00001407 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001408 bit-banging) driver instead of CPM or similar hardware
1409 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001410
wdenk945af8d2003-07-16 21:53:01 +00001411 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001412 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001413
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001414 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001415 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001416 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001417 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001418
Peter Tyser8d321b82010-04-12 22:28:21 -05001419 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001420 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001421 and so its address should therefore be cleared to 0 (See,
1422 eg, MPC823e User's Manual p.16-473). So, set
1423 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001424
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001425 CONFIG_SYS_I2C_INIT_MPC5XXX
1426
1427 When a board is reset during an i2c bus transfer
1428 chips might think that the current transfer is still
1429 in progress. Reset the slave devices by sending start
1430 commands until the slave device responds.
1431
wdenk945af8d2003-07-16 21:53:01 +00001432 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001433
1434 If you use the software i2c interface (CONFIG_SOFT_I2C)
1435 then the following macros need to be defined (examples are
1436 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001437
1438 I2C_INIT
1439
wdenkb37c7e52003-06-30 16:24:52 +00001440 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001441 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001442
wdenkba56f622004-02-06 23:19:44 +00001443 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001444
wdenkc6097192002-11-03 00:24:07 +00001445 I2C_PORT
1446
wdenk43d96162003-03-06 00:02:04 +00001447 (Only for MPC8260 CPU). The I/O port to use (the code
1448 assumes both bits are on the same port). Valid values
1449 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001450
1451 I2C_ACTIVE
1452
1453 The code necessary to make the I2C data line active
1454 (driven). If the data line is open collector, this
1455 define can be null.
1456
wdenkb37c7e52003-06-30 16:24:52 +00001457 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1458
wdenkc6097192002-11-03 00:24:07 +00001459 I2C_TRISTATE
1460
1461 The code necessary to make the I2C data line tri-stated
1462 (inactive). If the data line is open collector, this
1463 define can be null.
1464
wdenkb37c7e52003-06-30 16:24:52 +00001465 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1466
wdenkc6097192002-11-03 00:24:07 +00001467 I2C_READ
1468
1469 Code that returns TRUE if the I2C data line is high,
1470 FALSE if it is low.
1471
wdenkb37c7e52003-06-30 16:24:52 +00001472 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1473
wdenkc6097192002-11-03 00:24:07 +00001474 I2C_SDA(bit)
1475
1476 If <bit> is TRUE, sets the I2C data line high. If it
1477 is FALSE, it clears it (low).
1478
wdenkb37c7e52003-06-30 16:24:52 +00001479 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001480 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001481 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001482
wdenkc6097192002-11-03 00:24:07 +00001483 I2C_SCL(bit)
1484
1485 If <bit> is TRUE, sets the I2C clock line high. If it
1486 is FALSE, it clears it (low).
1487
wdenkb37c7e52003-06-30 16:24:52 +00001488 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001489 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001490 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001491
wdenkc6097192002-11-03 00:24:07 +00001492 I2C_DELAY
1493
1494 This delay is invoked four times per clock cycle so this
1495 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001496 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001497 like:
1498
wdenkb37c7e52003-06-30 16:24:52 +00001499 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001500
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001501 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001502
wdenk8bde7f72003-06-27 21:31:46 +00001503 When a board is reset during an i2c bus transfer
1504 chips might think that the current transfer is still
1505 in progress. On some boards it is possible to access
1506 the i2c SCLK line directly, either by using the
1507 processor pin as a GPIO or by having a second pin
1508 connected to the bus. If this option is defined a
1509 custom i2c_init_board() routine in boards/xxx/board.c
1510 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001511
Richard Retanubun26a33502010-04-12 15:08:17 -04001512 CONFIG_SYS_I2C_BOARD_LATE_INIT
1513
1514 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1515 defined a custom i2c_board_late_init() routine in
1516 boards/xxx/board.c is run AFTER the operations in i2c_init()
1517 is completed. This callpoint can be used to unreset i2c bus
1518 using CPU i2c controller register accesses for CPUs whose i2c
1519 controller provide such a method. It is called at the end of
1520 i2c_init() to allow i2c_init operations to setup the i2c bus
1521 controller on the CPU (e.g. setting bus speed & slave address).
1522
wdenk17ea1172004-06-06 21:51:03 +00001523 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1524
1525 This option enables configuration of bi_iic_fast[] flags
1526 in u-boot bd_info structure based on u-boot environment
1527 variable "i2cfast". (see also i2cfast)
1528
Ben Warrenbb99ad62006-09-07 16:50:54 -04001529 CONFIG_I2C_MULTI_BUS
1530
1531 This option allows the use of multiple I2C buses, each of which
1532 must have a controller. At any point in time, only one bus is
1533 active. To switch to a different bus, use the 'i2c dev' command.
1534 Note that bus numbering is zero-based.
1535
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001536 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001537
1538 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001539 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1540 is set, specify a list of bus-device pairs. Otherwise, specify
1541 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001542
1543 e.g.
1544 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001545 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001546
1547 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1548
1549 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001550 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001551
1552 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1553
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001554 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001555
1556 If defined, then this indicates the I2C bus number for DDR SPD.
1557 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1558
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001559 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001560
1561 If defined, then this indicates the I2C bus number for the RTC.
1562 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001564 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001565
1566 If defined, then this indicates the I2C bus number for the DTT.
1567 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1568
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001569 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001570
1571 If defined, specifies the I2C address of the DTT device.
1572 If not defined, then U-Boot uses predefined value for
1573 specified DTT device.
1574
Timur Tabibe5e6182006-11-03 19:15:00 -06001575 CONFIG_FSL_I2C
1576
1577 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001578 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001579
Heiko Schocher67b23a32008-10-15 09:39:47 +02001580 CONFIG_I2C_MUX
1581
1582 Define this option if you have I2C devices reached over 1 .. n
1583 I2C Muxes like the pca9544a. This option addes a new I2C
1584 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1585 new I2C Bus to the existing I2C Busses. If you select the
1586 new Bus with "i2c dev", u-bbot sends first the commandos for
1587 the muxes to activate this new "bus".
1588
1589 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1590 feature!
1591
1592 Example:
1593 Adding a new I2C Bus reached over 2 pca9544a muxes
1594 The First mux with address 70 and channel 6
1595 The Second mux with address 71 and channel 4
1596
1597 => i2c bus pca9544a:70:6:pca9544a:71:4
1598
1599 Use the "i2c bus" command without parameter, to get a list
1600 of I2C Busses with muxes:
1601
1602 => i2c bus
1603 Busses reached over muxes:
1604 Bus ID: 2
1605 reached over Mux(es):
1606 pca9544a@70 ch: 4
1607 Bus ID: 3
1608 reached over Mux(es):
1609 pca9544a@70 ch: 6
1610 pca9544a@71 ch: 4
1611 =>
1612
1613 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1614 u-boot sends First the Commando to the mux@70 to enable
1615 channel 6, and then the Commando to the mux@71 to enable
1616 the channel 4.
1617
1618 After that, you can use the "normal" i2c commands as
1619 usual, to communicate with your I2C devices behind
1620 the 2 muxes.
1621
1622 This option is actually implemented for the bitbanging
1623 algorithm in common/soft_i2c.c and for the Hardware I2C
1624 Bus on the MPC8260. But it should be not so difficult
1625 to add this option to other architectures.
1626
Andrew Dyer2ac69852008-12-29 17:36:01 -06001627 CONFIG_SOFT_I2C_READ_REPEATED_START
1628
1629 defining this will force the i2c_read() function in
1630 the soft_i2c driver to perform an I2C repeated start
1631 between writing the address pointer and reading the
1632 data. If this define is omitted the default behaviour
1633 of doing a stop-start sequence will be used. Most I2C
1634 devices can use either method, but some require one or
1635 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001636
wdenkc6097192002-11-03 00:24:07 +00001637- SPI Support: CONFIG_SPI
1638
1639 Enables SPI driver (so far only tested with
1640 SPI EEPROM, also an instance works with Crystal A/D and
1641 D/As on the SACSng board)
1642
1643 CONFIG_SPI_X
1644
1645 Enables extended (16-bit) SPI EEPROM addressing.
1646 (symmetrical to CONFIG_I2C_X)
1647
1648 CONFIG_SOFT_SPI
1649
wdenk43d96162003-03-06 00:02:04 +00001650 Enables a software (bit-bang) SPI driver rather than
1651 using hardware support. This is a general purpose
1652 driver that only requires three general I/O port pins
1653 (two outputs, one input) to function. If this is
1654 defined, the board configuration must define several
1655 SPI configuration items (port pins to use, etc). For
1656 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001657
Ben Warren04a9e112008-01-16 22:37:35 -05001658 CONFIG_HARD_SPI
1659
1660 Enables a hardware SPI driver for general-purpose reads
1661 and writes. As with CONFIG_SOFT_SPI, the board configuration
1662 must define a list of chip-select function pointers.
1663 Currently supported on some MPC8xxx processors. For an
1664 example, see include/configs/mpc8349emds.h.
1665
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001666 CONFIG_MXC_SPI
1667
1668 Enables the driver for the SPI controllers on i.MX and MXC
1669 SoCs. Currently only i.MX31 is supported.
1670
Matthias Fuchs01335022007-12-27 17:12:34 +01001671- FPGA Support: CONFIG_FPGA
1672
1673 Enables FPGA subsystem.
1674
1675 CONFIG_FPGA_<vendor>
1676
1677 Enables support for specific chip vendors.
1678 (ALTERA, XILINX)
1679
1680 CONFIG_FPGA_<family>
1681
1682 Enables support for FPGA family.
1683 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1684
1685 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001686
wdenk43d96162003-03-06 00:02:04 +00001687 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001688
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001689 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001690
wdenk8bde7f72003-06-27 21:31:46 +00001691 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001692
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001693 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001694
wdenk43d96162003-03-06 00:02:04 +00001695 Enable checks on FPGA configuration interface busy
1696 status by the configuration function. This option
1697 will require a board or device specific function to
1698 be written.
wdenkc6097192002-11-03 00:24:07 +00001699
1700 CONFIG_FPGA_DELAY
1701
1702 If defined, a function that provides delays in the FPGA
1703 configuration driver.
1704
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001705 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001706 Allow Control-C to interrupt FPGA configuration
1707
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001708 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001709
wdenk43d96162003-03-06 00:02:04 +00001710 Check for configuration errors during FPGA bitfile
1711 loading. For example, abort during Virtex II
1712 configuration if the INIT_B line goes low (which
1713 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001715 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001716
wdenk43d96162003-03-06 00:02:04 +00001717 Maximum time to wait for the INIT_B line to deassert
1718 after PROB_B has been deasserted during a Virtex II
1719 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001720 ms.
wdenkc6097192002-11-03 00:24:07 +00001721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001722 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001723
wdenk43d96162003-03-06 00:02:04 +00001724 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001725 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001727 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001728
wdenk43d96162003-03-06 00:02:04 +00001729 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001730 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001731
1732- Configuration Management:
1733 CONFIG_IDENT_STRING
1734
wdenk43d96162003-03-06 00:02:04 +00001735 If defined, this string will be added to the U-Boot
1736 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001737
1738- Vendor Parameter Protection:
1739
wdenk43d96162003-03-06 00:02:04 +00001740 U-Boot considers the values of the environment
1741 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001742 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001743 are set once by the board vendor / manufacturer, and
1744 protects these variables from casual modification by
1745 the user. Once set, these variables are read-only,
1746 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001747 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001748
1749 If CONFIG_ENV_OVERWRITE is #defined in your config
1750 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001751 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001752 these parameters.
1753
1754 Alternatively, if you #define _both_ CONFIG_ETHADDR
1755 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001756 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001757 which can be changed exactly ONCE by the user. [The
1758 serial# is unaffected by this, i. e. it remains
1759 read-only.]
1760
1761- Protected RAM:
1762 CONFIG_PRAM
1763
1764 Define this variable to enable the reservation of
1765 "protected RAM", i. e. RAM which is not overwritten
1766 by U-Boot. Define CONFIG_PRAM to hold the number of
1767 kB you want to reserve for pRAM. You can overwrite
1768 this default value by defining an environment
1769 variable "pram" to the number of kB you want to
1770 reserve. Note that the board info structure will
1771 still show the full amount of RAM. If pRAM is
1772 reserved, a new environment variable "mem" will
1773 automatically be defined to hold the amount of
1774 remaining RAM in a form that can be passed as boot
1775 argument to Linux, for instance like that:
1776
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001777 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001778 saveenv
1779
1780 This way you can tell Linux not to use this memory,
1781 either, which results in a memory region that will
1782 not be affected by reboots.
1783
1784 *WARNING* If your board configuration uses automatic
1785 detection of the RAM size, you must make sure that
1786 this memory test is non-destructive. So far, the
1787 following board configurations are known to be
1788 "pRAM-clean":
1789
1790 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1791 HERMES, IP860, RPXlite, LWMON, LANTEC,
1792 PCU_E, FLAGADM, TQM8260
1793
1794- Error Recovery:
1795 CONFIG_PANIC_HANG
1796
1797 Define this variable to stop the system in case of a
1798 fatal error, so that you have to reset it manually.
1799 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001800 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001801 automatically as fast as possible, but it may be
1802 useful during development since you can try to debug
1803 the conditions that lead to the situation.
1804
1805 CONFIG_NET_RETRY_COUNT
1806
wdenk43d96162003-03-06 00:02:04 +00001807 This variable defines the number of retries for
1808 network operations like ARP, RARP, TFTP, or BOOTP
1809 before giving up the operation. If not defined, a
1810 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001811
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001812 CONFIG_ARP_TIMEOUT
1813
1814 Timeout waiting for an ARP reply in milliseconds.
1815
wdenkc6097192002-11-03 00:24:07 +00001816- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001817 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001818
1819 Enable auto completion of commands using TAB.
1820
Wolfgang Denka9398e02006-11-27 15:32:42 +01001821 Note that this feature has NOT been implemented yet
1822 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001823
1824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001825 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001826
1827 Define this variable to enable the "hush" shell (from
1828 Busybox) as command line interpreter, thus enabling
1829 powerful command line syntax like
1830 if...then...else...fi conditionals or `&&' and '||'
1831 constructs ("shell scripts").
1832
1833 If undefined, you get the old, much simpler behaviour
1834 with a somewhat smaller memory footprint.
1835
1836
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001837 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001838
1839 This defines the secondary prompt string, which is
1840 printed when the command interpreter needs more input
1841 to complete a command. Usually "> ".
1842
1843 Note:
1844
wdenk8bde7f72003-06-27 21:31:46 +00001845 In the current implementation, the local variables
1846 space and global environment variables space are
1847 separated. Local variables are those you define by
1848 simply typing `name=value'. To access a local
1849 variable later on, you have write `$name' or
1850 `${name}'; to execute the contents of a variable
1851 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001852
wdenk43d96162003-03-06 00:02:04 +00001853 Global environment variables are those you use
1854 setenv/printenv to work with. To run a command stored
1855 in such a variable, you need to use the run command,
1856 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001857
1858 To store commands and special characters in a
1859 variable, please use double quotation marks
1860 surrounding the whole text of the variable, instead
1861 of the backslashes before semicolons and special
1862 symbols.
1863
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001864- Commandline Editing and History:
1865 CONFIG_CMDLINE_EDITING
1866
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001867 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001868 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001869
wdenka8c7c702003-12-06 19:49:23 +00001870- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001871 CONFIG_EXTRA_ENV_SETTINGS
1872
wdenk43d96162003-03-06 00:02:04 +00001873 Define this to contain any number of null terminated
1874 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001875 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001876
wdenk43d96162003-03-06 00:02:04 +00001877 For example, place something like this in your
1878 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001879
1880 #define CONFIG_EXTRA_ENV_SETTINGS \
1881 "myvar1=value1\0" \
1882 "myvar2=value2\0"
1883
wdenk43d96162003-03-06 00:02:04 +00001884 Warning: This method is based on knowledge about the
1885 internal format how the environment is stored by the
1886 U-Boot code. This is NOT an official, exported
1887 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001888 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001889 You better know what you are doing here.
1890
wdenk43d96162003-03-06 00:02:04 +00001891 Note: overly (ab)use of the default environment is
1892 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001893 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001894 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001895
wdenka8c7c702003-12-06 19:49:23 +00001896- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001897 CONFIG_HAS_DATAFLASH
1898
wdenk8bde7f72003-06-27 21:31:46 +00001899 Defining this option enables DataFlash features and
1900 allows to read/write in Dataflash via the standard
1901 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001902
wdenk3f85ce22004-02-23 16:11:30 +00001903- SystemACE Support:
1904 CONFIG_SYSTEMACE
1905
1906 Adding this option adds support for Xilinx SystemACE
1907 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001908 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001909 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001910
1911 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001912 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001913
1914 When SystemACE support is added, the "ace" device type
1915 becomes available to the fat commands, i.e. fatls.
1916
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001917- TFTP Fixed UDP Port:
1918 CONFIG_TFTP_PORT
1919
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001920 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001921 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001922 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001923 number generator is used.
1924
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001925 Also, the environment variable tftpdstp is used to supply
1926 the TFTP UDP destination port value. If tftpdstp isn't
1927 defined, the normal port 69 is used.
1928
1929 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001930 blindly start the TFTP transfer using the pre-configured
1931 target IP address and UDP port. This has the effect of
1932 "punching through" the (Windows XP) firewall, allowing
1933 the remainder of the TFTP transfer to proceed normally.
1934 A better solution is to properly configure the firewall,
1935 but sometimes that is not allowed.
1936
wdenka8c7c702003-12-06 19:49:23 +00001937- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001938 CONFIG_SHOW_BOOT_PROGRESS
1939
wdenk43d96162003-03-06 00:02:04 +00001940 Defining this option allows to add some board-
1941 specific code (calling a user-provided function
1942 "show_boot_progress(int)") that enables you to show
1943 the system's boot progress on some display (for
1944 example, some LED's) on your board. At the moment,
1945 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001946
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001947Legacy uImage format:
1948
wdenkc6097192002-11-03 00:24:07 +00001949 Arg Where When
1950 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001951 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001952 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001953 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001954 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001955 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001956 4 common/cmd_bootm.c Image data has correct checksum
1957 -4 common/cmd_bootm.c Image is for unsupported architecture
1958 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001959 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001960 6 common/cmd_bootm.c Image Type check OK
1961 -6 common/cmd_bootm.c gunzip uncompression error
1962 -7 common/cmd_bootm.c Unimplemented compression type
1963 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001964 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001965 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001966
1967 9 common/image.c Start initial ramdisk verification
1968 -10 common/image.c Ramdisk header has bad magic number
1969 -11 common/image.c Ramdisk header has bad checksum
1970 10 common/image.c Ramdisk header is OK
1971 -12 common/image.c Ramdisk data has bad checksum
1972 11 common/image.c Ramdisk data has correct checksum
1973 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001974 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001975 13 common/image.c Start multifile image verification
1976 14 common/image.c No initial ramdisk, no multifile, continue.
1977
Peter Tyserea0364f2010-04-12 22:28:04 -05001978 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001979
Stefan Roesea47a12b2010-04-15 16:07:28 +02001980 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00001981 -31 post/post.c POST test failed, detected by post_output_backlog()
1982 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001983
Heiko Schocher566a4942007-06-22 19:11:54 +02001984 34 common/cmd_doc.c before loading a Image from a DOC device
1985 -35 common/cmd_doc.c Bad usage of "doc" command
1986 35 common/cmd_doc.c correct usage of "doc" command
1987 -36 common/cmd_doc.c No boot device
1988 36 common/cmd_doc.c correct boot device
1989 -37 common/cmd_doc.c Unknown Chip ID on boot device
1990 37 common/cmd_doc.c correct chip ID found, device available
1991 -38 common/cmd_doc.c Read Error on boot device
1992 38 common/cmd_doc.c reading Image header from DOC device OK
1993 -39 common/cmd_doc.c Image header has bad magic number
1994 39 common/cmd_doc.c Image header has correct magic number
1995 -40 common/cmd_doc.c Error reading Image from DOC device
1996 40 common/cmd_doc.c Image header has correct magic number
1997 41 common/cmd_ide.c before loading a Image from a IDE device
1998 -42 common/cmd_ide.c Bad usage of "ide" command
1999 42 common/cmd_ide.c correct usage of "ide" command
2000 -43 common/cmd_ide.c No boot device
2001 43 common/cmd_ide.c boot device found
2002 -44 common/cmd_ide.c Device not available
2003 44 common/cmd_ide.c Device available
2004 -45 common/cmd_ide.c wrong partition selected
2005 45 common/cmd_ide.c partition selected
2006 -46 common/cmd_ide.c Unknown partition table
2007 46 common/cmd_ide.c valid partition table found
2008 -47 common/cmd_ide.c Invalid partition type
2009 47 common/cmd_ide.c correct partition type
2010 -48 common/cmd_ide.c Error reading Image Header on boot device
2011 48 common/cmd_ide.c reading Image Header from IDE device OK
2012 -49 common/cmd_ide.c Image header has bad magic number
2013 49 common/cmd_ide.c Image header has correct magic number
2014 -50 common/cmd_ide.c Image header has bad checksum
2015 50 common/cmd_ide.c Image header has correct checksum
2016 -51 common/cmd_ide.c Error reading Image from IDE device
2017 51 common/cmd_ide.c reading Image from IDE device OK
2018 52 common/cmd_nand.c before loading a Image from a NAND device
2019 -53 common/cmd_nand.c Bad usage of "nand" command
2020 53 common/cmd_nand.c correct usage of "nand" command
2021 -54 common/cmd_nand.c No boot device
2022 54 common/cmd_nand.c boot device found
2023 -55 common/cmd_nand.c Unknown Chip ID on boot device
2024 55 common/cmd_nand.c correct chip ID found, device available
2025 -56 common/cmd_nand.c Error reading Image Header on boot device
2026 56 common/cmd_nand.c reading Image Header from NAND device OK
2027 -57 common/cmd_nand.c Image header has bad magic number
2028 57 common/cmd_nand.c Image header has correct magic number
2029 -58 common/cmd_nand.c Error reading Image from NAND device
2030 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002031
Heiko Schocher566a4942007-06-22 19:11:54 +02002032 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002033
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002034 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002035 -64 net/eth.c no Ethernet found.
2036 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002037
Heiko Schocher566a4942007-06-22 19:11:54 +02002038 -80 common/cmd_net.c usage wrong
2039 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002040 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002041 81 common/cmd_net.c NetLoop() back without error
2042 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2043 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002044 83 common/cmd_net.c running "source" command
2045 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002046 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002047
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002048FIT uImage format:
2049
2050 Arg Where When
2051 100 common/cmd_bootm.c Kernel FIT Image has correct format
2052 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2053 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2054 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2055 102 common/cmd_bootm.c Kernel unit name specified
2056 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002057 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002058 104 common/cmd_bootm.c Got kernel subimage node offset
2059 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2060 105 common/cmd_bootm.c Kernel subimage hash verification OK
2061 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2062 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002063 -106 common/cmd_bootm.c Kernel subimage has wrong type
2064 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002065 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2066 108 common/cmd_bootm.c Got kernel subimage data/size
2067 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2068 -109 common/cmd_bootm.c Can't get kernel subimage type
2069 -110 common/cmd_bootm.c Can't get kernel subimage comp
2070 -111 common/cmd_bootm.c Can't get kernel subimage os
2071 -112 common/cmd_bootm.c Can't get kernel subimage load address
2072 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2073
2074 120 common/image.c Start initial ramdisk verification
2075 -120 common/image.c Ramdisk FIT image has incorrect format
2076 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002077 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002078 -122 common/image.c Can't get configuration for ramdisk subimage
2079 123 common/image.c Ramdisk unit name specified
2080 -124 common/image.c Can't get ramdisk subimage node offset
2081 125 common/image.c Got ramdisk subimage node offset
2082 -125 common/image.c Ramdisk subimage hash verification failed
2083 126 common/image.c Ramdisk subimage hash verification OK
2084 -126 common/image.c Ramdisk subimage for unsupported architecture
2085 127 common/image.c Architecture check OK
2086 -127 common/image.c Can't get ramdisk subimage data/size
2087 128 common/image.c Got ramdisk subimage data/size
2088 129 common/image.c Can't get ramdisk load address
2089 -129 common/image.c Got ramdisk load address
2090
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002091 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002092 131 common/cmd_doc.c FIT image format OK
2093
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002094 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002095 141 common/cmd_ide.c FIT image format OK
2096
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002097 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002098 151 common/cmd_nand.c FIT image format OK
2099
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002100- Automatic software updates via TFTP server
2101 CONFIG_UPDATE_TFTP
2102 CONFIG_UPDATE_TFTP_CNT_MAX
2103 CONFIG_UPDATE_TFTP_MSEC_MAX
2104
2105 These options enable and control the auto-update feature;
2106 for a more detailed description refer to doc/README.update.
2107
2108- MTD Support (mtdparts command, UBI support)
2109 CONFIG_MTD_DEVICE
2110
2111 Adds the MTD device infrastructure from the Linux kernel.
2112 Needed for mtdparts command support.
2113
2114 CONFIG_MTD_PARTITIONS
2115
2116 Adds the MTD partitioning infrastructure from the Linux
2117 kernel. Needed for UBI support.
2118
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002119
wdenkc6097192002-11-03 00:24:07 +00002120Modem Support:
2121--------------
2122
wdenk85ec0bc2003-03-31 16:34:49 +00002123[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002124
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002125- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002126 CONFIG_MODEM_SUPPORT
2127
2128- RTS/CTS Flow control enable:
2129 CONFIG_HWFLOW
2130
2131- Modem debug support:
2132 CONFIG_MODEM_SUPPORT_DEBUG
2133
wdenk43d96162003-03-06 00:02:04 +00002134 Enables debugging stuff (char screen[1024], dbg())
2135 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002136
wdenka8c7c702003-12-06 19:49:23 +00002137- Interrupt support (PPC):
2138
wdenkd4ca31c2004-01-02 14:00:00 +00002139 There are common interrupt_init() and timer_interrupt()
2140 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002141 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002142 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002143 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002144 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002145 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002146 specific handling. If board has watchdog / status_led
2147 / other_activity_monitor it works automatically from
2148 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002149
wdenkc6097192002-11-03 00:24:07 +00002150- General:
2151
wdenk43d96162003-03-06 00:02:04 +00002152 In the target system modem support is enabled when a
2153 specific key (key combination) is pressed during
2154 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002155 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002156 board_init(). Currently key_pressed() is a dummy
2157 function, returning 1 and thus enabling modem
2158 initialization.
wdenkc6097192002-11-03 00:24:07 +00002159
wdenk43d96162003-03-06 00:02:04 +00002160 If there are no modem init strings in the
2161 environment, U-Boot proceed to autoboot; the
2162 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002163 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002164
2165 See also: doc/README.Modem
2166
2167
wdenkc6097192002-11-03 00:24:07 +00002168Configuration Settings:
2169-----------------------
2170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002171- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002172 undefine this when you're short of memory.
2173
Peter Tyser2fb26042009-01-27 18:03:12 -06002174- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2175 width of the commands listed in the 'help' command output.
2176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002177- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002178 prompt for user input.
2179
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002180- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002181
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002182- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002183
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002184- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002185
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002186- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002187 the application (usually a Linux kernel) when it is
2188 booted
2189
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002190- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002191 List of legal baudrate settings for this board.
2192
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002193- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002194 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002195
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002196- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002197 If the board specific function
2198 extern int overwrite_console (void);
2199 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002200 serial port, else the settings in the environment are used.
2201
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002202- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002203 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002204
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002205- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002206 Enable overwrite of previous console environment settings.
2207
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002208- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002209 Begin and End addresses of the area used by the
2210 simple memory test.
2211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002212- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002213 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002214
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002215- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002216 Scratch address used by the alternate memory test
2217 You only need to set this if address zero isn't writeable
2218
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002219- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2220 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002221 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002222 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002223 fixing up gd->ram_size the Linux kernel should gets passed
2224 the now "corrected" memory size and won't touch it either.
2225 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002226 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002227 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002228 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002229
2230 This option can be used as a workaround for the 440EPx/GRx
2231 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2232 be touched.
2233
2234 WARNING: Please make sure that this value is a multiple of
2235 the Linux page size (normally 4k). If this is not the case,
2236 then the end address of the Linux memory will be located at a
2237 non page size aligned address and this could cause major
2238 problems.
2239
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002240- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002241 Default load address for network file downloads
2242
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002243- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002244 Enable temporary baudrate change while serial download
2245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002246- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002247 Physical start address of SDRAM. _Must_ be 0 here.
2248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002249- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002250 Physical start address of Motherboard I/O (if using a
2251 Cogent motherboard)
2252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002253- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002254 Physical start address of Flash memory.
2255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002256- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002257 Physical start address of boot monitor code (set by
2258 make config files to be same as the text base address
2259 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002260 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002262- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002263 Size of memory reserved for monitor code, used to
2264 determine _at_compile_time_ (!) if the environment is
2265 embedded within the U-Boot image, or in a separate
2266 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002267
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002268- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002269 Size of DRAM reserved for malloc() use.
2270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002271- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002272 Normally compressed uImages are limited to an
2273 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002274 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002275 to adjust this setting to your needs.
2276
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002277- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002278 Maximum size of memory mapped by the startup code of
2279 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002280 the Linux kernel (bd_info, boot arguments, FDT blob if
2281 used) must be put below this limit, unless "bootm_low"
2282 enviroment variable is defined and non-zero. In such case
2283 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002284 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002286- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002287 Max number of Flash memory banks
2288
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002289- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002290 Max number of sectors on a Flash chip
2291
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002292- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002293 Timeout for Flash erase operations (in ms)
2294
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002295- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002296 Timeout for Flash write operations (in ms)
2297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002298- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002299 Timeout for Flash set sector lock bit operation (in ms)
2300
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002301- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002302 Timeout for Flash clear lock bits operation (in ms)
2303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002304- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002305 If defined, hardware flash sectors protection is used
2306 instead of U-Boot software protection.
2307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002308- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002309
2310 Enable TFTP transfers directly to flash memory;
2311 without this option such a download has to be
2312 performed in two steps: (1) download to RAM, and (2)
2313 copy from RAM to flash.
2314
2315 The two-step approach is usually more reliable, since
2316 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002317 the flash, but in some situations (when system RAM is
2318 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002319 downloaded image) this option may be very useful.
2320
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002321- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002322 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002323 common flash structure for storing flash geometry.
2324
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002325- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002326 This option also enables the building of the cfi_flash driver
2327 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002328
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002329- CONFIG_FLASH_CFI_MTD
2330 This option enables the building of the cfi_mtd driver
2331 in the drivers directory. The driver exports CFI flash
2332 to the MTD layer.
2333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002334- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002335 Use buffered writes to flash.
2336
2337- CONFIG_FLASH_SPANSION_S29WS_N
2338 s29ws-n MirrorBit flash has non-standard addresses for buffered
2339 write commands.
2340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002341- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002342 If this option is defined, the common CFI flash doesn't
2343 print it's warning upon not recognized FLASH banks. This
2344 is useful, if some of the configured banks are only
2345 optionally available.
2346
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002347- CONFIG_FLASH_SHOW_PROGRESS
2348 If defined (must be an integer), print out countdown
2349 digits and dots. Recommended value: 45 (9..1) for 80
2350 column displays, 15 (3..1) for 40 column displays.
2351
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002352- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002353 Defines the number of Ethernet receive buffers. On some
2354 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002355 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2356 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002357 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002358 Defaults to 4 if not defined.
2359
wdenkc6097192002-11-03 00:24:07 +00002360The following definitions that deal with the placement and management
2361of environment data (variable area); in general, we support the
2362following configurations:
2363
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002364- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002365
2366 Define this if the environment is in flash memory.
2367
2368 a) The environment occupies one whole flash sector, which is
2369 "embedded" in the text segment with the U-Boot code. This
2370 happens usually with "bottom boot sector" or "top boot
2371 sector" type flash chips, which have several smaller
2372 sectors at the start or the end. For instance, such a
2373 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2374 such a case you would place the environment in one of the
2375 4 kB sectors - with U-Boot code before and after it. With
2376 "top boot sector" type flash chips, you would put the
2377 environment in one of the last sectors, leaving a gap
2378 between U-Boot and the environment.
2379
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002380 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002381
2382 Offset of environment data (variable area) to the
2383 beginning of flash memory; for instance, with bottom boot
2384 type flash chips the second sector can be used: the offset
2385 for this sector is given here.
2386
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002387 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002388
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002389 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002390
2391 This is just another way to specify the start address of
2392 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002393 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002394
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002395 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002396
2397 Size of the sector containing the environment.
2398
2399
2400 b) Sometimes flash chips have few, equal sized, BIG sectors.
2401 In such a case you don't want to spend a whole sector for
2402 the environment.
2403
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002404 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002405
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002406 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002407 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002408 of this flash sector for the environment. This saves
2409 memory for the RAM copy of the environment.
2410
2411 It may also save flash memory if you decide to use this
2412 when your environment is "embedded" within U-Boot code,
2413 since then the remainder of the flash sector could be used
2414 for U-Boot code. It should be pointed out that this is
2415 STRONGLY DISCOURAGED from a robustness point of view:
2416 updating the environment in flash makes it always
2417 necessary to erase the WHOLE sector. If something goes
2418 wrong before the contents has been restored from a copy in
2419 RAM, your target system will be dead.
2420
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002421 - CONFIG_ENV_ADDR_REDUND
2422 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002423
wdenk43d96162003-03-06 00:02:04 +00002424 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002425 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002426 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002427 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002428
2429BE CAREFUL! Any changes to the flash layout, and some changes to the
2430source code will make it necessary to adapt <board>/u-boot.lds*
2431accordingly!
2432
2433
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002434- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002435
2436 Define this if you have some non-volatile memory device
2437 (NVRAM, battery buffered SRAM) which you want to use for the
2438 environment.
2439
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002440 - CONFIG_ENV_ADDR:
2441 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002442
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002443 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002444 want to use for environment. It is assumed that this memory
2445 can just be read and written to, without any special
2446 provision.
2447
2448BE CAREFUL! The first access to the environment happens quite early
2449in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002450console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002451U-Boot will hang.
2452
2453Please note that even with NVRAM we still use a copy of the
2454environment in RAM: we could work on NVRAM directly, but we want to
2455keep settings there always unmodified except somebody uses "saveenv"
2456to save the current settings.
2457
2458
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002459- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002460
2461 Use this if you have an EEPROM or similar serial access
2462 device and a driver for it.
2463
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002464 - CONFIG_ENV_OFFSET:
2465 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002466
2467 These two #defines specify the offset and size of the
2468 environment area within the total memory of your EEPROM.
2469
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002470 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002471 If defined, specified the chip address of the EEPROM device.
2472 The default address is zero.
2473
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002474 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002475 If defined, the number of bits used to address bytes in a
2476 single page in the EEPROM device. A 64 byte page, for example
2477 would require six bits.
2478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002479 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002480 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002481 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002482
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002483 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002484 The length in bytes of the EEPROM memory array address. Note
2485 that this is NOT the chip address length!
2486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002487 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002488 EEPROM chips that implement "address overflow" are ones
2489 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2490 address and the extra bits end up in the "chip address" bit
2491 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2492 byte chips.
2493
2494 Note that we consider the length of the address field to
2495 still be one byte because the extra address bits are hidden
2496 in the chip address.
2497
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002498 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002499 The size in bytes of the EEPROM device.
2500
Heiko Schocher548738b2010-01-07 08:55:40 +01002501 - CONFIG_ENV_EEPROM_IS_ON_I2C
2502 define this, if you have I2C and SPI activated, and your
2503 EEPROM, which holds the environment, is on the I2C bus.
2504
2505 - CONFIG_I2C_ENV_EEPROM_BUS
2506 if you have an Environment on an EEPROM reached over
2507 I2C muxes, you can define here, how to reach this
2508 EEPROM. For example:
2509
2510 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
2511
2512 EEPROM which holds the environment, is reached over
2513 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002514
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002515- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002516
wdenkd4ca31c2004-01-02 14:00:00 +00002517 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002518 want to use for the environment.
2519
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002520 - CONFIG_ENV_OFFSET:
2521 - CONFIG_ENV_ADDR:
2522 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002523
2524 These three #defines specify the offset and size of the
2525 environment area within the total memory of your DataFlash placed
2526 at the specified address.
2527
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002528- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002529
2530 Define this if you have a NAND device which you want to use
2531 for the environment.
2532
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002533 - CONFIG_ENV_OFFSET:
2534 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002535
2536 These two #defines specify the offset and size of the environment
2537 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00002538
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002539 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002540
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002541 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002542 size used to hold a redundant copy of the environment data,
2543 so that there is a valid backup copy in case there is a
2544 power failure during a "saveenv" operation.
2545
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002546 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2547 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002548 the NAND devices block size.
2549
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002550- CONFIG_NAND_ENV_DST
2551
2552 Defines address in RAM to which the nand_spl code should copy the
2553 environment. If redundant environment is used, it will be copied to
2554 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002556- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002557
2558 Defines offset to the initial SPI buffer area in DPRAM. The
2559 area is used at an early stage (ROM part) if the environment
2560 is configured to reside in the SPI EEPROM: We need a 520 byte
2561 scratch DPRAM area. It is used between the two initialization
2562 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2563 to be a good choice since it makes it far enough from the
2564 start of the data area as well as from the stack pointer.
2565
Bruce Adlere881cb52007-11-02 13:15:42 -07002566Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002567has been relocated to RAM and a RAM copy of the environment has been
2568created; also, when using EEPROM you will have to use getenv_r()
2569until then to read environment variables.
2570
wdenk85ec0bc2003-03-31 16:34:49 +00002571The environment is protected by a CRC32 checksum. Before the monitor
2572is relocated into RAM, as a result of a bad CRC you will be working
2573with the compiled-in default environment - *silently*!!! [This is
2574necessary, because the first environment variable we need is the
2575"baudrate" setting for the console - if we have a bad CRC, we don't
2576have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002577
2578Note: once the monitor has been relocated, then it will complain if
2579the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002580use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002582- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002583 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002584
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002585 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002586 also needs to be defined.
2587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002588- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002589 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002590
Ron Madridf5675aa2009-02-18 14:30:44 -08002591- CONFIG_NS16550_MIN_FUNCTIONS:
2592 Define this if you desire to only have use of the NS16550_init
2593 and NS16550_putc functions for the serial driver located at
2594 drivers/serial/ns16550.c. This option is useful for saving
2595 space for already greatly restricted images, including but not
2596 limited to NAND_SPL configurations.
2597
wdenkc6097192002-11-03 00:24:07 +00002598Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002599---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002600
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002601- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002602 Cache Line Size of the CPU.
2603
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002604- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002605 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002606
wdenk42d1f032003-10-15 23:53:47 +00002607 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2608 and RPXsuper) to be able to adjust the position of
2609 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002610
wdenk7f6c2cb2002-11-10 22:06:23 +00002611- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002612 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002613
2614 the default drive number (default value 0)
2615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002616 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002617
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002618 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002619 (default value 1)
2620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002621 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002622
wdenk43d96162003-03-06 00:02:04 +00002623 defines the offset of register from address. It
2624 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002625 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002627 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2628 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002629 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002630
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002631 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002632 fdc_hw_init() is called at the beginning of the FDC
2633 setup. fdc_hw_init() must be provided by the board
2634 source code. It is used to make hardware dependant
2635 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002636
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002637- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002638 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002639 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002640
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002641- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002642
wdenk7152b1d2003-09-05 23:19:14 +00002643 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002644 initial data and stack; please note that this must be
2645 writable memory that is working WITHOUT special
2646 initialization, i. e. you CANNOT use normal RAM which
2647 will become available only after programming the
2648 memory controller and running certain initialization
2649 sequences.
2650
2651 U-Boot uses the following memory types:
2652 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2653 - MPC824X: data cache
2654 - PPC4xx: data cache
2655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002656- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002657
2658 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002659 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2660 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002661 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002662 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2663 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2664 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2665 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002666
2667 Note:
2668 On the MPC824X (or other systems that use the data
2669 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002670 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002671 point to an otherwise UNUSED address space between
2672 the top of RAM and the start of the PCI space.
2673
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002674- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002675
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002676- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002677
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002678- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002680- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002681
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002682- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002683
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002684- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002686- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002687 SDRAM timing
2688
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002689- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002690 periodic timer for refresh
2691
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002692- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002693
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002694- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2695 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2696 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2697 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002698 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2699
2700- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002701 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2702 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002703 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2704
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002705- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2706 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002707 Machine Mode Register and Memory Periodic Timer
2708 Prescaler definitions (SDRAM timing)
2709
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002710- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002711 enable I2C microcode relocation patch (MPC8xx);
2712 define relocation offset in DPRAM [DSP2]
2713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002714- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002715 enable SMC microcode relocation patch (MPC8xx);
2716 define relocation offset in DPRAM [SMC1]
2717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002718- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002719 enable SPI microcode relocation patch (MPC8xx);
2720 define relocation offset in DPRAM [SCC4]
2721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002722- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002723 Use OSCM clock mode on MBX8xx board. Be careful,
2724 wrong setting might damage your board. Read
2725 doc/README.MBX before setting this variable!
2726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002727- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002728 Offset of the bootmode word in DPRAM used by post
2729 (Power On Self Tests). This definition overrides
2730 #define'd default value in commproc.h resp.
2731 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2734 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2735 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2736 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2737 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2738 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2739 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2740 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002741 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002742
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002743- CONFIG_PCI_DISABLE_PCIE:
2744 Disable PCI-Express on systems where it is supported but not
2745 required.
2746
Ben Warrenbb99ad62006-09-07 16:50:54 -04002747- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002748 Get DDR timing information from an I2C EEPROM. Common
2749 with pluggable memory modules such as SODIMMs
2750
Ben Warrenbb99ad62006-09-07 16:50:54 -04002751 SPD_EEPROM_ADDRESS
2752 I2C address of the SPD EEPROM
2753
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002754- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002755 If SPD EEPROM is on an I2C bus other than the first
2756 one, specify here. Note that the value must resolve
2757 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002758
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002759- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002760 Only for 83xx systems. If specified, then DDR should
2761 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002762
wdenkc26e4542004-04-18 10:13:26 +00002763- CONFIG_ETHER_ON_FEC[12]
2764 Define to enable FEC[12] on a 8xx series processor.
2765
2766- CONFIG_FEC[12]_PHY
2767 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002768 to the given FEC; i. e.
2769 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002770 means that the PHY with address 4 is connected to FEC1
2771
2772 When set to -1, means to probe for first available.
2773
2774- CONFIG_FEC[12]_PHY_NORXERR
2775 The PHY does not have a RXERR line (RMII only).
2776 (so program the FEC to ignore it).
2777
2778- CONFIG_RMII
2779 Enable RMII mode for all FECs.
2780 Note that this is a global option, we can't
2781 have one FEC in standard MII mode and another in RMII mode.
2782
wdenk5cf91d62004-04-23 20:32:05 +00002783- CONFIG_CRC32_VERIFY
2784 Add a verify option to the crc32 command.
2785 The syntax is:
2786
2787 => crc32 -v <address> <count> <crc32>
2788
2789 Where address/count indicate a memory area
2790 and crc32 is the correct crc32 which the
2791 area should have.
2792
wdenk56523f12004-07-11 17:40:54 +00002793- CONFIG_LOOPW
2794 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002795 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002796
stroese7b466642004-12-16 18:46:55 +00002797- CONFIG_MX_CYCLIC
2798 Add the "mdc" and "mwc" memory commands. These are cyclic
2799 "md/mw" commands.
2800 Examples:
2801
wdenkefe2a4d2004-12-16 21:44:03 +00002802 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002803 This command will print 4 bytes (10,11,12,13) each 500 ms.
2804
wdenkefe2a4d2004-12-16 21:44:03 +00002805 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002806 This command will write 12345678 to address 100 all 10 ms.
2807
wdenkefe2a4d2004-12-16 21:44:03 +00002808 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002809 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002810
wdenk8aa1a2d2005-04-04 12:44:11 +00002811- CONFIG_SKIP_LOWLEVEL_INIT
2812- CONFIG_SKIP_RELOCATE_UBOOT
2813
wdenk3c2b3d42005-04-05 23:32:21 +00002814 [ARM only] If these variables are defined, then
2815 certain low level initializations (like setting up
2816 the memory controller) are omitted and/or U-Boot does
2817 not relocate itself into RAM.
2818 Normally these variables MUST NOT be defined. The
2819 only exception is when U-Boot is loaded (to RAM) by
2820 some other boot loader or by a debugger which
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002821 performs these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002822
Magnus Liljadf812382009-06-13 20:50:00 +02002823- CONFIG_PRELOADER
2824
2825 Modifies the behaviour of start.S when compiling a loader
2826 that is executed before the actual U-Boot. E.g. when
2827 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002828
wdenkc6097192002-11-03 00:24:07 +00002829Building the Software:
2830======================
2831
Wolfgang Denk218ca722008-03-26 10:40:12 +01002832Building U-Boot has been tested in several native build environments
2833and in many different cross environments. Of course we cannot support
2834all possibly existing versions of cross development tools in all
2835(potentially obsolete) versions. In case of tool chain problems we
2836recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2837which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002838
Wolfgang Denk218ca722008-03-26 10:40:12 +01002839If you are not using a native environment, it is assumed that you
2840have GNU cross compiling tools available in your path. In this case,
2841you must set the environment variable CROSS_COMPILE in your shell.
2842Note that no changes to the Makefile or any other source files are
2843necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002844
Wolfgang Denk218ca722008-03-26 10:40:12 +01002845 $ CROSS_COMPILE=ppc_4xx-
2846 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002847
Peter Tyser2f8d3962009-03-13 18:54:51 -05002848Note: If you wish to generate Windows versions of the utilities in
2849 the tools directory you can use the MinGW toolchain
2850 (http://www.mingw.org). Set your HOST tools to the MinGW
2851 toolchain and execute 'make tools'. For example:
2852
2853 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2854
2855 Binaries such as tools/mkimage.exe will be created which can
2856 be executed on computers running Windows.
2857
Wolfgang Denk218ca722008-03-26 10:40:12 +01002858U-Boot is intended to be simple to build. After installing the
2859sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002860is done by typing:
2861
2862 make NAME_config
2863
Wolfgang Denk218ca722008-03-26 10:40:12 +01002864where "NAME_config" is the name of one of the existing configu-
2865rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002866
wdenk2729af92004-05-03 20:45:30 +00002867Note: for some board special configuration names may exist; check if
2868 additional information is available from the board vendor; for
2869 instance, the TQM823L systems are available without (standard)
2870 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002871 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002872
wdenk2729af92004-05-03 20:45:30 +00002873 make TQM823L_config
2874 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002875
wdenk2729af92004-05-03 20:45:30 +00002876 make TQM823L_LCD_config
2877 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002878
wdenk2729af92004-05-03 20:45:30 +00002879 etc.
wdenkc6097192002-11-03 00:24:07 +00002880
wdenkc6097192002-11-03 00:24:07 +00002881
wdenk2729af92004-05-03 20:45:30 +00002882Finally, type "make all", and you should get some working U-Boot
2883images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002884
wdenk2729af92004-05-03 20:45:30 +00002885- "u-boot.bin" is a raw binary image
2886- "u-boot" is an image in ELF binary format
2887- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002888
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002889By default the build is performed locally and the objects are saved
2890in the source directory. One of the two methods can be used to change
2891this behavior and build U-Boot to some external directory:
2892
28931. Add O= to the make command line invocations:
2894
2895 make O=/tmp/build distclean
2896 make O=/tmp/build NAME_config
2897 make O=/tmp/build all
2898
28992. Set environment variable BUILD_DIR to point to the desired location:
2900
2901 export BUILD_DIR=/tmp/build
2902 make distclean
2903 make NAME_config
2904 make all
2905
2906Note that the command line "O=" setting overrides the BUILD_DIR environment
2907variable.
2908
wdenkc6097192002-11-03 00:24:07 +00002909
wdenk2729af92004-05-03 20:45:30 +00002910Please be aware that the Makefiles assume you are using GNU make, so
2911for instance on NetBSD you might need to use "gmake" instead of
2912native "make".
wdenkc6097192002-11-03 00:24:07 +00002913
wdenkc6097192002-11-03 00:24:07 +00002914
wdenk2729af92004-05-03 20:45:30 +00002915If the system board that you have is not listed, then you will need
2916to port U-Boot to your hardware platform. To do this, follow these
2917steps:
wdenkc6097192002-11-03 00:24:07 +00002918
wdenk2729af92004-05-03 20:45:30 +000029191. Add a new configuration option for your board to the toplevel
2920 "Makefile" and to the "MAKEALL" script, using the existing
2921 entries as examples. Note that here and at many other places
2922 boards and other names are listed in alphabetical sort order. Please
2923 keep this order.
29242. Create a new directory to hold your board specific code. Add any
2925 files you need. In your board directory, you will need at least
2926 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
29273. Create a new configuration file "include/configs/<board>.h" for
2928 your board
29293. If you're porting U-Boot to a new CPU, then also create a new
2930 directory to hold your CPU specific code. Add any files you need.
29314. Run "make <board>_config" with your new name.
29325. Type "make", and you should get a working "u-boot.srec" file
2933 to be installed on your target system.
29346. Debug and solve any problems that might arise.
2935 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002936
wdenkc6097192002-11-03 00:24:07 +00002937
wdenk2729af92004-05-03 20:45:30 +00002938Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2939==============================================================
wdenkc6097192002-11-03 00:24:07 +00002940
Wolfgang Denk218ca722008-03-26 10:40:12 +01002941If you have modified U-Boot sources (for instance added a new board
2942or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002943provide feedback to the other developers. The feedback normally takes
2944the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01002945official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002946
Wolfgang Denk218ca722008-03-26 10:40:12 +01002947But before you submit such a patch, please verify that your modifi-
2948cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00002949the supported boards compile WITHOUT ANY compiler warnings. To do so,
2950just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01002951for ALL supported system. Be warned, this will take a while. You can
2952select which (cross) compiler to use by passing a `CROSS_COMPILE'
2953environment variable to the script, i. e. to use the ELDK cross tools
2954you can type
wdenkc6097192002-11-03 00:24:07 +00002955
wdenk2729af92004-05-03 20:45:30 +00002956 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002957
wdenk2729af92004-05-03 20:45:30 +00002958or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002959
wdenk2729af92004-05-03 20:45:30 +00002960 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002961
Wolfgang Denk218ca722008-03-26 10:40:12 +01002962When using the MAKEALL script, the default behaviour is to build
2963U-Boot in the source directory. This location can be changed by
2964setting the BUILD_DIR environment variable. Also, for each target
2965built, the MAKEALL script saves two log files (<target>.ERR and
2966<target>.MAKEALL) in the <source dir>/LOG directory. This default
2967location can be changed by setting the MAKEALL_LOGDIR environment
2968variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002969
2970 export BUILD_DIR=/tmp/build
2971 export MAKEALL_LOGDIR=/tmp/log
2972 CROSS_COMPILE=ppc_8xx- MAKEALL
2973
Wolfgang Denk218ca722008-03-26 10:40:12 +01002974With the above settings build objects are saved in the /tmp/build,
2975log files are saved in the /tmp/log and the source tree remains clean
2976during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002977
2978
wdenk2729af92004-05-03 20:45:30 +00002979See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002980
wdenkc6097192002-11-03 00:24:07 +00002981
wdenk2729af92004-05-03 20:45:30 +00002982Monitor Commands - Overview:
2983============================
wdenkc6097192002-11-03 00:24:07 +00002984
wdenk2729af92004-05-03 20:45:30 +00002985go - start application at address 'addr'
2986run - run commands in an environment variable
2987bootm - boot application image from memory
2988bootp - boot image via network using BootP/TFTP protocol
2989tftpboot- boot image via network using TFTP protocol
2990 and env variables "ipaddr" and "serverip"
2991 (and eventually "gatewayip")
2992rarpboot- boot image via network using RARP/TFTP protocol
2993diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2994loads - load S-Record file over serial line
2995loadb - load binary file over serial line (kermit mode)
2996md - memory display
2997mm - memory modify (auto-incrementing)
2998nm - memory modify (constant address)
2999mw - memory write (fill)
3000cp - memory copy
3001cmp - memory compare
3002crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003003i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003004sspi - SPI utility commands
3005base - print or set address offset
3006printenv- print environment variables
3007setenv - set environment variables
3008saveenv - save environment variables to persistent storage
3009protect - enable or disable FLASH write protection
3010erase - erase FLASH memory
3011flinfo - print FLASH memory information
3012bdinfo - print Board Info structure
3013iminfo - print header information for application image
3014coninfo - print console devices and informations
3015ide - IDE sub-system
3016loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003017loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003018mtest - simple RAM test
3019icache - enable or disable instruction cache
3020dcache - enable or disable data cache
3021reset - Perform RESET of the CPU
3022echo - echo args to console
3023version - print monitor version
3024help - print online help
3025? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003026
wdenkc6097192002-11-03 00:24:07 +00003027
wdenk2729af92004-05-03 20:45:30 +00003028Monitor Commands - Detailed Description:
3029========================================
wdenkc6097192002-11-03 00:24:07 +00003030
wdenk2729af92004-05-03 20:45:30 +00003031TODO.
wdenkc6097192002-11-03 00:24:07 +00003032
wdenk2729af92004-05-03 20:45:30 +00003033For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003034
3035
wdenk2729af92004-05-03 20:45:30 +00003036Environment Variables:
3037======================
wdenkc6097192002-11-03 00:24:07 +00003038
wdenk2729af92004-05-03 20:45:30 +00003039U-Boot supports user configuration using Environment Variables which
3040can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003041
wdenk2729af92004-05-03 20:45:30 +00003042Environment Variables are set using "setenv", printed using
3043"printenv", and saved to Flash using "saveenv". Using "setenv"
3044without a value can be used to delete a variable from the
3045environment. As long as you don't save the environment you are
3046working with an in-memory copy. In case the Flash area containing the
3047environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003048
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003049Some configuration options can be set using Environment Variables.
3050
3051List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003052
wdenk2729af92004-05-03 20:45:30 +00003053 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003054
wdenk2729af92004-05-03 20:45:30 +00003055 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003056
wdenk2729af92004-05-03 20:45:30 +00003057 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003058
wdenk2729af92004-05-03 20:45:30 +00003059 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003060
wdenk2729af92004-05-03 20:45:30 +00003061 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003062
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003063 bootm_low - Memory range available for image processing in the bootm
3064 command can be restricted. This variable is given as
3065 a hexadecimal number and defines lowest address allowed
3066 for use by the bootm command. See also "bootm_size"
3067 environment variable. Address defined by "bootm_low" is
3068 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003069 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003070
3071 bootm_size - Memory range available for image processing in the bootm
3072 command can be restricted. This variable is given as
3073 a hexadecimal number and defines the size of the region
3074 allowed for use by the bootm command. See also "bootm_low"
3075 environment variable.
3076
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003077 updatefile - Location of the software update file on a TFTP server, used
3078 by the automatic software update feature. Please refer to
3079 documentation in doc/README.update for more details.
3080
wdenk2729af92004-05-03 20:45:30 +00003081 autoload - if set to "no" (any string beginning with 'n'),
3082 "bootp" will just load perform a lookup of the
3083 configuration from the BOOTP server, but not try to
3084 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003085
wdenk2729af92004-05-03 20:45:30 +00003086 autostart - if set to "yes", an image loaded using the "bootp",
3087 "rarpboot", "tftpboot" or "diskboot" commands will
3088 be automatically started (by internally calling
3089 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003090
wdenk2729af92004-05-03 20:45:30 +00003091 If set to "no", a standalone image passed to the
3092 "bootm" command will be copied to the load address
3093 (and eventually uncompressed), but NOT be started.
3094 This can be used to load and uncompress arbitrary
3095 data.
wdenkc6097192002-11-03 00:24:07 +00003096
wdenk17ea1172004-06-06 21:51:03 +00003097 i2cfast - (PPC405GP|PPC405EP only)
3098 if set to 'y' configures Linux I2C driver for fast
3099 mode (400kHZ). This environment variable is used in
3100 initialization code. So, for changes to be effective
3101 it must be saved and board must be reset.
3102
wdenk2729af92004-05-03 20:45:30 +00003103 initrd_high - restrict positioning of initrd images:
3104 If this variable is not set, initrd images will be
3105 copied to the highest possible address in RAM; this
3106 is usually what you want since it allows for
3107 maximum initrd size. If for some reason you want to
3108 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003109 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003110 variable to a value of "no" or "off" or "0".
3111 Alternatively, you can set it to a maximum upper
3112 address to use (U-Boot will still check that it
3113 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003114
wdenk2729af92004-05-03 20:45:30 +00003115 For instance, when you have a system with 16 MB
3116 RAM, and want to reserve 4 MB from use by Linux,
3117 you can do this by adding "mem=12M" to the value of
3118 the "bootargs" variable. However, now you must make
3119 sure that the initrd image is placed in the first
3120 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003121
wdenk2729af92004-05-03 20:45:30 +00003122 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003123
wdenk2729af92004-05-03 20:45:30 +00003124 If you set initrd_high to 0xFFFFFFFF, this is an
3125 indication to U-Boot that all addresses are legal
3126 for the Linux kernel, including addresses in flash
3127 memory. In this case U-Boot will NOT COPY the
3128 ramdisk at all. This may be useful to reduce the
3129 boot time on your system, but requires that this
3130 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003131
wdenk2729af92004-05-03 20:45:30 +00003132 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003133
wdenk2729af92004-05-03 20:45:30 +00003134 loadaddr - Default load address for commands like "bootp",
3135 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003136
wdenk2729af92004-05-03 20:45:30 +00003137 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003138
wdenk2729af92004-05-03 20:45:30 +00003139 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003140
wdenk2729af92004-05-03 20:45:30 +00003141 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003142
wdenk2729af92004-05-03 20:45:30 +00003143 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003144
wdenk2729af92004-05-03 20:45:30 +00003145 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003146
wdenk2729af92004-05-03 20:45:30 +00003147 ethprime - When CONFIG_NET_MULTI is enabled controls which
3148 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003149
wdenk2729af92004-05-03 20:45:30 +00003150 ethact - When CONFIG_NET_MULTI is enabled controls which
3151 interface is currently active. For example you
3152 can do the following
wdenkc6097192002-11-03 00:24:07 +00003153
wdenk2729af92004-05-03 20:45:30 +00003154 => setenv ethact FEC ETHERNET
3155 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3156 => setenv ethact SCC ETHERNET
3157 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00003158
Matthias Fuchse1692572008-01-17 07:45:05 +01003159 ethrotate - When set to "no" U-Boot does not go through all
3160 available network interfaces.
3161 It just stays at the currently selected interface.
3162
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003163 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003164 either succeed or fail without retrying.
3165 When set to "once" the network operation will
3166 fail when all the available network interfaces
3167 are tried once without success.
3168 Useful on scripts which control the retry operation
3169 themselves.
wdenkc6097192002-11-03 00:24:07 +00003170
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003171 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003172
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003173 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003174 UDP source port.
3175
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003176 tftpdstport - If this is set, the value is used for TFTP's UDP
3177 destination port instead of the Well Know Port 69.
3178
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003179 tftpblocksize - Block size to use for TFTP transfers; if not set,
3180 we use the TFTP server's default block size
3181
3182 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3183 seconds, minimum value is 1000 = 1 second). Defines
3184 when a packet is considered to be lost so it has to
3185 be retransmitted. The default is 5000 = 5 seconds.
3186 Lowering this value may make downloads succeed
3187 faster in networks with high packet loss rates or
3188 with unreliable TFTP servers.
3189
3190 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003191 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003192 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003193
wdenk2729af92004-05-03 20:45:30 +00003194The following environment variables may be used and automatically
3195updated by the network boot commands ("bootp" and "rarpboot"),
3196depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003197
wdenk2729af92004-05-03 20:45:30 +00003198 bootfile - see above
3199 dnsip - IP address of your Domain Name Server
3200 dnsip2 - IP address of your secondary Domain Name Server
3201 gatewayip - IP address of the Gateway (Router) to use
3202 hostname - Target hostname
3203 ipaddr - see above
3204 netmask - Subnet Mask
3205 rootpath - Pathname of the root filesystem on the NFS server
3206 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003207
wdenka3d991b2004-04-15 21:48:45 +00003208
wdenk2729af92004-05-03 20:45:30 +00003209There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003210
wdenk2729af92004-05-03 20:45:30 +00003211 serial# - contains hardware identification information such
3212 as type string and/or serial number
3213 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003214
wdenk2729af92004-05-03 20:45:30 +00003215These variables can be set only once (usually during manufacturing of
3216the board). U-Boot refuses to delete or overwrite these variables
3217once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003218
3219
wdenk2729af92004-05-03 20:45:30 +00003220Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003221
wdenk2729af92004-05-03 20:45:30 +00003222 ver - Contains the U-Boot version string as printed
3223 with the "version" command. This variable is
3224 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003225
wdenkc6097192002-11-03 00:24:07 +00003226
wdenk2729af92004-05-03 20:45:30 +00003227Please note that changes to some configuration parameters may take
3228only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003229
stroesec1551ea2003-04-04 15:53:41 +00003230
wdenk2729af92004-05-03 20:45:30 +00003231Command Line Parsing:
3232=====================
stroesec1551ea2003-04-04 15:53:41 +00003233
wdenk2729af92004-05-03 20:45:30 +00003234There are two different command line parsers available with U-Boot:
3235the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003236
wdenk2729af92004-05-03 20:45:30 +00003237Old, simple command line parser:
3238--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003239
wdenk2729af92004-05-03 20:45:30 +00003240- supports environment variables (through setenv / saveenv commands)
3241- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003242- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003243- special characters ('$', ';') can be escaped by prefixing with '\',
3244 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003245 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003246- You can also escape text by enclosing in single apostrophes, for example:
3247 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003248
wdenk2729af92004-05-03 20:45:30 +00003249Hush shell:
3250-----------
wdenkf07771c2003-05-28 08:06:31 +00003251
wdenk2729af92004-05-03 20:45:30 +00003252- similar to Bourne shell, with control structures like
3253 if...then...else...fi, for...do...done; while...do...done,
3254 until...do...done, ...
3255- supports environment ("global") variables (through setenv / saveenv
3256 commands) and local shell variables (through standard shell syntax
3257 "name=value"); only environment variables can be used with "run"
3258 command
wdenkf07771c2003-05-28 08:06:31 +00003259
wdenk2729af92004-05-03 20:45:30 +00003260General rules:
3261--------------
wdenkf07771c2003-05-28 08:06:31 +00003262
wdenk2729af92004-05-03 20:45:30 +00003263(1) If a command line (or an environment variable executed by a "run"
3264 command) contains several commands separated by semicolon, and
3265 one of these commands fails, then the remaining commands will be
3266 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003267
wdenk2729af92004-05-03 20:45:30 +00003268(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003269 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003270 command will cause "run" to terminate, i. e. the remaining
3271 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003272
wdenk2729af92004-05-03 20:45:30 +00003273Note for Redundant Ethernet Interfaces:
3274=======================================
wdenkf07771c2003-05-28 08:06:31 +00003275
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003276Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003277such configurations and is capable of automatic selection of a
3278"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003279
wdenk2729af92004-05-03 20:45:30 +00003280Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3281MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3282"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003283
wdenk2729af92004-05-03 20:45:30 +00003284If the network interface stores some valid MAC address (for instance
3285in SROM), this is used as default address if there is NO correspon-
3286ding setting in the environment; if the corresponding environment
3287variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003288
wdenk2729af92004-05-03 20:45:30 +00003289o If the SROM has a valid MAC address, and there is no address in the
3290 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003291
wdenk2729af92004-05-03 20:45:30 +00003292o If there is no valid address in the SROM, and a definition in the
3293 environment exists, then the value from the environment variable is
3294 used.
wdenkc6097192002-11-03 00:24:07 +00003295
wdenk2729af92004-05-03 20:45:30 +00003296o If both the SROM and the environment contain a MAC address, and
3297 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003298
wdenk2729af92004-05-03 20:45:30 +00003299o If both the SROM and the environment contain a MAC address, and the
3300 addresses differ, the value from the environment is used and a
3301 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303o If neither SROM nor the environment contain a MAC address, an error
3304 is raised.
wdenkc6097192002-11-03 00:24:07 +00003305
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307Image Formats:
3308==============
wdenkc6097192002-11-03 00:24:07 +00003309
Marian Balakowicz3310c542008-03-12 12:13:13 +01003310U-Boot is capable of booting (and performing other auxiliary operations on)
3311images in two formats:
3312
3313New uImage format (FIT)
3314-----------------------
3315
3316Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3317to Flattened Device Tree). It allows the use of images with multiple
3318components (several kernels, ramdisks, etc.), with contents protected by
3319SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3320
3321
3322Old uImage format
3323-----------------
3324
3325Old image format is based on binary files which can be basically anything,
3326preceded by a special header; see the definitions in include/image.h for
3327details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3330 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003331 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3332 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3333 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003334* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk2729af92004-05-03 20:45:30 +00003335 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003336 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003337* Compression Type (uncompressed, gzip, bzip2)
3338* Load Address
3339* Entry Point
3340* Image Name
3341* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003342
wdenk2729af92004-05-03 20:45:30 +00003343The header is marked by a special Magic Number, and both the header
3344and the data portions of the image are secured against corruption by
3345CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003346
wdenkc6097192002-11-03 00:24:07 +00003347
wdenk2729af92004-05-03 20:45:30 +00003348Linux Support:
3349==============
wdenkc6097192002-11-03 00:24:07 +00003350
wdenk2729af92004-05-03 20:45:30 +00003351Although U-Boot should support any OS or standalone application
3352easily, the main focus has always been on Linux during the design of
3353U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003354
wdenk2729af92004-05-03 20:45:30 +00003355U-Boot includes many features that so far have been part of some
3356special "boot loader" code within the Linux kernel. Also, any
3357"initrd" images to be used are no longer part of one big Linux image;
3358instead, kernel and "initrd" are separate images. This implementation
3359serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003360
wdenk2729af92004-05-03 20:45:30 +00003361- the same features can be used for other OS or standalone
3362 applications (for instance: using compressed images to reduce the
3363 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003364
wdenk2729af92004-05-03 20:45:30 +00003365- it becomes much easier to port new Linux kernel versions because
3366 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003367
wdenk2729af92004-05-03 20:45:30 +00003368- the same Linux kernel image can now be used with different "initrd"
3369 images; of course this also means that different kernel images can
3370 be run with the same "initrd". This makes testing easier (you don't
3371 have to build a new "zImage.initrd" Linux image when you just
3372 change a file in your "initrd"). Also, a field-upgrade of the
3373 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003374
wdenkc6097192002-11-03 00:24:07 +00003375
wdenk2729af92004-05-03 20:45:30 +00003376Linux HOWTO:
3377============
wdenkc6097192002-11-03 00:24:07 +00003378
wdenk2729af92004-05-03 20:45:30 +00003379Porting Linux to U-Boot based systems:
3380---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003381
wdenk2729af92004-05-03 20:45:30 +00003382U-Boot cannot save you from doing all the necessary modifications to
3383configure the Linux device drivers for use with your target hardware
3384(no, we don't intend to provide a full virtual machine interface to
3385Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003386
Stefan Roesea47a12b2010-04-15 16:07:28 +02003387But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003388
wdenk2729af92004-05-03 20:45:30 +00003389Just make sure your machine specific header file (for instance
3390include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003391Information structure as we define in include/asm-<arch>/u-boot.h,
3392and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003393as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003394
wdenkc6097192002-11-03 00:24:07 +00003395
wdenk2729af92004-05-03 20:45:30 +00003396Configuring the Linux kernel:
3397-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003398
wdenk2729af92004-05-03 20:45:30 +00003399No specific requirements for U-Boot. Make sure you have some root
3400device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003401
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403Building a Linux Image:
3404-----------------------
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3407not used. If you use recent kernel source, a new build target
3408"uImage" will exist which automatically builds an image usable by
3409U-Boot. Most older kernels also have support for a "pImage" target,
3410which was introduced for our predecessor project PPCBoot and uses a
3411100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003412
wdenk2729af92004-05-03 20:45:30 +00003413Example:
wdenkc6097192002-11-03 00:24:07 +00003414
wdenk2729af92004-05-03 20:45:30 +00003415 make TQM850L_config
3416 make oldconfig
3417 make dep
3418 make uImage
wdenkc6097192002-11-03 00:24:07 +00003419
wdenk2729af92004-05-03 20:45:30 +00003420The "uImage" build target uses a special tool (in 'tools/mkimage') to
3421encapsulate a compressed Linux kernel image with header information,
3422CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003423
wdenk2729af92004-05-03 20:45:30 +00003424* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003425
wdenk2729af92004-05-03 20:45:30 +00003426* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003427
wdenk2729af92004-05-03 20:45:30 +00003428 ${CROSS_COMPILE}-objcopy -O binary \
3429 -R .note -R .comment \
3430 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003431
wdenk2729af92004-05-03 20:45:30 +00003432* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003433
wdenk2729af92004-05-03 20:45:30 +00003434 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003435
wdenk2729af92004-05-03 20:45:30 +00003436* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003437
wdenk2729af92004-05-03 20:45:30 +00003438 mkimage -A ppc -O linux -T kernel -C gzip \
3439 -a 0 -e 0 -n "Linux Kernel Image" \
3440 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003441
wdenk24ee89b2002-11-03 17:56:27 +00003442
wdenk2729af92004-05-03 20:45:30 +00003443The "mkimage" tool can also be used to create ramdisk images for use
3444with U-Boot, either separated from the Linux kernel image, or
3445combined into one file. "mkimage" encapsulates the images with a 64
3446byte header containing information about target architecture,
3447operating system, image type, compression method, entry points, time
3448stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003449
wdenk2729af92004-05-03 20:45:30 +00003450"mkimage" can be called in two ways: to verify existing images and
3451print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003452
wdenk2729af92004-05-03 20:45:30 +00003453In the first form (with "-l" option) mkimage lists the information
3454contained in the header of an existing U-Boot image; this includes
3455checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003456
wdenk2729af92004-05-03 20:45:30 +00003457 tools/mkimage -l image
3458 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003459
wdenk2729af92004-05-03 20:45:30 +00003460The second form (with "-d" option) is used to build a U-Boot image
3461from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003462
wdenk2729af92004-05-03 20:45:30 +00003463 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3464 -n name -d data_file image
3465 -A ==> set architecture to 'arch'
3466 -O ==> set operating system to 'os'
3467 -T ==> set image type to 'type'
3468 -C ==> set compression type 'comp'
3469 -a ==> set load address to 'addr' (hex)
3470 -e ==> set entry point to 'ep' (hex)
3471 -n ==> set image name to 'name'
3472 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003473
wdenk69459792004-05-29 16:53:29 +00003474Right now, all Linux kernels for PowerPC systems use the same load
3475address (0x00000000), but the entry point address depends on the
3476kernel version:
wdenkc6097192002-11-03 00:24:07 +00003477
wdenk2729af92004-05-03 20:45:30 +00003478- 2.2.x kernels have the entry point at 0x0000000C,
3479- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003480
wdenk2729af92004-05-03 20:45:30 +00003481So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003482
wdenk2729af92004-05-03 20:45:30 +00003483 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3484 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003485 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003486 > examples/uImage.TQM850L
3487 Image Name: 2.4.4 kernel for TQM850L
3488 Created: Wed Jul 19 02:34:59 2000
3489 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3490 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3491 Load Address: 0x00000000
3492 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003493
wdenk2729af92004-05-03 20:45:30 +00003494To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003495
wdenk2729af92004-05-03 20:45:30 +00003496 -> tools/mkimage -l examples/uImage.TQM850L
3497 Image Name: 2.4.4 kernel for TQM850L
3498 Created: Wed Jul 19 02:34:59 2000
3499 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3500 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3501 Load Address: 0x00000000
3502 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504NOTE: for embedded systems where boot time is critical you can trade
3505speed for memory and install an UNCOMPRESSED image instead: this
3506needs more space in Flash, but boots much faster since it does not
3507need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003508
Stefan Roesea47a12b2010-04-15 16:07:28 +02003509 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003510 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3511 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003512 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003513 > examples/uImage.TQM850L-uncompressed
3514 Image Name: 2.4.4 kernel for TQM850L
3515 Created: Wed Jul 19 02:34:59 2000
3516 Image Type: PowerPC Linux Kernel Image (uncompressed)
3517 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3518 Load Address: 0x00000000
3519 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003520
wdenkc6097192002-11-03 00:24:07 +00003521
wdenk2729af92004-05-03 20:45:30 +00003522Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3523when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003524
wdenk2729af92004-05-03 20:45:30 +00003525 -> tools/mkimage -n 'Simple Ramdisk Image' \
3526 > -A ppc -O linux -T ramdisk -C gzip \
3527 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3528 Image Name: Simple Ramdisk Image
3529 Created: Wed Jan 12 14:01:50 2000
3530 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3531 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3532 Load Address: 0x00000000
3533 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003534
wdenkdb01a2e2004-04-15 23:14:49 +00003535
wdenk2729af92004-05-03 20:45:30 +00003536Installing a Linux Image:
3537-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003538
wdenk2729af92004-05-03 20:45:30 +00003539To downloading a U-Boot image over the serial (console) interface,
3540you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003541
wdenk2729af92004-05-03 20:45:30 +00003542 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003543
wdenk2729af92004-05-03 20:45:30 +00003544The 'objcopy' does not understand the information in the U-Boot
3545image header, so the resulting S-Record file will be relative to
3546address 0x00000000. To load it to a given address, you need to
3547specify the target address as 'offset' parameter with the 'loads'
3548command.
wdenkc6097192002-11-03 00:24:07 +00003549
wdenk2729af92004-05-03 20:45:30 +00003550Example: install the image to address 0x40100000 (which on the
3551TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk2729af92004-05-03 20:45:30 +00003553 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003554
wdenk2729af92004-05-03 20:45:30 +00003555 .......... done
3556 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk2729af92004-05-03 20:45:30 +00003558 => loads 40100000
3559 ## Ready for S-Record download ...
3560 ~>examples/image.srec
3561 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3562 ...
3563 15989 15990 15991 15992
3564 [file transfer complete]
3565 [connected]
3566 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003567
3568
wdenk2729af92004-05-03 20:45:30 +00003569You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003570this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003571corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003572
wdenk2729af92004-05-03 20:45:30 +00003573 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003574
wdenk2729af92004-05-03 20:45:30 +00003575 ## Checking Image at 40100000 ...
3576 Image Name: 2.2.13 for initrd on TQM850L
3577 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3578 Data Size: 335725 Bytes = 327 kB = 0 MB
3579 Load Address: 00000000
3580 Entry Point: 0000000c
3581 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003582
3583
wdenk2729af92004-05-03 20:45:30 +00003584Boot Linux:
3585-----------
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk2729af92004-05-03 20:45:30 +00003587The "bootm" command is used to boot an application that is stored in
3588memory (RAM or Flash). In case of a Linux kernel image, the contents
3589of the "bootargs" environment variable is passed to the kernel as
3590parameters. You can check and modify this variable using the
3591"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003592
3593
wdenk2729af92004-05-03 20:45:30 +00003594 => printenv bootargs
3595 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003596
wdenk2729af92004-05-03 20:45:30 +00003597 => 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 +00003598
wdenk2729af92004-05-03 20:45:30 +00003599 => printenv bootargs
3600 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 +00003601
wdenk2729af92004-05-03 20:45:30 +00003602 => bootm 40020000
3603 ## Booting Linux kernel at 40020000 ...
3604 Image Name: 2.2.13 for NFS on TQM850L
3605 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3606 Data Size: 381681 Bytes = 372 kB = 0 MB
3607 Load Address: 00000000
3608 Entry Point: 0000000c
3609 Verifying Checksum ... OK
3610 Uncompressing Kernel Image ... OK
3611 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
3612 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3613 time_init: decrementer frequency = 187500000/60
3614 Calibrating delay loop... 49.77 BogoMIPS
3615 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3616 ...
wdenkc6097192002-11-03 00:24:07 +00003617
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003618If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003619the memory addresses of both the kernel and the initrd image (PPBCOOT
3620format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003621
wdenk2729af92004-05-03 20:45:30 +00003622 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003623
wdenk2729af92004-05-03 20:45:30 +00003624 ## Checking Image at 40100000 ...
3625 Image Name: 2.2.13 for initrd on TQM850L
3626 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3627 Data Size: 335725 Bytes = 327 kB = 0 MB
3628 Load Address: 00000000
3629 Entry Point: 0000000c
3630 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003631
wdenk2729af92004-05-03 20:45:30 +00003632 ## Checking Image at 40200000 ...
3633 Image Name: Simple Ramdisk Image
3634 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3635 Data Size: 566530 Bytes = 553 kB = 0 MB
3636 Load Address: 00000000
3637 Entry Point: 00000000
3638 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003639
wdenk2729af92004-05-03 20:45:30 +00003640 => bootm 40100000 40200000
3641 ## Booting Linux kernel at 40100000 ...
3642 Image Name: 2.2.13 for initrd on TQM850L
3643 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3644 Data Size: 335725 Bytes = 327 kB = 0 MB
3645 Load Address: 00000000
3646 Entry Point: 0000000c
3647 Verifying Checksum ... OK
3648 Uncompressing Kernel Image ... OK
3649 ## Loading RAMDisk Image at 40200000 ...
3650 Image Name: Simple Ramdisk Image
3651 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3652 Data Size: 566530 Bytes = 553 kB = 0 MB
3653 Load Address: 00000000
3654 Entry Point: 00000000
3655 Verifying Checksum ... OK
3656 Loading Ramdisk ... OK
3657 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
3658 Boot arguments: root=/dev/ram
3659 time_init: decrementer frequency = 187500000/60
3660 Calibrating delay loop... 49.77 BogoMIPS
3661 ...
3662 RAMDISK: Compressed image found at block 0
3663 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003664
wdenk2729af92004-05-03 20:45:30 +00003665 bash#
wdenkc6097192002-11-03 00:24:07 +00003666
Matthew McClintock02677682006-06-28 10:41:37 -05003667Boot Linux and pass a flat device tree:
3668-----------
3669
3670First, U-Boot must be compiled with the appropriate defines. See the section
3671titled "Linux Kernel Interface" above for a more in depth explanation. The
3672following is an example of how to start a kernel and pass an updated
3673flat device tree:
3674
3675=> print oftaddr
3676oftaddr=0x300000
3677=> print oft
3678oft=oftrees/mpc8540ads.dtb
3679=> tftp $oftaddr $oft
3680Speed: 1000, full duplex
3681Using TSEC0 device
3682TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3683Filename 'oftrees/mpc8540ads.dtb'.
3684Load address: 0x300000
3685Loading: #
3686done
3687Bytes transferred = 4106 (100a hex)
3688=> tftp $loadaddr $bootfile
3689Speed: 1000, full duplex
3690Using TSEC0 device
3691TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3692Filename 'uImage'.
3693Load address: 0x200000
3694Loading:############
3695done
3696Bytes transferred = 1029407 (fb51f hex)
3697=> print loadaddr
3698loadaddr=200000
3699=> print oftaddr
3700oftaddr=0x300000
3701=> bootm $loadaddr - $oftaddr
3702## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003703 Image Name: Linux-2.6.17-dirty
3704 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3705 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003706 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003707 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003708 Verifying Checksum ... OK
3709 Uncompressing Kernel Image ... OK
3710Booting using flat device tree at 0x300000
3711Using MPC85xx ADS machine description
3712Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3713[snip]
3714
3715
wdenk2729af92004-05-03 20:45:30 +00003716More About U-Boot Image Types:
3717------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003718
wdenk2729af92004-05-03 20:45:30 +00003719U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003720
wdenk2729af92004-05-03 20:45:30 +00003721 "Standalone Programs" are directly runnable in the environment
3722 provided by U-Boot; it is expected that (if they behave
3723 well) you can continue to work in U-Boot after return from
3724 the Standalone Program.
3725 "OS Kernel Images" are usually images of some Embedded OS which
3726 will take over control completely. Usually these programs
3727 will install their own set of exception handlers, device
3728 drivers, set up the MMU, etc. - this means, that you cannot
3729 expect to re-enter U-Boot except by resetting the CPU.
3730 "RAMDisk Images" are more or less just data blocks, and their
3731 parameters (address, size) are passed to an OS kernel that is
3732 being started.
3733 "Multi-File Images" contain several images, typically an OS
3734 (Linux) kernel image and one or more data images like
3735 RAMDisks. This construct is useful for instance when you want
3736 to boot over the network using BOOTP etc., where the boot
3737 server provides just a single image file, but you want to get
3738 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003739
wdenk2729af92004-05-03 20:45:30 +00003740 "Multi-File Images" start with a list of image sizes, each
3741 image size (in bytes) specified by an "uint32_t" in network
3742 byte order. This list is terminated by an "(uint32_t)0".
3743 Immediately after the terminating 0 follow the images, one by
3744 one, all aligned on "uint32_t" boundaries (size rounded up to
3745 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003746
wdenk2729af92004-05-03 20:45:30 +00003747 "Firmware Images" are binary images containing firmware (like
3748 U-Boot or FPGA images) which usually will be programmed to
3749 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003750
wdenk2729af92004-05-03 20:45:30 +00003751 "Script files" are command sequences that will be executed by
3752 U-Boot's command interpreter; this feature is especially
3753 useful when you configure U-Boot to use a real shell (hush)
3754 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003755
wdenkc6097192002-11-03 00:24:07 +00003756
wdenk2729af92004-05-03 20:45:30 +00003757Standalone HOWTO:
3758=================
wdenkc6097192002-11-03 00:24:07 +00003759
wdenk2729af92004-05-03 20:45:30 +00003760One of the features of U-Boot is that you can dynamically load and
3761run "standalone" applications, which can use some resources of
3762U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk2729af92004-05-03 20:45:30 +00003764Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003765
wdenk2729af92004-05-03 20:45:30 +00003766"Hello World" Demo:
3767-------------------
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk2729af92004-05-03 20:45:30 +00003769'examples/hello_world.c' contains a small "Hello World" Demo
3770application; it is automatically compiled when you build U-Boot.
3771It's configured to run at address 0x00040004, so you can play with it
3772like that:
wdenkc6097192002-11-03 00:24:07 +00003773
wdenk2729af92004-05-03 20:45:30 +00003774 => loads
3775 ## Ready for S-Record download ...
3776 ~>examples/hello_world.srec
3777 1 2 3 4 5 6 7 8 9 10 11 ...
3778 [file transfer complete]
3779 [connected]
3780 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003781
wdenk2729af92004-05-03 20:45:30 +00003782 => go 40004 Hello World! This is a test.
3783 ## Starting application at 0x00040004 ...
3784 Hello World
3785 argc = 7
3786 argv[0] = "40004"
3787 argv[1] = "Hello"
3788 argv[2] = "World!"
3789 argv[3] = "This"
3790 argv[4] = "is"
3791 argv[5] = "a"
3792 argv[6] = "test."
3793 argv[7] = "<NULL>"
3794 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003795
wdenk2729af92004-05-03 20:45:30 +00003796 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003797
wdenk2729af92004-05-03 20:45:30 +00003798Another example, which demonstrates how to register a CPM interrupt
3799handler with the U-Boot code, can be found in 'examples/timer.c'.
3800Here, a CPM timer is set up to generate an interrupt every second.
3801The interrupt service routine is trivial, just printing a '.'
3802character, but this is just a demo program. The application can be
3803controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003804
wdenk2729af92004-05-03 20:45:30 +00003805 ? - print current values og the CPM Timer registers
3806 b - enable interrupts and start timer
3807 e - stop timer and disable interrupts
3808 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003809
wdenk2729af92004-05-03 20:45:30 +00003810 => loads
3811 ## Ready for S-Record download ...
3812 ~>examples/timer.srec
3813 1 2 3 4 5 6 7 8 9 10 11 ...
3814 [file transfer complete]
3815 [connected]
3816 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003817
wdenk2729af92004-05-03 20:45:30 +00003818 => go 40004
3819 ## Starting application at 0x00040004 ...
3820 TIMERS=0xfff00980
3821 Using timer 1
3822 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003823
wdenk2729af92004-05-03 20:45:30 +00003824Hit 'b':
3825 [q, b, e, ?] Set interval 1000000 us
3826 Enabling timer
3827Hit '?':
3828 [q, b, e, ?] ........
3829 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3830Hit '?':
3831 [q, b, e, ?] .
3832 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3833Hit '?':
3834 [q, b, e, ?] .
3835 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3836Hit '?':
3837 [q, b, e, ?] .
3838 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3839Hit 'e':
3840 [q, b, e, ?] ...Stopping timer
3841Hit 'q':
3842 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003843
3844
wdenk2729af92004-05-03 20:45:30 +00003845Minicom warning:
3846================
wdenk85ec0bc2003-03-31 16:34:49 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848Over time, many people have reported problems when trying to use the
3849"minicom" terminal emulation program for serial download. I (wd)
3850consider minicom to be broken, and recommend not to use it. Under
3851Unix, I recommend to use C-Kermit for general purpose use (and
3852especially for kermit binary protocol download ("loadb" command), and
3853use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003854
wdenk2729af92004-05-03 20:45:30 +00003855Nevertheless, if you absolutely want to use it try adding this
3856configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003857
wdenk2729af92004-05-03 20:45:30 +00003858 Name Program Name U/D FullScr IO-Red. Multi
3859 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3860 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003861
3862
wdenk2729af92004-05-03 20:45:30 +00003863NetBSD Notes:
3864=============
wdenkc6097192002-11-03 00:24:07 +00003865
wdenk2729af92004-05-03 20:45:30 +00003866Starting at version 0.9.2, U-Boot supports NetBSD both as host
3867(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003868
wdenk2729af92004-05-03 20:45:30 +00003869Building requires a cross environment; it is known to work on
3870NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3871need gmake since the Makefiles are not compatible with BSD make).
3872Note that the cross-powerpc package does not install include files;
3873attempting to build U-Boot will fail because <machine/ansi.h> is
3874missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003875
wdenk2729af92004-05-03 20:45:30 +00003876 # cd /usr/pkg/cross/powerpc-netbsd/include
3877 # mkdir powerpc
3878 # ln -s powerpc machine
3879 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3880 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003881
wdenk2729af92004-05-03 20:45:30 +00003882Native builds *don't* work due to incompatibilities between native
3883and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk2729af92004-05-03 20:45:30 +00003885Booting assumes that (the first part of) the image booted is a
3886stage-2 loader which in turn loads and then invokes the kernel
3887proper. Loader sources will eventually appear in the NetBSD source
3888tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003889meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003890
3891
wdenk2729af92004-05-03 20:45:30 +00003892Implementation Internals:
3893=========================
wdenkc6097192002-11-03 00:24:07 +00003894
wdenk2729af92004-05-03 20:45:30 +00003895The following is not intended to be a complete description of every
3896implementation detail. However, it should help to understand the
3897inner workings of U-Boot and make it easier to port it to custom
3898hardware.
wdenkc6097192002-11-03 00:24:07 +00003899
3900
wdenk2729af92004-05-03 20:45:30 +00003901Initial Stack, Global Data:
3902---------------------------
wdenkc6097192002-11-03 00:24:07 +00003903
wdenk2729af92004-05-03 20:45:30 +00003904The implementation of U-Boot is complicated by the fact that U-Boot
3905starts running out of ROM (flash memory), usually without access to
3906system RAM (because the memory controller is not initialized yet).
3907This means that we don't have writable Data or BSS segments, and BSS
3908is not initialized as zero. To be able to get a C environment working
3909at all, we have to allocate at least a minimal stack. Implementation
3910options for this are defined and restricted by the CPU used: Some CPU
3911models provide on-chip memory (like the IMMR area on MPC8xx and
3912MPC826x processors), on others (parts of) the data cache can be
3913locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003914
Wolfgang Denk218ca722008-03-26 10:40:12 +01003915 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01003916 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00003917
wdenk2729af92004-05-03 20:45:30 +00003918 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3919 From: "Chris Hallinan" <clh@net1plus.com>
3920 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3921 ...
wdenk43d96162003-03-06 00:02:04 +00003922
wdenk2729af92004-05-03 20:45:30 +00003923 Correct me if I'm wrong, folks, but the way I understand it
3924 is this: Using DCACHE as initial RAM for Stack, etc, does not
3925 require any physical RAM backing up the cache. The cleverness
3926 is that the cache is being used as a temporary supply of
3927 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003928 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00003929 can see how this works by studying the cache architecture and
3930 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003931
wdenk2729af92004-05-03 20:45:30 +00003932 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3933 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003934 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00003935 option should work for you. Using CS 4 should be fine if your
3936 board designers haven't used it for something that would
3937 cause you grief during the initial boot! It is frequently not
3938 used.
wdenk43d96162003-03-06 00:02:04 +00003939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003940 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00003941 with your processor/board/system design. The default value
3942 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003943 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003944 than your SDRAM module. If you have a 64MB SDRAM module, set
3945 it above 400_0000. Just make sure your board has no resources
3946 that are supposed to respond to that address! That code in
3947 start.S has been around a while and should work as is when
3948 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003949
wdenk2729af92004-05-03 20:45:30 +00003950 -Chris Hallinan
3951 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003952
wdenk2729af92004-05-03 20:45:30 +00003953It is essential to remember this, since it has some impact on the C
3954code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk2729af92004-05-03 20:45:30 +00003956* Initialized global data (data segment) is read-only. Do not attempt
3957 to write it.
wdenkc6097192002-11-03 00:24:07 +00003958
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003959* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00003960 as zero data - BSS segment) at all - this is undefined, initiali-
3961 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk2729af92004-05-03 20:45:30 +00003963* Stack space is very limited. Avoid big data buffers or things like
3964 that.
wdenkc6097192002-11-03 00:24:07 +00003965
wdenk2729af92004-05-03 20:45:30 +00003966Having only the stack as writable memory limits means we cannot use
3967normal global data to share information beween the code. But it
3968turned out that the implementation of U-Boot can be greatly
3969simplified by making a global data structure (gd_t) available to all
3970functions. We could pass a pointer to this data as argument to _all_
3971functions, but this would bloat the code. Instead we use a feature of
3972the GCC compiler (Global Register Variables) to share the data: we
3973place a pointer (gd) to the global data into a register which we
3974reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk2729af92004-05-03 20:45:30 +00003976When choosing a register for such a purpose we are restricted by the
3977relevant (E)ABI specifications for the current architecture, and by
3978GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003979
wdenk2729af92004-05-03 20:45:30 +00003980For PowerPC, the following registers have specific use:
3981 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01003982 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00003983 R3-R4: parameter passing and return values
3984 R5-R10: parameter passing
3985 R13: small data area pointer
3986 R30: GOT pointer
3987 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003988
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01003989 (U-Boot also uses R12 as internal GOT pointer. r12
3990 is a volatile register so r12 needs to be reset when
3991 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00003992
Wolfgang Denke7670f62008-02-14 22:43:22 +01003993 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003994
wdenk2729af92004-05-03 20:45:30 +00003995 Note: on PPC, we could use a static initializer (since the
3996 address of the global data structure is known at compile time),
3997 but it turned out that reserving a register results in somewhat
3998 smaller code - although the code savings are not that big (on
3999 average for all boards 752 bytes for the whole U-Boot image,
4000 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004001
Robin Getzc4db3352009-08-17 15:23:02 +00004002On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004003 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4004
Robin Getzc4db3352009-08-17 15:23:02 +00004005 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004006
wdenk2729af92004-05-03 20:45:30 +00004007On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004008
wdenk2729af92004-05-03 20:45:30 +00004009 R0: function argument word/integer result
4010 R1-R3: function argument word
4011 R9: GOT pointer
4012 R10: stack limit (used only if stack checking if enabled)
4013 R11: argument (frame) pointer
4014 R12: temporary workspace
4015 R13: stack pointer
4016 R14: link register
4017 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk2729af92004-05-03 20:45:30 +00004019 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004020
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004021NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4022or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk2729af92004-05-03 20:45:30 +00004024Memory Management:
4025------------------
wdenkc6097192002-11-03 00:24:07 +00004026
wdenk2729af92004-05-03 20:45:30 +00004027U-Boot runs in system state and uses physical addresses, i.e. the
4028MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004029
wdenk2729af92004-05-03 20:45:30 +00004030The available memory is mapped to fixed addresses using the memory
4031controller. In this process, a contiguous block is formed for each
4032memory type (Flash, SDRAM, SRAM), even when it consists of several
4033physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk2729af92004-05-03 20:45:30 +00004035U-Boot is installed in the first 128 kB of the first Flash bank (on
4036TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4037booting and sizing and initializing DRAM, the code relocates itself
4038to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004039memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004040configuration setting]. Below that, a structure with global Board
4041Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004042
wdenk2729af92004-05-03 20:45:30 +00004043Additionally, some exception handler code is copied to the low 8 kB
4044of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004045
wdenk2729af92004-05-03 20:45:30 +00004046So a typical memory configuration with 16 MB of DRAM could look like
4047this:
wdenkc6097192002-11-03 00:24:07 +00004048
wdenk2729af92004-05-03 20:45:30 +00004049 0x0000 0000 Exception Vector code
4050 :
4051 0x0000 1FFF
4052 0x0000 2000 Free for Application Use
4053 :
4054 :
wdenkc6097192002-11-03 00:24:07 +00004055
wdenk2729af92004-05-03 20:45:30 +00004056 :
4057 :
4058 0x00FB FF20 Monitor Stack (Growing downward)
4059 0x00FB FFAC Board Info Data and permanent copy of global data
4060 0x00FC 0000 Malloc Arena
4061 :
4062 0x00FD FFFF
4063 0x00FE 0000 RAM Copy of Monitor Code
4064 ... eventually: LCD or video framebuffer
4065 ... eventually: pRAM (Protected RAM - unchanged by reset)
4066 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004067
4068
wdenk2729af92004-05-03 20:45:30 +00004069System Initialization:
4070----------------------
wdenkc6097192002-11-03 00:24:07 +00004071
wdenk2729af92004-05-03 20:45:30 +00004072In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004073(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004074configuration for CS0# this is a mirror of the onboard Flash memory.
4075To be able to re-map memory U-Boot then jumps to its link address.
4076To be able to implement the initialization code in C, a (small!)
4077initial stack is set up in the internal Dual Ported RAM (in case CPUs
4078which provide such a feature like MPC8xx or MPC8260), or in a locked
4079part of the data cache. After that, U-Boot initializes the CPU core,
4080the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004081
wdenk2729af92004-05-03 20:45:30 +00004082Next, all (potentially) available memory banks are mapped using a
4083preliminary mapping. For example, we put them on 512 MB boundaries
4084(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4085on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4086programmed for SDRAM access. Using the temporary configuration, a
4087simple memory test is run that determines the size of the SDRAM
4088banks.
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk2729af92004-05-03 20:45:30 +00004090When there is more than one SDRAM bank, and the banks are of
4091different size, the largest is mapped first. For equal size, the first
4092bank (CS2#) is mapped first. The first mapping is always for address
40930x00000000, with any additional banks following immediately to create
4094contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004095
wdenk2729af92004-05-03 20:45:30 +00004096Then, the monitor installs itself at the upper end of the SDRAM area
4097and allocates memory for use by malloc() and for the global Board
4098Info data; also, the exception vector code is copied to the low RAM
4099pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004100
wdenk2729af92004-05-03 20:45:30 +00004101Only after this relocation will you have a "normal" C environment;
4102until that you are restricted in several ways, mostly because you are
4103running from ROM, and because the code will have to be relocated to a
4104new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004105
4106
wdenk2729af92004-05-03 20:45:30 +00004107U-Boot Porting Guide:
4108----------------------
wdenkc6097192002-11-03 00:24:07 +00004109
wdenk2729af92004-05-03 20:45:30 +00004110[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4111list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004112
4113
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004114int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004115{
4116 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004117
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004118 signal(SIGALRM, no_more_time);
4119 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004120
wdenk2729af92004-05-03 20:45:30 +00004121 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004122 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004123 return 0;
4124 }
4125
wdenk2729af92004-05-03 20:45:30 +00004126 Download latest U-Boot source;
4127
Wolfgang Denk06682362008-12-30 22:56:11 +01004128 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004129
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004130 if (clueless)
4131 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk2729af92004-05-03 20:45:30 +00004133 while (learning) {
4134 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004135 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4136 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004137 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004138 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004139 }
wdenkc6097192002-11-03 00:24:07 +00004140
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004141 if (available_money > toLocalCurrency ($2500))
4142 Buy a BDI3000;
4143 else
wdenk2729af92004-05-03 20:45:30 +00004144 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004145
4146 if (a similar board exists) { /* hopefully... */
4147 cp -a board/<similar> board/<myboard>
4148 cp include/configs/<similar>.h include/configs/<myboard>.h
4149 } else {
4150 Create your own board support subdirectory;
4151 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004152 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004153 Edit new board/<myboard> files
4154 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004155
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004156 while (!accepted) {
4157 while (!running) {
4158 do {
4159 Add / modify source code;
4160 } until (compiles);
4161 Debug;
4162 if (clueless)
4163 email("Hi, I am having problems...");
4164 }
4165 Send patch file to the U-Boot email list;
4166 if (reasonable critiques)
4167 Incorporate improvements from email list code review;
4168 else
4169 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004170 }
wdenkc6097192002-11-03 00:24:07 +00004171
wdenk2729af92004-05-03 20:45:30 +00004172 return 0;
4173}
4174
4175void no_more_time (int sig)
4176{
4177 hire_a_guru();
4178}
wdenkc6097192002-11-03 00:24:07 +00004179
4180
wdenk2729af92004-05-03 20:45:30 +00004181Coding Standards:
4182-----------------
wdenkc6097192002-11-03 00:24:07 +00004183
wdenk2729af92004-05-03 20:45:30 +00004184All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004185coding style; see the file "Documentation/CodingStyle" and the script
4186"scripts/Lindent" in your Linux kernel source directory. In sources
4187originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4188spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004189
Detlev Zundel2c051652006-09-01 15:39:02 +02004190Source files originating from a different project (for example the
4191MTD subsystem) are generally exempt from these guidelines and are not
4192reformated to ease subsequent migration to newer versions of those
4193sources.
4194
4195Please note that U-Boot is implemented in C (and to some small parts in
4196Assembler); no C++ is used, so please do not use C++ style comments (//)
4197in your code.
wdenk2729af92004-05-03 20:45:30 +00004198
4199Please also stick to the following formatting rules:
4200- remove any trailing white space
4201- use TAB characters for indentation, not spaces
4202- make sure NOT to use DOS '\r\n' line feeds
4203- do not add more than 2 empty lines to source files
4204- do not add trailing empty lines to source files
4205
4206Submissions which do not conform to the standards may be returned
4207with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004208
4209
wdenk2729af92004-05-03 20:45:30 +00004210Submitting Patches:
4211-------------------
wdenkc6097192002-11-03 00:24:07 +00004212
wdenk2729af92004-05-03 20:45:30 +00004213Since the number of patches for U-Boot is growing, we need to
4214establish some rules. Submissions which do not conform to these rules
4215may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004216
Magnus Lilja0d28f342008-08-06 19:32:33 +02004217Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004218
Wolfgang Denk06682362008-12-30 22:56:11 +01004219Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4220see http://lists.denx.de/mailman/listinfo/u-boot
4221
wdenk2729af92004-05-03 20:45:30 +00004222When you send a patch, please include the following information with
4223it:
wdenkc6097192002-11-03 00:24:07 +00004224
wdenk2729af92004-05-03 20:45:30 +00004225* For bug fixes: a description of the bug and how your patch fixes
4226 this bug. Please try to include a way of demonstrating that the
4227 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229* For new features: a description of the feature and your
4230 implementation.
wdenkc6097192002-11-03 00:24:07 +00004231
wdenk2729af92004-05-03 20:45:30 +00004232* A CHANGELOG entry as plaintext (separate from the patch)
4233
4234* For major contributions, your entry to the CREDITS file
4235
4236* When you add support for a new board, don't forget to add this
4237 board to the MAKEALL script, too.
4238
4239* If your patch adds new configuration options, don't forget to
4240 document these in the README file.
4241
Wolfgang Denk218ca722008-03-26 10:40:12 +01004242* The patch itself. If you are using git (which is *strongly*
4243 recommended) you can easily generate the patch using the
4244 "git-format-patch". If you then use "git-send-email" to send it to
4245 the U-Boot mailing list, you will avoid most of the common problems
4246 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004247
Wolfgang Denk218ca722008-03-26 10:40:12 +01004248 If you cannot use git, use "diff -purN OLD NEW". If your version of
4249 diff does not support these options, then get the latest version of
4250 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004251
Wolfgang Denk218ca722008-03-26 10:40:12 +01004252 The current directory when running this command shall be the parent
4253 directory of the U-Boot source tree (i. e. please make sure that
4254 your patch includes sufficient directory information for the
4255 affected files).
4256
4257 We prefer patches as plain text. MIME attachments are discouraged,
4258 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004259
4260* If one logical set of modifications affects or creates several
4261 files, all these changes shall be submitted in a SINGLE patch file.
4262
4263* Changesets that contain different, unrelated modifications shall be
4264 submitted as SEPARATE patches, one patch per changeset.
4265
4266
4267Notes:
4268
4269* Before sending the patch, run the MAKEALL script on your patched
4270 source tree and make sure that no errors or warnings are reported
4271 for any of the boards.
4272
4273* Keep your modifications to the necessary minimum: A patch
4274 containing several unrelated changes or arbitrary reformats will be
4275 returned with a request to re-formatting / split it.
4276
4277* If you modify existing code, make sure that your new code does not
4278 add to the memory footprint of the code ;-) Small is beautiful!
4279 When adding new features, these should compile conditionally only
4280 (using #ifdef), and the resulting code with the new feature
4281 disabled must not need more memory than the old code without your
4282 modification.
wdenk90dc6702005-05-03 14:12:25 +00004283
Wolfgang Denk06682362008-12-30 22:56:11 +01004284* Remember that there is a size limit of 100 kB per message on the
4285 u-boot mailing list. Bigger patches will be moderated. If they are
4286 reasonable and not too big, they will be acknowledged. But patches
4287 bigger than the size limit should be avoided.