blob: 0491b1109a265c77b6734176a1700628b53d77d2 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002# (C) Copyright 2000 - 2009
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Wolfgang Denka9046b92010-06-13 17:48:15 +0200150 /at91rm9200 Files specific to Atmel AT91RM9200 CPU
151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
183 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /nios2 Files generic to Altera NIOS2 architecture
185 /cpu CPU specific files
186 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200187 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /cpu CPU specific files
189 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
190 /mpc5xx Files specific to Freescale MPC5xx CPUs
191 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
192 /mpc8xx Files specific to Freescale MPC8xx CPUs
193 /mpc8220 Files specific to Freescale MPC8220 CPUs
194 /mpc824x Files specific to Freescale MPC824x CPUs
195 /mpc8260 Files specific to Freescale MPC8260 CPUs
196 /mpc85xx Files specific to Freescale MPC85xx CPUs
197 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
198 /lib Architecture specific library files
199 /sh Files generic to SH architecture
200 /cpu CPU specific files
201 /sh2 Files specific to sh2 CPUs
202 /sh3 Files specific to sh3 CPUs
203 /sh4 Files specific to sh4 CPUs
204 /lib Architecture specific library files
205 /sparc Files generic to SPARC architecture
206 /cpu CPU specific files
207 /leon2 Files specific to Gaisler LEON2 SPARC CPU
208 /leon3 Files specific to Gaisler LEON3 SPARC CPU
209 /lib Architecture specific library files
210/api Machine/arch independent API for external apps
211/board Board dependent files
212/common Misc architecture independent functions
213/disk Code for disk drive partition handling
214/doc Documentation (don't expect too much)
215/drivers Commonly used device drivers
216/examples Example code for standalone applications, etc.
217/fs Filesystem code (cramfs, ext2, jffs2, etc.)
218/include Header Files
219/lib Files generic to all architectures
220 /libfdt Library files to support flattened device trees
221 /lzma Library files to support LZMA decompression
222 /lzo Library files to support LZO decompression
223/net Networking code
224/post Power On Self Test
225/rtc Real Time Clock drivers
226/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000227
wdenkc6097192002-11-03 00:24:07 +0000228Software Configuration:
229=======================
230
231Configuration is usually done using C preprocessor defines; the
232rationale behind that is to avoid dead code whenever possible.
233
234There are two classes of configuration variables:
235
236* Configuration _OPTIONS_:
237 These are selectable by the user and have names beginning with
238 "CONFIG_".
239
240* Configuration _SETTINGS_:
241 These depend on the hardware etc. and should not be meddled with if
242 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200243 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000244
245Later we will add a configuration tool - probably similar to or even
246identical to what's used for the Linux kernel. Right now, we have to
247do the configuration by hand, which means creating some symbolic
248links and editing some configuration files. We use the TQM8xxL boards
249as an example here.
250
251
252Selection of Processor Architecture and Board Type:
253---------------------------------------------------
254
255For all supported boards there are ready-to-use default
256configurations available; just type "make <board_name>_config".
257
258Example: For a TQM823L module type:
259
260 cd u-boot
261 make TQM823L_config
262
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200263For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000264e.g. "make cogent_mpc8xx_config". And also configure the cogent
265directory according to the instructions in cogent/README.
266
267
268Configuration Options:
269----------------------
270
271Configuration depends on the combination of board and CPU type; all
272such information is kept in a configuration file
273"include/configs/<board_name>.h".
274
275Example: For a TQM823L module, all configuration settings are in
276"include/configs/TQM823L.h".
277
278
wdenk7f6c2cb2002-11-10 22:06:23 +0000279Many of the options are named exactly as the corresponding Linux
280kernel configuration options. The intention is to make it easier to
281build a config tool - later.
282
283
wdenkc6097192002-11-03 00:24:07 +0000284The following options need to be configured:
285
Kim Phillips26281142007-08-10 13:28:25 -0500286- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000287
Kim Phillips26281142007-08-10 13:28:25 -0500288- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200289
290- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100291 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000292
293- CPU Module Type: (if CONFIG_COGENT is defined)
294 Define exactly one of
295 CONFIG_CMA286_60_OLD
296--- FIXME --- not tested yet:
297 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298 CONFIG_CMA287_23, CONFIG_CMA287_50
299
300- Motherboard Type: (if CONFIG_COGENT is defined)
301 Define exactly one of
302 CONFIG_CMA101, CONFIG_CMA102
303
304- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305 Define one or more of
306 CONFIG_CMA302
307
308- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309 Define one or more of
310 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200311 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000312 a "rotator" |\-/|\-/
313
wdenk2535d602003-07-17 23:16:40 +0000314- Board flavour: (if CONFIG_MPC8260ADS is defined)
315 CONFIG_ADSTYPE
316 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200317 CONFIG_SYS_8260ADS - original MPC8260ADS
318 CONFIG_SYS_8266ADS - MPC8266ADS
319 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
320 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
wdenkc6097192002-11-03 00:24:07 +0000327- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000328 Define exactly one of
329 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200331- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
333 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000334 e.g. if there is no 32KHz
335 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
337 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000338
wdenk66ca92a2004-09-28 17:59:53 +0000339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_8xx_CPUCLK_MIN
341 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000343 See doc/README.MPC866
344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200345 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000346
wdenkba56f622004-02-06 23:19:44 +0000347 Define this to measure the actual CPU clock instead
348 of relying on the correctness of the configured
349 values. Mostly useful for board bringup to make sure
350 the PLL is locked at the intended frequency. Note
351 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200352 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000353
Heiko Schocher506f3912009-03-12 07:37:15 +0100354 CONFIG_SYS_DELAYED_ICACHE
355
356 Define this option if you want to enable the
357 ICache only when Code runs from RAM.
358
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100359- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200360 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100361
362 Defines the Monahans run mode to oscillator
363 ratio. Valid values are 8, 16, 24, 31. The core
364 frequency is this value multiplied by 13 MHz.
365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200366 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200367
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100368 Defines the Monahans turbo mode to oscillator
369 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200370 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100371 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200372
wdenk5da627a2003-10-09 20:09:04 +0000373- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000374 CONFIG_CLOCKS_IN_MHZ
375
376 U-Boot stores all clock information in Hz
377 internally. For binary compatibility with older Linux
378 kernels (which expect the clocks passed in the
379 bd_info data to be in MHz) the environment variable
380 "clocks_in_mhz" can be defined so that U-Boot
381 converts clock data to MHZ before passing it to the
382 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000383 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100384 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000385 default environment.
386
wdenk5da627a2003-10-09 20:09:04 +0000387 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
388
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200389 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000390 expect it to be in bytes, others in MB.
391 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
392
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400393 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200394
395 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400396 passed using flattened device trees (based on open firmware
397 concepts).
398
399 CONFIG_OF_LIBFDT
400 * New libfdt-based support
401 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500402 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400403
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200404 OF_CPU - The proper name of the cpus node (only required for
405 MPC512X and MPC5xxx based boards).
406 OF_SOC - The proper name of the soc node (only required for
407 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200408 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600409 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200410
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200411 boards with QUICC Engines require OF_QE to set UCC MAC
412 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500413
Kumar Gala4e253132006-01-11 13:54:17 -0600414 CONFIG_OF_BOARD_SETUP
415
416 Board code has addition modification that it wants to make
417 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000418
Matthew McClintock02677682006-06-28 10:41:37 -0500419 CONFIG_OF_BOOT_CPU
420
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200421 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500422 param header, the default value is zero if undefined.
423
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200424 CONFIG_OF_IDE_FIXUP
425
426 U-Boot can detect if an IDE device is present or not.
427 If not, and this new config option is activated, U-Boot
428 removes the ATA node from the DTS before booting Linux,
429 so the Linux IDE driver does not probe the device and
430 crash. This is needed for buggy hardware (uc101) where
431 no pull down resistor is connected to the signal IDE5V_DD7.
432
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100433- vxWorks boot parameters:
434
435 bootvx constructs a valid bootline using the following
436 environments variables: bootfile, ipaddr, serverip, hostname.
437 It loads the vxWorks image pointed bootfile.
438
439 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
440 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
441 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
442 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
443
444 CONFIG_SYS_VXWORKS_ADD_PARAMS
445
446 Add it at the end of the bootline. E.g "u=username pw=secret"
447
448 Note: If a "bootargs" environment is defined, it will overwride
449 the defaults discussed just above.
450
wdenk6705d812004-08-02 23:22:59 +0000451- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200452 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000453
454 Define this if you want support for Amba PrimeCell PL010 UARTs.
455
Andreas Engel48d01922008-09-08 14:30:53 +0200456 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000457
458 Define this if you want support for Amba PrimeCell PL011 UARTs.
459
460 CONFIG_PL011_CLOCK
461
462 If you have Amba PrimeCell PL011 UARTs, set this variable to
463 the clock speed of the UARTs.
464
465 CONFIG_PL01x_PORTS
466
467 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
468 define this to a list of base addresses for each (supported)
469 port. See e.g. include/configs/versatile.h
470
471
wdenkc6097192002-11-03 00:24:07 +0000472- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000473 Depending on board, define exactly one serial port
474 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
475 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
476 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000477
478 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
479 port routines must be defined elsewhere
480 (i.e. serial_init(), serial_getc(), ...)
481
482 CONFIG_CFB_CONSOLE
483 Enables console device for a color framebuffer. Needs following
484 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
485 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
486 (default big endian)
487 VIDEO_HW_RECTFILL graphic chip supports
488 rectangle fill
489 (cf. smiLynxEM)
490 VIDEO_HW_BITBLT graphic chip supports
491 bit-blit (cf. smiLynxEM)
492 VIDEO_VISIBLE_COLS visible pixel columns
493 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000494 VIDEO_VISIBLE_ROWS visible pixel rows
495 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000496 VIDEO_DATA_FORMAT graphic data format
497 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000498 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000499 VIDEO_KBD_INIT_FCT keyboard int fct
500 (i.e. i8042_kbd_init())
501 VIDEO_TSTC_FCT test char fct
502 (i.e. i8042_tstc)
503 VIDEO_GETC_FCT get char fct
504 (i.e. i8042_getc)
505 CONFIG_CONSOLE_CURSOR cursor drawing on/off
506 (requires blink timer
507 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200508 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000509 CONFIG_CONSOLE_TIME display time/date info in
510 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500511 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000512 CONFIG_VIDEO_LOGO display Linux logo in
513 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000514 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
515 linux_logo.h for logo.
516 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000517 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200518 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000519 the logo
520
wdenk43d96162003-03-06 00:02:04 +0000521 When CONFIG_CFB_CONSOLE is defined, video console is
522 default i/o. Serial console can be forced with
523 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000524
wdenkd4ca31c2004-01-02 14:00:00 +0000525 When CONFIG_SILENT_CONSOLE is defined, all console
526 messages (by U-Boot and Linux!) can be silenced with
527 the "silent" environment variable. See
528 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000529
wdenkc6097192002-11-03 00:24:07 +0000530- Console Baudrate:
531 CONFIG_BAUDRATE - in bps
532 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200533 CONFIG_SYS_BAUDRATE_TABLE, see below.
534 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000535
Heiko Schocherc92fac92009-01-30 12:55:38 +0100536- Console Rx buffer length
537 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
538 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100539 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100540 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
541 must be defined, to setup the maximum idle timeout for
542 the SMC.
543
wdenkc6097192002-11-03 00:24:07 +0000544- Boot Delay: CONFIG_BOOTDELAY - in seconds
545 Delay before automatically booting the default image;
546 set to -1 to disable autoboot.
547
548 See doc/README.autoboot for these options that
549 work with CONFIG_BOOTDELAY. None are required.
550 CONFIG_BOOT_RETRY_TIME
551 CONFIG_BOOT_RETRY_MIN
552 CONFIG_AUTOBOOT_KEYED
553 CONFIG_AUTOBOOT_PROMPT
554 CONFIG_AUTOBOOT_DELAY_STR
555 CONFIG_AUTOBOOT_STOP_STR
556 CONFIG_AUTOBOOT_DELAY_STR2
557 CONFIG_AUTOBOOT_STOP_STR2
558 CONFIG_ZERO_BOOTDELAY_CHECK
559 CONFIG_RESET_TO_RETRY
560
561- Autoboot Command:
562 CONFIG_BOOTCOMMAND
563 Only needed when CONFIG_BOOTDELAY is enabled;
564 define a command string that is automatically executed
565 when no character is read on the console interface
566 within "Boot Delay" after reset.
567
568 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000569 This can be used to pass arguments to the bootm
570 command. The value of CONFIG_BOOTARGS goes into the
571 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000572
573 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000574 The value of these goes into the environment as
575 "ramboot" and "nfsboot" respectively, and can be used
576 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200577 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000578
579- Pre-Boot Commands:
580 CONFIG_PREBOOT
581
582 When this option is #defined, the existence of the
583 environment variable "preboot" will be checked
584 immediately before starting the CONFIG_BOOTDELAY
585 countdown and/or running the auto-boot command resp.
586 entering interactive mode.
587
588 This feature is especially useful when "preboot" is
589 automatically generated or modified. For an example
590 see the LWMON board specific code: here "preboot" is
591 modified when the user holds down a certain
592 combination of keys on the (special) keyboard when
593 booting the systems
594
595- Serial Download Echo Mode:
596 CONFIG_LOADS_ECHO
597 If defined to 1, all characters received during a
598 serial download (using the "loads" command) are
599 echoed back. This might be needed by some terminal
600 emulations (like "cu"), but may as well just take
601 time on others. This setting #define's the initial
602 value of the "loads_echo" environment variable.
603
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500604- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000605 CONFIG_KGDB_BAUDRATE
606 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200607 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000608
609- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500610 Monitor commands can be included or excluded
611 from the build by using the #include files
612 "config_cmd_all.h" and #undef'ing unwanted
613 commands, or using "config_cmd_default.h"
614 and augmenting with additional #define's
615 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000616
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500617 The default command configuration includes all commands
618 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000619
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500620 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500621 CONFIG_CMD_BDI bdinfo
622 CONFIG_CMD_BEDBUG * Include BedBug Debugger
623 CONFIG_CMD_BMP * BMP support
624 CONFIG_CMD_BSP * Board specific commands
625 CONFIG_CMD_BOOTD bootd
626 CONFIG_CMD_CACHE * icache, dcache
627 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500628 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500629 CONFIG_CMD_DATE * support for RTC, date/time...
630 CONFIG_CMD_DHCP * DHCP support
631 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600632 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
633 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
634 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
635 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500636 CONFIG_CMD_DTT * Digital Therm and Thermostat
637 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500638 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500639 CONFIG_CMD_EEPROM * EEPROM read/write support
640 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500641 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500642 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500643 CONFIG_CMD_FDC * Floppy Disk Support
644 CONFIG_CMD_FAT * FAT partition support
645 CONFIG_CMD_FDOS * Dos diskette Support
646 CONFIG_CMD_FLASH flinfo, erase, protect
647 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500648 CONFIG_CMD_GO * the 'go' command (exec code)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500649 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
650 CONFIG_CMD_I2C * I2C serial bus support
651 CONFIG_CMD_IDE * IDE harddisk support
652 CONFIG_CMD_IMI iminfo
653 CONFIG_CMD_IMLS List all found images
654 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500655 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500656 CONFIG_CMD_IRQ * irqinfo
657 CONFIG_CMD_ITEST Integer/string test of 2 values
658 CONFIG_CMD_JFFS2 * JFFS2 Support
659 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500660 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500661 CONFIG_CMD_LOADB loadb
662 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400663 CONFIG_CMD_MD5SUM print md5 message digest
664 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500665 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
666 loop, loopw, mtest
667 CONFIG_CMD_MISC Misc functions like sleep etc
668 CONFIG_CMD_MMC * MMC memory mapped support
669 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100670 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500671 CONFIG_CMD_NAND * NAND support
672 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600673 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
674 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500675 CONFIG_CMD_PCI * pciinfo
676 CONFIG_CMD_PCMCIA * PCMCIA support
677 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
678 host
679 CONFIG_CMD_PORTIO * Port I/O
680 CONFIG_CMD_REGINFO * Register dump
681 CONFIG_CMD_RUN run command in env variable
682 CONFIG_CMD_SAVES * save S record dump
683 CONFIG_CMD_SCSI * SCSI Support
684 CONFIG_CMD_SDRAM * print SDRAM configuration information
685 (requires CONFIG_CMD_I2C)
686 CONFIG_CMD_SETGETDCR Support for DCR Register access
687 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100688 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400689 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200690 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500691 CONFIG_CMD_SPI * SPI serial bus support
692 CONFIG_CMD_USB * USB support
693 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500694 CONFIG_CMD_CDP * Cisco Discover Protocol support
695 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000696
wdenkc6097192002-11-03 00:24:07 +0000697
698 EXAMPLE: If you want all functions except of network
699 support you can write:
700
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500701 #include "config_cmd_all.h"
702 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000703
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400704 Other Commands:
705 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000706
707 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500708 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000709 what you (and your U-Boot users) are doing. Data
710 cache cannot be enabled on systems like the 8xx or
711 8260 (where accesses to the IMMR region must be
712 uncached), and it cannot be disabled on all other
713 systems where we (mis-) use the data cache to hold an
714 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000715
716
717 XXX - this list needs to get updated!
718
719- Watchdog:
720 CONFIG_WATCHDOG
721 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000722 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000723 code for a watchdog. For the 8xx and 8260 CPUs, the
724 SIU Watchdog feature is enabled in the SYPCR
725 register.
726
stroesec1551ea2003-04-04 15:53:41 +0000727- U-Boot Version:
728 CONFIG_VERSION_VARIABLE
729 If this variable is defined, an environment variable
730 named "ver" is created by U-Boot showing the U-Boot
731 version as printed by the "version" command.
732 This variable is readonly.
733
wdenkc6097192002-11-03 00:24:07 +0000734- Real-Time Clock:
735
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500736 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000737 has to be selected, too. Define exactly one of the
738 following options:
739
740 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
741 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200742 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000743 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000744 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000745 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000746 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000747 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100748 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000749 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200750 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200751 CONFIG_SYS_RV3029_TCR - enable trickle charger on
752 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000753
wdenkb37c7e52003-06-30 16:24:52 +0000754 Note that if the RTC uses I2C, then the I2C interface
755 must also be configured. See I2C Support, below.
756
Peter Tysere92739d2008-12-17 16:36:21 -0600757- GPIO Support:
758 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
759 CONFIG_PCA953X_INFO - enable pca953x info command
760
Chris Packham5dec49c2010-12-19 10:12:13 +0000761 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
762 chip-ngpio pairs that tell the PCA953X driver the number of
763 pins supported by a particular chip.
764
Peter Tysere92739d2008-12-17 16:36:21 -0600765 Note that if the GPIO device uses I2C, then the I2C interface
766 must also be configured. See I2C Support, below.
767
wdenkc6097192002-11-03 00:24:07 +0000768- Timestamp Support:
769
wdenk43d96162003-03-06 00:02:04 +0000770 When CONFIG_TIMESTAMP is selected, the timestamp
771 (date and time) of an image is printed by image
772 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500773 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000774
775- Partition Support:
776 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400777 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000778
Wolfgang Denk218ca722008-03-26 10:40:12 +0100779 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
780 CONFIG_CMD_SCSI) you must configure support for at
781 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000782
783- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000784 CONFIG_IDE_RESET_ROUTINE - this is defined in several
785 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000786
wdenk4d13cba2004-03-14 14:09:05 +0000787 CONFIG_IDE_RESET - is this is defined, IDE Reset will
788 be performed by calling the function
789 ide_set_reset(int reset)
790 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000791
792- ATAPI Support:
793 CONFIG_ATAPI
794
795 Set this to enable ATAPI support.
796
wdenkc40b2952004-03-13 23:29:43 +0000797- LBA48 Support
798 CONFIG_LBA48
799
800 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100801 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000802 Whithout these , LBA48 support uses 32bit variables and will 'only'
803 support disks up to 2.1TB.
804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200805 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000806 When enabled, makes the IDE subsystem use 64bit sector addresses.
807 Default is 32bit.
808
wdenkc6097192002-11-03 00:24:07 +0000809- SCSI Support:
810 At the moment only there is only support for the
811 SYM53C8XX SCSI controller; define
812 CONFIG_SCSI_SYM53C8XX to enable it.
813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200814 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
815 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
816 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000817 maximum numbers of LUNs, SCSI ID's and target
818 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200819 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000820
821- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000822 CONFIG_E1000
823 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000824
Andre Schwarzac3315c2008-03-06 16:45:44 +0100825 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200826 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100827
wdenkc6097192002-11-03 00:24:07 +0000828 CONFIG_EEPRO100
829 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200830 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000831 write routine for first time initialisation.
832
833 CONFIG_TULIP
834 Support for Digital 2114x chips.
835 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
836 modem chip initialisation (KS8761/QS6611).
837
838 CONFIG_NATSEMI
839 Support for National dp83815 chips.
840
841 CONFIG_NS8382X
842 Support for National dp8382[01] gigabit chips.
843
wdenk45219c42003-05-12 21:50:16 +0000844- NETWORK Support (other):
845
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100846 CONFIG_DRIVER_AT91EMAC
847 Support for AT91RM9200 EMAC.
848
849 CONFIG_RMII
850 Define this to use reduced MII inteface
851
852 CONFIG_DRIVER_AT91EMAC_QUIET
853 If this defined, the driver is quiet.
854 The driver doen't show link status messages.
855
wdenk45219c42003-05-12 21:50:16 +0000856 CONFIG_DRIVER_LAN91C96
857 Support for SMSC's LAN91C96 chips.
858
859 CONFIG_LAN91C96_BASE
860 Define this to hold the physical address
861 of the LAN91C96's I/O space
862
863 CONFIG_LAN91C96_USE_32_BIT
864 Define this to enable 32 bit addressing
865
wdenkf39748a2004-06-09 13:37:52 +0000866 CONFIG_DRIVER_SMC91111
867 Support for SMSC's LAN91C111 chip
868
869 CONFIG_SMC91111_BASE
870 Define this to hold the physical address
871 of the device (I/O space)
872
873 CONFIG_SMC_USE_32_BIT
874 Define this if data bus is 32 bits
875
876 CONFIG_SMC_USE_IOFUNCS
877 Define this to use i/o functions instead of macros
878 (some hardware wont work with macros)
879
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800880 CONFIG_FTGMAC100
881 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
882
883 CONFIG_FTGMAC100_EGIGA
884 Define this to use GE link update with gigabit PHY.
885 Define this if FTGMAC100 is connected to gigabit PHY.
886 If your system has 10/100 PHY only, it might not occur
887 wrong behavior. Because PHY usually return timeout or
888 useless data when polling gigabit status and gigabit
889 control registers. This behavior won't affect the
890 correctnessof 10/100 link speed update.
891
Mike Rapoportc2fff332009-11-11 10:03:03 +0200892 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200893 Support for SMSC's LAN911x and LAN921x chips
894
Mike Rapoportc2fff332009-11-11 10:03:03 +0200895 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200896 Define this to hold the physical address
897 of the device (I/O space)
898
Mike Rapoportc2fff332009-11-11 10:03:03 +0200899 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200900 Define this if data bus is 32 bits
901
Mike Rapoportc2fff332009-11-11 10:03:03 +0200902 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200903 Define this if data bus is 16 bits. If your processor
904 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200905 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200906
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900907 CONFIG_SH_ETHER
908 Support for Renesas on-chip Ethernet controller
909
910 CONFIG_SH_ETHER_USE_PORT
911 Define the number of ports to be used
912
913 CONFIG_SH_ETHER_PHY_ADDR
914 Define the ETH PHY's address
915
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900916 CONFIG_SH_ETHER_CACHE_WRITEBACK
917 If this option is set, the driver enables cache flush.
918
wdenkc6097192002-11-03 00:24:07 +0000919- USB Support:
920 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000921 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000922 CONFIG_USB_UHCI to enable it.
923 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000924 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000925 storage devices.
926 Note:
927 Supported are USB Keyboards and USB Floppy drives
928 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000929 MPC5200 USB requires additional defines:
930 CONFIG_USB_CLOCK
931 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500932 CONFIG_PSC3_USB
933 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000934 CONFIG_USB_CONFIG
935 for differential drivers: 0x00001000
936 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500937 for differential drivers on PSC3: 0x00000100
938 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200939 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200940 May be defined to allow interrupt polling
941 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000942
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200943- USB Device:
944 Define the below if you wish to use the USB console.
945 Once firmware is rebuilt from a serial console issue the
946 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200947 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200948 it has found a new device. The environment variable usbtty
949 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200950 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200951 Common Device Class Abstract Control Model serial device.
952 If you select usbtty = gserial you should be able to enumerate
953 a Linux host by
954 # modprobe usbserial vendor=0xVendorID product=0xProductID
955 else if using cdc_acm, simply setting the environment
956 variable usbtty to be cdc_acm should suffice. The following
957 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200958
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200959 CONFIG_USB_DEVICE
960 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000961
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200962 CONFIG_USB_TTY
963 Define this to have a tty type of device available to
964 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200965
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200966 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200967 Define this if you want stdin, stdout &/or stderr to
968 be set to usbtty.
969
970 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200971 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200972 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200973 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200975 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200976 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200977 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200978
Wolfgang Denk386eda02006-06-14 18:14:56 +0200979 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200980 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200981 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200982 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
983 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
984 should pretend to be a Linux device to it's target host.
985
986 CONFIG_USBD_MANUFACTURER
987 Define this string as the name of your company for
988 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200989
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200990 CONFIG_USBD_PRODUCT_NAME
991 Define this string as the name of your product
992 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
993
994 CONFIG_USBD_VENDORID
995 Define this as your assigned Vendor ID from the USB
996 Implementors Forum. This *must* be a genuine Vendor ID
997 to avoid polluting the USB namespace.
998 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200999
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001000 CONFIG_USBD_PRODUCTID
1001 Define this as the unique Product ID
1002 for your device
1003 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001004
1005
1006- MMC Support:
1007 The MMC controller on the Intel PXA is supported. To
1008 enable this define CONFIG_MMC. The MMC can be
1009 accessed from the boot prompt by mapping the device
1010 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001011 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1012 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001013
wdenk6705d812004-08-02 23:22:59 +00001014- Journaling Flash filesystem support:
1015 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1016 CONFIG_JFFS2_NAND_DEV
1017 Define these for a default partition on a NAND device
1018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001019 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1020 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001021 Define these for a default partition on a NOR device
1022
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001023 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001024 Define this to create an own partition. You have to provide a
1025 function struct part_info* jffs2_part_info(int part_num)
1026
1027 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001028 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001029 to disable the command chpart. This is the default when you
1030 have not defined a custom partition
1031
wdenkc6097192002-11-03 00:24:07 +00001032- Keyboard Support:
1033 CONFIG_ISA_KEYBOARD
1034
1035 Define this to enable standard (PC-Style) keyboard
1036 support
1037
1038 CONFIG_I8042_KBD
1039 Standard PC keyboard driver with US (is default) and
1040 GERMAN key layout (switch via environment 'keymap=de') support.
1041 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1042 for cfb_console. Supports cursor blinking.
1043
1044- Video support:
1045 CONFIG_VIDEO
1046
1047 Define this to enable video support (for output to
1048 video).
1049
1050 CONFIG_VIDEO_CT69000
1051
1052 Enable Chips & Technologies 69000 Video chip
1053
1054 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001055 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001056 video output is selected via environment 'videoout'
1057 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1058 assumed.
wdenkc6097192002-11-03 00:24:07 +00001059
wdenkb79a11c2004-03-25 15:14:43 +00001060 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001061 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001062 are possible:
1063 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001064 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001065
1066 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1067 -------------+---------------------------------------------
1068 8 bits | 0x301* 0x303 0x305 0x161 0x307
1069 15 bits | 0x310 0x313 0x316 0x162 0x319
1070 16 bits | 0x311 0x314 0x317 0x163 0x31A
1071 24 bits | 0x312 0x315 0x318 ? 0x31B
1072 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001073 (i.e. setenv videomode 317; saveenv; reset;)
1074
wdenkb79a11c2004-03-25 15:14:43 +00001075 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001076 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001077
1078
stroesec1551ea2003-04-04 15:53:41 +00001079 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001080 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001081 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1082 or CONFIG_VIDEO_SED13806_16BPP
1083
Timur Tabi7d3053f2011-02-15 17:09:19 -06001084 CONFIG_FSL_DIU_FB
1085 Enable the Freescale DIU video driver. Reference boards for
1086 SOCs that have a DIU should define this macro to enable DIU
1087 support, and should also define these other macros:
1088
1089 CONFIG_SYS_DIU_ADDR
1090 CONFIG_VIDEO
1091 CONFIG_CMD_BMP
1092 CONFIG_CFB_CONSOLE
1093 CONFIG_VIDEO_SW_CURSOR
1094 CONFIG_VGA_AS_SINGLE_DEVICE
1095 CONFIG_VIDEO_LOGO
1096 CONFIG_VIDEO_BMP_LOGO
1097
1098 The DIU driver will look for the 'monitor' environment variable,
1099 and if defined, enable the DIU as a console during boot. This
1100 variable should be set to one of these values:
1101
1102 '0' Output video to the DVI connector
1103 '1' Output video to the LVDS connector
1104 '2' Output video to the Dual-Link LVDS connector
1105
wdenk682011f2003-06-03 23:54:09 +00001106- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001107 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001108
wdenk8bde7f72003-06-27 21:31:46 +00001109 Define this to enable a custom keyboard support.
1110 This simply calls drv_keyboard_init() which must be
1111 defined in your board-specific files.
1112 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001113
wdenkc6097192002-11-03 00:24:07 +00001114- LCD Support: CONFIG_LCD
1115
1116 Define this to enable LCD support (for output to LCD
1117 display); also select one of the supported displays
1118 by defining one of these:
1119
Stelian Pop39cf4802008-05-09 21:57:18 +02001120 CONFIG_ATMEL_LCD:
1121
1122 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1123
wdenkfd3103b2003-11-25 16:55:19 +00001124 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001125
wdenkfd3103b2003-11-25 16:55:19 +00001126 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001127
wdenkfd3103b2003-11-25 16:55:19 +00001128 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001129
wdenkfd3103b2003-11-25 16:55:19 +00001130 NEC NL6448BC20-08. 6.5", 640x480.
1131 Active, color, single scan.
1132
1133 CONFIG_NEC_NL6448BC33_54
1134
1135 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001136 Active, color, single scan.
1137
1138 CONFIG_SHARP_16x9
1139
1140 Sharp 320x240. Active, color, single scan.
1141 It isn't 16x9, and I am not sure what it is.
1142
1143 CONFIG_SHARP_LQ64D341
1144
1145 Sharp LQ64D341 display, 640x480.
1146 Active, color, single scan.
1147
1148 CONFIG_HLD1045
1149
1150 HLD1045 display, 640x480.
1151 Active, color, single scan.
1152
1153 CONFIG_OPTREX_BW
1154
1155 Optrex CBL50840-2 NF-FW 99 22 M5
1156 or
1157 Hitachi LMG6912RPFC-00T
1158 or
1159 Hitachi SP14Q002
1160
1161 320x240. Black & white.
1162
1163 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001164 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001165
wdenk7152b1d2003-09-05 23:19:14 +00001166- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001167
wdenk8bde7f72003-06-27 21:31:46 +00001168 If this option is set, the environment is checked for
1169 a variable "splashimage". If found, the usual display
1170 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001171 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001172 specified in "splashimage" is loaded instead. The
1173 console is redirected to the "nulldev", too. This
1174 allows for a "silent" boot where a splash screen is
1175 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001176
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001177 CONFIG_SPLASH_SCREEN_ALIGN
1178
1179 If this option is set the splash image can be freely positioned
1180 on the screen. Environment variable "splashpos" specifies the
1181 position as "x,y". If a positive number is given it is used as
1182 number of pixel from left/top. If a negative number is given it
1183 is used as number of pixel from right/bottom. You can also
1184 specify 'm' for centering the image.
1185
1186 Example:
1187 setenv splashpos m,m
1188 => image at center of screen
1189
1190 setenv splashpos 30,20
1191 => image at x = 30 and y = 20
1192
1193 setenv splashpos -10,m
1194 => vertically centered image
1195 at x = dspWidth - bmpWidth - 9
1196
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001197- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1198
1199 If this option is set, additionally to standard BMP
1200 images, gzipped BMP images can be displayed via the
1201 splashscreen support or the bmp command.
1202
Anatolij Gustschind5011762010-03-15 14:50:25 +01001203- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1204
1205 If this option is set, 8-bit RLE compressed BMP images
1206 can be displayed via the splashscreen support or the
1207 bmp command.
1208
wdenkc29fdfc2003-08-29 20:57:53 +00001209- Compression support:
1210 CONFIG_BZIP2
1211
1212 If this option is set, support for bzip2 compressed
1213 images is included. If not, only uncompressed and gzip
1214 compressed images are supported.
1215
wdenk42d1f032003-10-15 23:53:47 +00001216 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001217 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001218 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001219
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001220 CONFIG_LZMA
1221
1222 If this option is set, support for lzma compressed
1223 images is included.
1224
1225 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1226 requires an amount of dynamic memory that is given by the
1227 formula:
1228
1229 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1230
1231 Where lc and lp stand for, respectively, Literal context bits
1232 and Literal pos bits.
1233
1234 This value is upper-bounded by 14MB in the worst case. Anyway,
1235 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1236 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1237 a very small buffer.
1238
1239 Use the lzmainfo tool to determinate the lc and lp values and
1240 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001241 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001242
wdenk17ea1172004-06-06 21:51:03 +00001243- MII/PHY support:
1244 CONFIG_PHY_ADDR
1245
1246 The address of PHY on MII bus.
1247
1248 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1249
1250 The clock frequency of the MII bus
1251
1252 CONFIG_PHY_GIGE
1253
1254 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001255 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001256
1257 CONFIG_PHY_RESET_DELAY
1258
1259 Some PHY like Intel LXT971A need extra delay after
1260 reset before any MII register access is possible.
1261 For such PHY, set this option to the usec delay
1262 required. (minimum 300usec for LXT971A)
1263
1264 CONFIG_PHY_CMD_DELAY (ppc4xx)
1265
1266 Some PHY like Intel LXT971A need extra delay after
1267 command issued before MII status register can be read
1268
wdenkc6097192002-11-03 00:24:07 +00001269- Ethernet address:
1270 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001271 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001272 CONFIG_ETH2ADDR
1273 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001274 CONFIG_ETH4ADDR
1275 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001276
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001277 Define a default value for Ethernet address to use
1278 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001279 is not determined automatically.
1280
1281- IP address:
1282 CONFIG_IPADDR
1283
1284 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001285 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001286 determined through e.g. bootp.
1287
1288- Server IP address:
1289 CONFIG_SERVERIP
1290
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001291 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001292 server to contact when using the "tftboot" command.
1293
Robin Getz97cfe862009-07-21 12:15:28 -04001294 CONFIG_KEEP_SERVERADDR
1295
1296 Keeps the server's MAC address, in the env 'serveraddr'
1297 for passing to bootargs (like Linux's netconsole option)
1298
David Updegraff53a5c422007-06-11 10:41:07 -05001299- Multicast TFTP Mode:
1300 CONFIG_MCAST_TFTP
1301
1302 Defines whether you want to support multicast TFTP as per
1303 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001304 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001305 driver in use must provide a function: mcast() to join/leave a
1306 multicast group.
1307
1308 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001309- BOOTP Recovery Mode:
1310 CONFIG_BOOTP_RANDOM_DELAY
1311
1312 If you have many targets in a network that try to
1313 boot using BOOTP, you may want to avoid that all
1314 systems send out BOOTP requests at precisely the same
1315 moment (which would happen for instance at recovery
1316 from a power failure, when all systems will try to
1317 boot, thus flooding the BOOTP server. Defining
1318 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1319 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001320 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001321
1322 1st BOOTP request: delay 0 ... 1 sec
1323 2nd BOOTP request: delay 0 ... 2 sec
1324 3rd BOOTP request: delay 0 ... 4 sec
1325 4th and following
1326 BOOTP requests: delay 0 ... 8 sec
1327
stroesefe389a82003-08-28 14:17:32 +00001328- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001329 You can fine tune the DHCP functionality by defining
1330 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001331
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001332 CONFIG_BOOTP_SUBNETMASK
1333 CONFIG_BOOTP_GATEWAY
1334 CONFIG_BOOTP_HOSTNAME
1335 CONFIG_BOOTP_NISDOMAIN
1336 CONFIG_BOOTP_BOOTPATH
1337 CONFIG_BOOTP_BOOTFILESIZE
1338 CONFIG_BOOTP_DNS
1339 CONFIG_BOOTP_DNS2
1340 CONFIG_BOOTP_SEND_HOSTNAME
1341 CONFIG_BOOTP_NTPSERVER
1342 CONFIG_BOOTP_TIMEOFFSET
1343 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001344
Wilson Callan5d110f02007-07-28 10:56:13 -04001345 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1346 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001347
1348 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1349 serverip from a DHCP server, it is possible that more
1350 than one DNS serverip is offered to the client.
1351 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1352 serverip will be stored in the additional environment
1353 variable "dnsip2". The first DNS serverip is always
1354 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001355 is defined.
stroesefe389a82003-08-28 14:17:32 +00001356
1357 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1358 to do a dynamic update of a DNS server. To do this, they
1359 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001360 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001361 of the "hostname" environment variable is passed as
1362 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001363
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001364 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1365
1366 A 32bit value in microseconds for a delay between
1367 receiving a "DHCP Offer" and sending the "DHCP Request".
1368 This fixes a problem with certain DHCP servers that don't
1369 respond 100% of the time to a "DHCP request". E.g. On an
1370 AT91RM9200 processor running at 180MHz, this delay needed
1371 to be *at least* 15,000 usec before a Windows Server 2003
1372 DHCP server would reply 100% of the time. I recommend at
1373 least 50,000 usec to be safe. The alternative is to hope
1374 that one of the retries will be successful but note that
1375 the DHCP timeout and retry process takes a longer than
1376 this delay.
1377
wdenka3d991b2004-04-15 21:48:45 +00001378 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001379 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001380
1381 The device id used in CDP trigger frames.
1382
1383 CONFIG_CDP_DEVICE_ID_PREFIX
1384
1385 A two character string which is prefixed to the MAC address
1386 of the device.
1387
1388 CONFIG_CDP_PORT_ID
1389
1390 A printf format string which contains the ascii name of
1391 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001392 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001393
1394 CONFIG_CDP_CAPABILITIES
1395
1396 A 32bit integer which indicates the device capabilities;
1397 0x00000010 for a normal host which does not forwards.
1398
1399 CONFIG_CDP_VERSION
1400
1401 An ascii string containing the version of the software.
1402
1403 CONFIG_CDP_PLATFORM
1404
1405 An ascii string containing the name of the platform.
1406
1407 CONFIG_CDP_TRIGGER
1408
1409 A 32bit integer sent on the trigger.
1410
1411 CONFIG_CDP_POWER_CONSUMPTION
1412
1413 A 16bit integer containing the power consumption of the
1414 device in .1 of milliwatts.
1415
1416 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1417
1418 A byte containing the id of the VLAN.
1419
wdenkc6097192002-11-03 00:24:07 +00001420- Status LED: CONFIG_STATUS_LED
1421
1422 Several configurations allow to display the current
1423 status using a LED. For instance, the LED will blink
1424 fast while running U-Boot code, stop blinking as
1425 soon as a reply to a BOOTP request was received, and
1426 start blinking slow once the Linux kernel is running
1427 (supported by a status LED driver in the Linux
1428 kernel). Defining CONFIG_STATUS_LED enables this
1429 feature in U-Boot.
1430
1431- CAN Support: CONFIG_CAN_DRIVER
1432
1433 Defining CONFIG_CAN_DRIVER enables CAN driver support
1434 on those systems that support this (optional)
1435 feature, like the TQM8xxL modules.
1436
1437- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1438
wdenkb37c7e52003-06-30 16:24:52 +00001439 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001440 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001441 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001442
wdenk945af8d2003-07-16 21:53:01 +00001443 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001444 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001445 CONFIG_COMMANDS) and communicate with i2c based realtime
1446 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001447 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001448
Ben Warrenbb99ad62006-09-07 16:50:54 -04001449 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001450
wdenk945af8d2003-07-16 21:53:01 +00001451 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001452 bit-banging) driver instead of CPM or similar hardware
1453 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001454
wdenk945af8d2003-07-16 21:53:01 +00001455 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001456 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001457
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001458 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001459 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001460 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001461 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001462
Peter Tyser8d321b82010-04-12 22:28:21 -05001463 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001464 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001465 and so its address should therefore be cleared to 0 (See,
1466 eg, MPC823e User's Manual p.16-473). So, set
1467 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001468
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001469 CONFIG_SYS_I2C_INIT_MPC5XXX
1470
1471 When a board is reset during an i2c bus transfer
1472 chips might think that the current transfer is still
1473 in progress. Reset the slave devices by sending start
1474 commands until the slave device responds.
1475
wdenk945af8d2003-07-16 21:53:01 +00001476 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001477
1478 If you use the software i2c interface (CONFIG_SOFT_I2C)
1479 then the following macros need to be defined (examples are
1480 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001481
1482 I2C_INIT
1483
wdenkb37c7e52003-06-30 16:24:52 +00001484 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001485 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001486
wdenkba56f622004-02-06 23:19:44 +00001487 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001488
wdenkc6097192002-11-03 00:24:07 +00001489 I2C_PORT
1490
wdenk43d96162003-03-06 00:02:04 +00001491 (Only for MPC8260 CPU). The I/O port to use (the code
1492 assumes both bits are on the same port). Valid values
1493 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001494
1495 I2C_ACTIVE
1496
1497 The code necessary to make the I2C data line active
1498 (driven). If the data line is open collector, this
1499 define can be null.
1500
wdenkb37c7e52003-06-30 16:24:52 +00001501 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1502
wdenkc6097192002-11-03 00:24:07 +00001503 I2C_TRISTATE
1504
1505 The code necessary to make the I2C data line tri-stated
1506 (inactive). If the data line is open collector, this
1507 define can be null.
1508
wdenkb37c7e52003-06-30 16:24:52 +00001509 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1510
wdenkc6097192002-11-03 00:24:07 +00001511 I2C_READ
1512
1513 Code that returns TRUE if the I2C data line is high,
1514 FALSE if it is low.
1515
wdenkb37c7e52003-06-30 16:24:52 +00001516 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1517
wdenkc6097192002-11-03 00:24:07 +00001518 I2C_SDA(bit)
1519
1520 If <bit> is TRUE, sets the I2C data line high. If it
1521 is FALSE, it clears it (low).
1522
wdenkb37c7e52003-06-30 16:24:52 +00001523 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001524 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001525 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001526
wdenkc6097192002-11-03 00:24:07 +00001527 I2C_SCL(bit)
1528
1529 If <bit> is TRUE, sets the I2C clock line high. If it
1530 is FALSE, it clears it (low).
1531
wdenkb37c7e52003-06-30 16:24:52 +00001532 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001533 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001534 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001535
wdenkc6097192002-11-03 00:24:07 +00001536 I2C_DELAY
1537
1538 This delay is invoked four times per clock cycle so this
1539 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001540 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001541 like:
1542
wdenkb37c7e52003-06-30 16:24:52 +00001543 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001544
Mike Frysinger793b5722010-07-21 13:38:02 -04001545 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1546
1547 If your arch supports the generic GPIO framework (asm/gpio.h),
1548 then you may alternatively define the two GPIOs that are to be
1549 used as SCL / SDA. Any of the previous I2C_xxx macros will
1550 have GPIO-based defaults assigned to them as appropriate.
1551
1552 You should define these to the GPIO value as given directly to
1553 the generic GPIO functions.
1554
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001555 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001556
wdenk8bde7f72003-06-27 21:31:46 +00001557 When a board is reset during an i2c bus transfer
1558 chips might think that the current transfer is still
1559 in progress. On some boards it is possible to access
1560 the i2c SCLK line directly, either by using the
1561 processor pin as a GPIO or by having a second pin
1562 connected to the bus. If this option is defined a
1563 custom i2c_init_board() routine in boards/xxx/board.c
1564 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001565
Richard Retanubun26a33502010-04-12 15:08:17 -04001566 CONFIG_SYS_I2C_BOARD_LATE_INIT
1567
1568 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1569 defined a custom i2c_board_late_init() routine in
1570 boards/xxx/board.c is run AFTER the operations in i2c_init()
1571 is completed. This callpoint can be used to unreset i2c bus
1572 using CPU i2c controller register accesses for CPUs whose i2c
1573 controller provide such a method. It is called at the end of
1574 i2c_init() to allow i2c_init operations to setup the i2c bus
1575 controller on the CPU (e.g. setting bus speed & slave address).
1576
wdenk17ea1172004-06-06 21:51:03 +00001577 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1578
1579 This option enables configuration of bi_iic_fast[] flags
1580 in u-boot bd_info structure based on u-boot environment
1581 variable "i2cfast". (see also i2cfast)
1582
Ben Warrenbb99ad62006-09-07 16:50:54 -04001583 CONFIG_I2C_MULTI_BUS
1584
1585 This option allows the use of multiple I2C buses, each of which
1586 must have a controller. At any point in time, only one bus is
1587 active. To switch to a different bus, use the 'i2c dev' command.
1588 Note that bus numbering is zero-based.
1589
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001590 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001591
1592 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001593 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1594 is set, specify a list of bus-device pairs. Otherwise, specify
1595 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001596
1597 e.g.
1598 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001599 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001600
1601 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1602
1603 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001604 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001605
1606 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1607
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001608 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06001609
1610 If defined, then this indicates the I2C bus number for DDR SPD.
1611 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1612
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001613 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001614
1615 If defined, then this indicates the I2C bus number for the RTC.
1616 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1617
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001618 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001619
1620 If defined, then this indicates the I2C bus number for the DTT.
1621 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001623 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001624
1625 If defined, specifies the I2C address of the DTT device.
1626 If not defined, then U-Boot uses predefined value for
1627 specified DTT device.
1628
Timur Tabibe5e61812006-11-03 19:15:00 -06001629 CONFIG_FSL_I2C
1630
1631 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001632 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e61812006-11-03 19:15:00 -06001633
Heiko Schocher67b23a32008-10-15 09:39:47 +02001634 CONFIG_I2C_MUX
1635
1636 Define this option if you have I2C devices reached over 1 .. n
1637 I2C Muxes like the pca9544a. This option addes a new I2C
1638 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1639 new I2C Bus to the existing I2C Busses. If you select the
1640 new Bus with "i2c dev", u-bbot sends first the commandos for
1641 the muxes to activate this new "bus".
1642
1643 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1644 feature!
1645
1646 Example:
1647 Adding a new I2C Bus reached over 2 pca9544a muxes
1648 The First mux with address 70 and channel 6
1649 The Second mux with address 71 and channel 4
1650
1651 => i2c bus pca9544a:70:6:pca9544a:71:4
1652
1653 Use the "i2c bus" command without parameter, to get a list
1654 of I2C Busses with muxes:
1655
1656 => i2c bus
1657 Busses reached over muxes:
1658 Bus ID: 2
1659 reached over Mux(es):
1660 pca9544a@70 ch: 4
1661 Bus ID: 3
1662 reached over Mux(es):
1663 pca9544a@70 ch: 6
1664 pca9544a@71 ch: 4
1665 =>
1666
1667 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1668 u-boot sends First the Commando to the mux@70 to enable
1669 channel 6, and then the Commando to the mux@71 to enable
1670 the channel 4.
1671
1672 After that, you can use the "normal" i2c commands as
1673 usual, to communicate with your I2C devices behind
1674 the 2 muxes.
1675
1676 This option is actually implemented for the bitbanging
1677 algorithm in common/soft_i2c.c and for the Hardware I2C
1678 Bus on the MPC8260. But it should be not so difficult
1679 to add this option to other architectures.
1680
Andrew Dyer2ac69852008-12-29 17:36:01 -06001681 CONFIG_SOFT_I2C_READ_REPEATED_START
1682
1683 defining this will force the i2c_read() function in
1684 the soft_i2c driver to perform an I2C repeated start
1685 between writing the address pointer and reading the
1686 data. If this define is omitted the default behaviour
1687 of doing a stop-start sequence will be used. Most I2C
1688 devices can use either method, but some require one or
1689 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06001690
wdenkc6097192002-11-03 00:24:07 +00001691- SPI Support: CONFIG_SPI
1692
1693 Enables SPI driver (so far only tested with
1694 SPI EEPROM, also an instance works with Crystal A/D and
1695 D/As on the SACSng board)
1696
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001697 CONFIG_SH_SPI
1698
1699 Enables the driver for SPI controller on SuperH. Currently
1700 only SH7757 is supported.
1701
wdenkc6097192002-11-03 00:24:07 +00001702 CONFIG_SPI_X
1703
1704 Enables extended (16-bit) SPI EEPROM addressing.
1705 (symmetrical to CONFIG_I2C_X)
1706
1707 CONFIG_SOFT_SPI
1708
wdenk43d96162003-03-06 00:02:04 +00001709 Enables a software (bit-bang) SPI driver rather than
1710 using hardware support. This is a general purpose
1711 driver that only requires three general I/O port pins
1712 (two outputs, one input) to function. If this is
1713 defined, the board configuration must define several
1714 SPI configuration items (port pins to use, etc). For
1715 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001716
Ben Warren04a9e112008-01-16 22:37:35 -05001717 CONFIG_HARD_SPI
1718
1719 Enables a hardware SPI driver for general-purpose reads
1720 and writes. As with CONFIG_SOFT_SPI, the board configuration
1721 must define a list of chip-select function pointers.
1722 Currently supported on some MPC8xxx processors. For an
1723 example, see include/configs/mpc8349emds.h.
1724
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001725 CONFIG_MXC_SPI
1726
1727 Enables the driver for the SPI controllers on i.MX and MXC
1728 SoCs. Currently only i.MX31 is supported.
1729
Matthias Fuchs01335022007-12-27 17:12:34 +01001730- FPGA Support: CONFIG_FPGA
1731
1732 Enables FPGA subsystem.
1733
1734 CONFIG_FPGA_<vendor>
1735
1736 Enables support for specific chip vendors.
1737 (ALTERA, XILINX)
1738
1739 CONFIG_FPGA_<family>
1740
1741 Enables support for FPGA family.
1742 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1743
1744 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001745
wdenk43d96162003-03-06 00:02:04 +00001746 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001748 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001749
wdenk8bde7f72003-06-27 21:31:46 +00001750 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001752 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001753
wdenk43d96162003-03-06 00:02:04 +00001754 Enable checks on FPGA configuration interface busy
1755 status by the configuration function. This option
1756 will require a board or device specific function to
1757 be written.
wdenkc6097192002-11-03 00:24:07 +00001758
1759 CONFIG_FPGA_DELAY
1760
1761 If defined, a function that provides delays in the FPGA
1762 configuration driver.
1763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001764 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001765 Allow Control-C to interrupt FPGA configuration
1766
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001767 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001768
wdenk43d96162003-03-06 00:02:04 +00001769 Check for configuration errors during FPGA bitfile
1770 loading. For example, abort during Virtex II
1771 configuration if the INIT_B line goes low (which
1772 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001774 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001775
wdenk43d96162003-03-06 00:02:04 +00001776 Maximum time to wait for the INIT_B line to deassert
1777 after PROB_B has been deasserted during a Virtex II
1778 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001779 ms.
wdenkc6097192002-11-03 00:24:07 +00001780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001781 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001782
wdenk43d96162003-03-06 00:02:04 +00001783 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001784 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001786 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001787
wdenk43d96162003-03-06 00:02:04 +00001788 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001789 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001790
1791- Configuration Management:
1792 CONFIG_IDENT_STRING
1793
wdenk43d96162003-03-06 00:02:04 +00001794 If defined, this string will be added to the U-Boot
1795 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001796
1797- Vendor Parameter Protection:
1798
wdenk43d96162003-03-06 00:02:04 +00001799 U-Boot considers the values of the environment
1800 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001801 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001802 are set once by the board vendor / manufacturer, and
1803 protects these variables from casual modification by
1804 the user. Once set, these variables are read-only,
1805 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001806 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001807
1808 If CONFIG_ENV_OVERWRITE is #defined in your config
1809 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001810 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001811 these parameters.
1812
1813 Alternatively, if you #define _both_ CONFIG_ETHADDR
1814 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001815 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001816 which can be changed exactly ONCE by the user. [The
1817 serial# is unaffected by this, i. e. it remains
1818 read-only.]
1819
1820- Protected RAM:
1821 CONFIG_PRAM
1822
1823 Define this variable to enable the reservation of
1824 "protected RAM", i. e. RAM which is not overwritten
1825 by U-Boot. Define CONFIG_PRAM to hold the number of
1826 kB you want to reserve for pRAM. You can overwrite
1827 this default value by defining an environment
1828 variable "pram" to the number of kB you want to
1829 reserve. Note that the board info structure will
1830 still show the full amount of RAM. If pRAM is
1831 reserved, a new environment variable "mem" will
1832 automatically be defined to hold the amount of
1833 remaining RAM in a form that can be passed as boot
1834 argument to Linux, for instance like that:
1835
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001836 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001837 saveenv
1838
1839 This way you can tell Linux not to use this memory,
1840 either, which results in a memory region that will
1841 not be affected by reboots.
1842
1843 *WARNING* If your board configuration uses automatic
1844 detection of the RAM size, you must make sure that
1845 this memory test is non-destructive. So far, the
1846 following board configurations are known to be
1847 "pRAM-clean":
1848
1849 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1850 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001851 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001852
1853- Error Recovery:
1854 CONFIG_PANIC_HANG
1855
1856 Define this variable to stop the system in case of a
1857 fatal error, so that you have to reset it manually.
1858 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001859 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001860 automatically as fast as possible, but it may be
1861 useful during development since you can try to debug
1862 the conditions that lead to the situation.
1863
1864 CONFIG_NET_RETRY_COUNT
1865
wdenk43d96162003-03-06 00:02:04 +00001866 This variable defines the number of retries for
1867 network operations like ARP, RARP, TFTP, or BOOTP
1868 before giving up the operation. If not defined, a
1869 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001870
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001871 CONFIG_ARP_TIMEOUT
1872
1873 Timeout waiting for an ARP reply in milliseconds.
1874
wdenkc6097192002-11-03 00:24:07 +00001875- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001876 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001877
1878 Enable auto completion of commands using TAB.
1879
Wolfgang Denka9398e02006-11-27 15:32:42 +01001880 Note that this feature has NOT been implemented yet
1881 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001882
1883
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001884 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001885
1886 Define this variable to enable the "hush" shell (from
1887 Busybox) as command line interpreter, thus enabling
1888 powerful command line syntax like
1889 if...then...else...fi conditionals or `&&' and '||'
1890 constructs ("shell scripts").
1891
1892 If undefined, you get the old, much simpler behaviour
1893 with a somewhat smaller memory footprint.
1894
1895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001896 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001897
1898 This defines the secondary prompt string, which is
1899 printed when the command interpreter needs more input
1900 to complete a command. Usually "> ".
1901
1902 Note:
1903
wdenk8bde7f72003-06-27 21:31:46 +00001904 In the current implementation, the local variables
1905 space and global environment variables space are
1906 separated. Local variables are those you define by
1907 simply typing `name=value'. To access a local
1908 variable later on, you have write `$name' or
1909 `${name}'; to execute the contents of a variable
1910 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001911
wdenk43d96162003-03-06 00:02:04 +00001912 Global environment variables are those you use
1913 setenv/printenv to work with. To run a command stored
1914 in such a variable, you need to use the run command,
1915 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001916
1917 To store commands and special characters in a
1918 variable, please use double quotation marks
1919 surrounding the whole text of the variable, instead
1920 of the backslashes before semicolons and special
1921 symbols.
1922
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001923- Commandline Editing and History:
1924 CONFIG_CMDLINE_EDITING
1925
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001926 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001927 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001928
wdenka8c7c702003-12-06 19:49:23 +00001929- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001930 CONFIG_EXTRA_ENV_SETTINGS
1931
wdenk43d96162003-03-06 00:02:04 +00001932 Define this to contain any number of null terminated
1933 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001934 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001935
wdenk43d96162003-03-06 00:02:04 +00001936 For example, place something like this in your
1937 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001938
1939 #define CONFIG_EXTRA_ENV_SETTINGS \
1940 "myvar1=value1\0" \
1941 "myvar2=value2\0"
1942
wdenk43d96162003-03-06 00:02:04 +00001943 Warning: This method is based on knowledge about the
1944 internal format how the environment is stored by the
1945 U-Boot code. This is NOT an official, exported
1946 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001947 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001948 You better know what you are doing here.
1949
wdenk43d96162003-03-06 00:02:04 +00001950 Note: overly (ab)use of the default environment is
1951 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001952 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001953 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001954
wdenka8c7c702003-12-06 19:49:23 +00001955- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001956 CONFIG_HAS_DATAFLASH
1957
wdenk8bde7f72003-06-27 21:31:46 +00001958 Defining this option enables DataFlash features and
1959 allows to read/write in Dataflash via the standard
1960 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001961
wdenk3f85ce22004-02-23 16:11:30 +00001962- SystemACE Support:
1963 CONFIG_SYSTEMACE
1964
1965 Adding this option adds support for Xilinx SystemACE
1966 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001967 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001968 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001969
1970 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001971 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001972
1973 When SystemACE support is added, the "ace" device type
1974 becomes available to the fat commands, i.e. fatls.
1975
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001976- TFTP Fixed UDP Port:
1977 CONFIG_TFTP_PORT
1978
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001979 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001980 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001981 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001982 number generator is used.
1983
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001984 Also, the environment variable tftpdstp is used to supply
1985 the TFTP UDP destination port value. If tftpdstp isn't
1986 defined, the normal port 69 is used.
1987
1988 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001989 blindly start the TFTP transfer using the pre-configured
1990 target IP address and UDP port. This has the effect of
1991 "punching through" the (Windows XP) firewall, allowing
1992 the remainder of the TFTP transfer to proceed normally.
1993 A better solution is to properly configure the firewall,
1994 but sometimes that is not allowed.
1995
wdenka8c7c702003-12-06 19:49:23 +00001996- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001997 CONFIG_SHOW_BOOT_PROGRESS
1998
wdenk43d96162003-03-06 00:02:04 +00001999 Defining this option allows to add some board-
2000 specific code (calling a user-provided function
2001 "show_boot_progress(int)") that enables you to show
2002 the system's boot progress on some display (for
2003 example, some LED's) on your board. At the moment,
2004 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002005
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002006- Standalone program support:
2007 CONFIG_STANDALONE_LOAD_ADDR
2008
2009 This option allows to define board specific values
2010 for the address where standalone program gets loaded,
2011 thus overwriting the architecutre dependent default
2012 settings.
2013
Minkyu Kangd32a1a42011-04-24 22:22:34 +00002014- Frame Buffer Address:
2015 CONFIG_FB_ADDR
2016
2017 Define CONFIG_FB_ADDR if you want to use specific address for
2018 frame buffer.
2019 Then system will reserve the frame buffer address to defined address
2020 instead of lcd_setmem (this function grab the memory for frame buffer
2021 by panel's size).
2022
2023 Please see board_init_f function.
2024
2025 If you want this config option then,
2026 please define it at your board config file
2027
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002028Legacy uImage format:
2029
wdenkc6097192002-11-03 00:24:07 +00002030 Arg Where When
2031 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002032 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002033 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002034 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002035 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002036 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002037 4 common/cmd_bootm.c Image data has correct checksum
2038 -4 common/cmd_bootm.c Image is for unsupported architecture
2039 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002040 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002041 6 common/cmd_bootm.c Image Type check OK
2042 -6 common/cmd_bootm.c gunzip uncompression error
2043 -7 common/cmd_bootm.c Unimplemented compression type
2044 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002045 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002046 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002047
2048 9 common/image.c Start initial ramdisk verification
2049 -10 common/image.c Ramdisk header has bad magic number
2050 -11 common/image.c Ramdisk header has bad checksum
2051 10 common/image.c Ramdisk header is OK
2052 -12 common/image.c Ramdisk data has bad checksum
2053 11 common/image.c Ramdisk data has correct checksum
2054 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002055 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002056 13 common/image.c Start multifile image verification
2057 14 common/image.c No initial ramdisk, no multifile, continue.
2058
Peter Tyserea0364f2010-04-12 22:28:04 -05002059 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002060
Stefan Roesea47a12b2010-04-15 16:07:28 +02002061 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002062 -31 post/post.c POST test failed, detected by post_output_backlog()
2063 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002064
Heiko Schocher566a4942007-06-22 19:11:54 +02002065 34 common/cmd_doc.c before loading a Image from a DOC device
2066 -35 common/cmd_doc.c Bad usage of "doc" command
2067 35 common/cmd_doc.c correct usage of "doc" command
2068 -36 common/cmd_doc.c No boot device
2069 36 common/cmd_doc.c correct boot device
2070 -37 common/cmd_doc.c Unknown Chip ID on boot device
2071 37 common/cmd_doc.c correct chip ID found, device available
2072 -38 common/cmd_doc.c Read Error on boot device
2073 38 common/cmd_doc.c reading Image header from DOC device OK
2074 -39 common/cmd_doc.c Image header has bad magic number
2075 39 common/cmd_doc.c Image header has correct magic number
2076 -40 common/cmd_doc.c Error reading Image from DOC device
2077 40 common/cmd_doc.c Image header has correct magic number
2078 41 common/cmd_ide.c before loading a Image from a IDE device
2079 -42 common/cmd_ide.c Bad usage of "ide" command
2080 42 common/cmd_ide.c correct usage of "ide" command
2081 -43 common/cmd_ide.c No boot device
2082 43 common/cmd_ide.c boot device found
2083 -44 common/cmd_ide.c Device not available
2084 44 common/cmd_ide.c Device available
2085 -45 common/cmd_ide.c wrong partition selected
2086 45 common/cmd_ide.c partition selected
2087 -46 common/cmd_ide.c Unknown partition table
2088 46 common/cmd_ide.c valid partition table found
2089 -47 common/cmd_ide.c Invalid partition type
2090 47 common/cmd_ide.c correct partition type
2091 -48 common/cmd_ide.c Error reading Image Header on boot device
2092 48 common/cmd_ide.c reading Image Header from IDE device OK
2093 -49 common/cmd_ide.c Image header has bad magic number
2094 49 common/cmd_ide.c Image header has correct magic number
2095 -50 common/cmd_ide.c Image header has bad checksum
2096 50 common/cmd_ide.c Image header has correct checksum
2097 -51 common/cmd_ide.c Error reading Image from IDE device
2098 51 common/cmd_ide.c reading Image from IDE device OK
2099 52 common/cmd_nand.c before loading a Image from a NAND device
2100 -53 common/cmd_nand.c Bad usage of "nand" command
2101 53 common/cmd_nand.c correct usage of "nand" command
2102 -54 common/cmd_nand.c No boot device
2103 54 common/cmd_nand.c boot device found
2104 -55 common/cmd_nand.c Unknown Chip ID on boot device
2105 55 common/cmd_nand.c correct chip ID found, device available
2106 -56 common/cmd_nand.c Error reading Image Header on boot device
2107 56 common/cmd_nand.c reading Image Header from NAND device OK
2108 -57 common/cmd_nand.c Image header has bad magic number
2109 57 common/cmd_nand.c Image header has correct magic number
2110 -58 common/cmd_nand.c Error reading Image from NAND device
2111 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002112
Heiko Schocher566a4942007-06-22 19:11:54 +02002113 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002114
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002115 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002116 -64 net/eth.c no Ethernet found.
2117 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002118
Heiko Schocher566a4942007-06-22 19:11:54 +02002119 -80 common/cmd_net.c usage wrong
2120 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002121 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002122 81 common/cmd_net.c NetLoop() back without error
2123 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2124 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002125 83 common/cmd_net.c running "source" command
2126 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002127 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002128
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002129FIT uImage format:
2130
2131 Arg Where When
2132 100 common/cmd_bootm.c Kernel FIT Image has correct format
2133 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2134 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2135 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2136 102 common/cmd_bootm.c Kernel unit name specified
2137 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002138 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002139 104 common/cmd_bootm.c Got kernel subimage node offset
2140 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2141 105 common/cmd_bootm.c Kernel subimage hash verification OK
2142 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2143 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002144 -106 common/cmd_bootm.c Kernel subimage has wrong type
2145 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002146 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2147 108 common/cmd_bootm.c Got kernel subimage data/size
2148 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2149 -109 common/cmd_bootm.c Can't get kernel subimage type
2150 -110 common/cmd_bootm.c Can't get kernel subimage comp
2151 -111 common/cmd_bootm.c Can't get kernel subimage os
2152 -112 common/cmd_bootm.c Can't get kernel subimage load address
2153 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2154
2155 120 common/image.c Start initial ramdisk verification
2156 -120 common/image.c Ramdisk FIT image has incorrect format
2157 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002158 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002159 -122 common/image.c Can't get configuration for ramdisk subimage
2160 123 common/image.c Ramdisk unit name specified
2161 -124 common/image.c Can't get ramdisk subimage node offset
2162 125 common/image.c Got ramdisk subimage node offset
2163 -125 common/image.c Ramdisk subimage hash verification failed
2164 126 common/image.c Ramdisk subimage hash verification OK
2165 -126 common/image.c Ramdisk subimage for unsupported architecture
2166 127 common/image.c Architecture check OK
2167 -127 common/image.c Can't get ramdisk subimage data/size
2168 128 common/image.c Got ramdisk subimage data/size
2169 129 common/image.c Can't get ramdisk load address
2170 -129 common/image.c Got ramdisk load address
2171
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002172 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002173 131 common/cmd_doc.c FIT image format OK
2174
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002175 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002176 141 common/cmd_ide.c FIT image format OK
2177
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002178 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002179 151 common/cmd_nand.c FIT image format OK
2180
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002181- Automatic software updates via TFTP server
2182 CONFIG_UPDATE_TFTP
2183 CONFIG_UPDATE_TFTP_CNT_MAX
2184 CONFIG_UPDATE_TFTP_MSEC_MAX
2185
2186 These options enable and control the auto-update feature;
2187 for a more detailed description refer to doc/README.update.
2188
2189- MTD Support (mtdparts command, UBI support)
2190 CONFIG_MTD_DEVICE
2191
2192 Adds the MTD device infrastructure from the Linux kernel.
2193 Needed for mtdparts command support.
2194
2195 CONFIG_MTD_PARTITIONS
2196
2197 Adds the MTD partitioning infrastructure from the Linux
2198 kernel. Needed for UBI support.
2199
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002200
wdenkc6097192002-11-03 00:24:07 +00002201Modem Support:
2202--------------
2203
wdenk85ec0bc2003-03-31 16:34:49 +00002204[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002205
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002206- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002207 CONFIG_MODEM_SUPPORT
2208
2209- RTS/CTS Flow control enable:
2210 CONFIG_HWFLOW
2211
2212- Modem debug support:
2213 CONFIG_MODEM_SUPPORT_DEBUG
2214
wdenk43d96162003-03-06 00:02:04 +00002215 Enables debugging stuff (char screen[1024], dbg())
2216 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002217
wdenka8c7c702003-12-06 19:49:23 +00002218- Interrupt support (PPC):
2219
wdenkd4ca31c2004-01-02 14:00:00 +00002220 There are common interrupt_init() and timer_interrupt()
2221 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002222 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002223 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002224 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002225 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002226 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002227 specific handling. If board has watchdog / status_led
2228 / other_activity_monitor it works automatically from
2229 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002230
wdenkc6097192002-11-03 00:24:07 +00002231- General:
2232
wdenk43d96162003-03-06 00:02:04 +00002233 In the target system modem support is enabled when a
2234 specific key (key combination) is pressed during
2235 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002236 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002237 board_init(). Currently key_pressed() is a dummy
2238 function, returning 1 and thus enabling modem
2239 initialization.
wdenkc6097192002-11-03 00:24:07 +00002240
wdenk43d96162003-03-06 00:02:04 +00002241 If there are no modem init strings in the
2242 environment, U-Boot proceed to autoboot; the
2243 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002244 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002245
2246 See also: doc/README.Modem
2247
2248
wdenkc6097192002-11-03 00:24:07 +00002249Configuration Settings:
2250-----------------------
2251
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002252- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002253 undefine this when you're short of memory.
2254
Peter Tyser2fb26042009-01-27 18:03:12 -06002255- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2256 width of the commands listed in the 'help' command output.
2257
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002258- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002259 prompt for user input.
2260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002261- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002263- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002265- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002267- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002268 the application (usually a Linux kernel) when it is
2269 booted
2270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002271- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002272 List of legal baudrate settings for this board.
2273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002274- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002275 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002276
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002277- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002278 If the board specific function
2279 extern int overwrite_console (void);
2280 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002281 serial port, else the settings in the environment are used.
2282
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002283- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002284 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002286- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002287 Enable overwrite of previous console environment settings.
2288
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002289- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002290 Begin and End addresses of the area used by the
2291 simple memory test.
2292
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002293- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002294 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002295
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002296- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002297 Scratch address used by the alternate memory test
2298 You only need to set this if address zero isn't writeable
2299
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002300- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2301 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002302 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002303 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002304 fixing up gd->ram_size the Linux kernel should gets passed
2305 the now "corrected" memory size and won't touch it either.
2306 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002307 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002308 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002309 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002310
2311 This option can be used as a workaround for the 440EPx/GRx
2312 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2313 be touched.
2314
2315 WARNING: Please make sure that this value is a multiple of
2316 the Linux page size (normally 4k). If this is not the case,
2317 then the end address of the Linux memory will be located at a
2318 non page size aligned address and this could cause major
2319 problems.
2320
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002321- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002322 Default load address for network file downloads
2323
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002324- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002325 Enable temporary baudrate change while serial download
2326
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002327- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002328 Physical start address of SDRAM. _Must_ be 0 here.
2329
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002330- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002331 Physical start address of Motherboard I/O (if using a
2332 Cogent motherboard)
2333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002334- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002335 Physical start address of Flash memory.
2336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002337- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002338 Physical start address of boot monitor code (set by
2339 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002340 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002341 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002342
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002343- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002344 Size of memory reserved for monitor code, used to
2345 determine _at_compile_time_ (!) if the environment is
2346 embedded within the U-Boot image, or in a separate
2347 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002349- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002350 Size of DRAM reserved for malloc() use.
2351
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002352- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002353 Normally compressed uImages are limited to an
2354 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002355 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002356 to adjust this setting to your needs.
2357
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002358- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002359 Maximum size of memory mapped by the startup code of
2360 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002361 the Linux kernel (bd_info, boot arguments, FDT blob if
2362 used) must be put below this limit, unless "bootm_low"
2363 enviroment variable is defined and non-zero. In such case
2364 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002365 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2366 variable "bootm_mapsize" will override the value of
2367 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2368 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002369
John Rigbyfca43cc2010-10-13 13:57:35 -06002370- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2371 Enable initrd_high functionality. If defined then the
2372 initrd_high feature is enabled and the bootm ramdisk subcommand
2373 is enabled.
2374
2375- CONFIG_SYS_BOOT_GET_CMDLINE:
2376 Enables allocating and saving kernel cmdline in space between
2377 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2378
2379- CONFIG_SYS_BOOT_GET_KBD:
2380 Enables allocating and saving a kernel copy of the bd_info in
2381 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2382
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002383- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002384 Max number of Flash memory banks
2385
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002386- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002387 Max number of sectors on a Flash chip
2388
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002389- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002390 Timeout for Flash erase operations (in ms)
2391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002392- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002393 Timeout for Flash write operations (in ms)
2394
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002395- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002396 Timeout for Flash set sector lock bit operation (in ms)
2397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002398- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002399 Timeout for Flash clear lock bits operation (in ms)
2400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002401- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002402 If defined, hardware flash sectors protection is used
2403 instead of U-Boot software protection.
2404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002405- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002406
2407 Enable TFTP transfers directly to flash memory;
2408 without this option such a download has to be
2409 performed in two steps: (1) download to RAM, and (2)
2410 copy from RAM to flash.
2411
2412 The two-step approach is usually more reliable, since
2413 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002414 the flash, but in some situations (when system RAM is
2415 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002416 downloaded image) this option may be very useful.
2417
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002418- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002419 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002420 common flash structure for storing flash geometry.
2421
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002422- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002423 This option also enables the building of the cfi_flash driver
2424 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002425
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002426- CONFIG_FLASH_CFI_MTD
2427 This option enables the building of the cfi_mtd driver
2428 in the drivers directory. The driver exports CFI flash
2429 to the MTD layer.
2430
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002431- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002432 Use buffered writes to flash.
2433
2434- CONFIG_FLASH_SPANSION_S29WS_N
2435 s29ws-n MirrorBit flash has non-standard addresses for buffered
2436 write commands.
2437
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002438- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002439 If this option is defined, the common CFI flash doesn't
2440 print it's warning upon not recognized FLASH banks. This
2441 is useful, if some of the configured banks are only
2442 optionally available.
2443
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002444- CONFIG_FLASH_SHOW_PROGRESS
2445 If defined (must be an integer), print out countdown
2446 digits and dots. Recommended value: 45 (9..1) for 80
2447 column displays, 15 (3..1) for 40 column displays.
2448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002449- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002450 Defines the number of Ethernet receive buffers. On some
2451 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002452 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2453 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002454 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002455 Defaults to 4 if not defined.
2456
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002457- CONFIG_ENV_MAX_ENTRIES
2458
Wolfgang Denk071bc922010-10-27 22:48:30 +02002459 Maximum number of entries in the hash table that is used
2460 internally to store the environment settings. The default
2461 setting is supposed to be generous and should work in most
2462 cases. This setting can be used to tune behaviour; see
2463 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002464
wdenkc6097192002-11-03 00:24:07 +00002465The following definitions that deal with the placement and management
2466of environment data (variable area); in general, we support the
2467following configurations:
2468
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002469- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002470
2471 Define this if the environment is in flash memory.
2472
2473 a) The environment occupies one whole flash sector, which is
2474 "embedded" in the text segment with the U-Boot code. This
2475 happens usually with "bottom boot sector" or "top boot
2476 sector" type flash chips, which have several smaller
2477 sectors at the start or the end. For instance, such a
2478 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2479 such a case you would place the environment in one of the
2480 4 kB sectors - with U-Boot code before and after it. With
2481 "top boot sector" type flash chips, you would put the
2482 environment in one of the last sectors, leaving a gap
2483 between U-Boot and the environment.
2484
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002485 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002486
2487 Offset of environment data (variable area) to the
2488 beginning of flash memory; for instance, with bottom boot
2489 type flash chips the second sector can be used: the offset
2490 for this sector is given here.
2491
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002492 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002493
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002494 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002495
2496 This is just another way to specify the start address of
2497 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002498 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002499
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002500 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002501
2502 Size of the sector containing the environment.
2503
2504
2505 b) Sometimes flash chips have few, equal sized, BIG sectors.
2506 In such a case you don't want to spend a whole sector for
2507 the environment.
2508
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002509 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002510
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002511 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002512 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002513 of this flash sector for the environment. This saves
2514 memory for the RAM copy of the environment.
2515
2516 It may also save flash memory if you decide to use this
2517 when your environment is "embedded" within U-Boot code,
2518 since then the remainder of the flash sector could be used
2519 for U-Boot code. It should be pointed out that this is
2520 STRONGLY DISCOURAGED from a robustness point of view:
2521 updating the environment in flash makes it always
2522 necessary to erase the WHOLE sector. If something goes
2523 wrong before the contents has been restored from a copy in
2524 RAM, your target system will be dead.
2525
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002526 - CONFIG_ENV_ADDR_REDUND
2527 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002528
wdenk43d96162003-03-06 00:02:04 +00002529 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002530 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002531 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002532 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002533
2534BE CAREFUL! Any changes to the flash layout, and some changes to the
2535source code will make it necessary to adapt <board>/u-boot.lds*
2536accordingly!
2537
2538
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002539- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002540
2541 Define this if you have some non-volatile memory device
2542 (NVRAM, battery buffered SRAM) which you want to use for the
2543 environment.
2544
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002545 - CONFIG_ENV_ADDR:
2546 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002547
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002548 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002549 want to use for environment. It is assumed that this memory
2550 can just be read and written to, without any special
2551 provision.
2552
2553BE CAREFUL! The first access to the environment happens quite early
2554in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002555console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002556U-Boot will hang.
2557
2558Please note that even with NVRAM we still use a copy of the
2559environment in RAM: we could work on NVRAM directly, but we want to
2560keep settings there always unmodified except somebody uses "saveenv"
2561to save the current settings.
2562
2563
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002564- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002565
2566 Use this if you have an EEPROM or similar serial access
2567 device and a driver for it.
2568
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002569 - CONFIG_ENV_OFFSET:
2570 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002571
2572 These two #defines specify the offset and size of the
2573 environment area within the total memory of your EEPROM.
2574
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002575 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002576 If defined, specified the chip address of the EEPROM device.
2577 The default address is zero.
2578
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002579 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002580 If defined, the number of bits used to address bytes in a
2581 single page in the EEPROM device. A 64 byte page, for example
2582 would require six bits.
2583
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002584 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002585 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002586 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002588 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002589 The length in bytes of the EEPROM memory array address. Note
2590 that this is NOT the chip address length!
2591
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002592 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002593 EEPROM chips that implement "address overflow" are ones
2594 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2595 address and the extra bits end up in the "chip address" bit
2596 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2597 byte chips.
2598
2599 Note that we consider the length of the address field to
2600 still be one byte because the extra address bits are hidden
2601 in the chip address.
2602
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002603 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002604 The size in bytes of the EEPROM device.
2605
Heiko Schocher548738b2010-01-07 08:55:40 +01002606 - CONFIG_ENV_EEPROM_IS_ON_I2C
2607 define this, if you have I2C and SPI activated, and your
2608 EEPROM, which holds the environment, is on the I2C bus.
2609
2610 - CONFIG_I2C_ENV_EEPROM_BUS
2611 if you have an Environment on an EEPROM reached over
2612 I2C muxes, you can define here, how to reach this
2613 EEPROM. For example:
2614
Wolfgang Denka9046b92010-06-13 17:48:15 +02002615 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002616
2617 EEPROM which holds the environment, is reached over
2618 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002619
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002620- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002621
wdenkd4ca31c2004-01-02 14:00:00 +00002622 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002623 want to use for the environment.
2624
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002625 - CONFIG_ENV_OFFSET:
2626 - CONFIG_ENV_ADDR:
2627 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002628
2629 These three #defines specify the offset and size of the
2630 environment area within the total memory of your DataFlash placed
2631 at the specified address.
2632
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002633- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002634
2635 Define this if you have a NAND device which you want to use
2636 for the environment.
2637
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002638 - CONFIG_ENV_OFFSET:
2639 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002640
2641 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002642 area within the first NAND device. CONFIG_ENV_OFFSET must be
2643 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002644
Scott Woodfdd813d2010-09-17 14:38:37 -05002645 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002646
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002647 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002648 size used to hold a redundant copy of the environment data, so
2649 that there is a valid backup copy in case there is a power failure
2650 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2651 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002652
Scott Woodfdd813d2010-09-17 14:38:37 -05002653 - CONFIG_ENV_RANGE (optional):
2654
2655 Specifies the length of the region in which the environment
2656 can be written. This should be a multiple of the NAND device's
2657 block size. Specifying a range with more erase blocks than
2658 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2659 the range to be avoided.
2660
2661 - CONFIG_ENV_OFFSET_OOB (optional):
2662
2663 Enables support for dynamically retrieving the offset of the
2664 environment from block zero's out-of-band data. The
2665 "nand env.oob" command can be used to record this offset.
2666 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2667 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002668
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002669- CONFIG_NAND_ENV_DST
2670
2671 Defines address in RAM to which the nand_spl code should copy the
2672 environment. If redundant environment is used, it will be copied to
2673 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2674
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002675- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002676
2677 Defines offset to the initial SPI buffer area in DPRAM. The
2678 area is used at an early stage (ROM part) if the environment
2679 is configured to reside in the SPI EEPROM: We need a 520 byte
2680 scratch DPRAM area. It is used between the two initialization
2681 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2682 to be a good choice since it makes it far enough from the
2683 start of the data area as well as from the stack pointer.
2684
Bruce Adlere881cb52007-11-02 13:15:42 -07002685Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002686has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002687created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002688until then to read environment variables.
2689
wdenk85ec0bc2003-03-31 16:34:49 +00002690The environment is protected by a CRC32 checksum. Before the monitor
2691is relocated into RAM, as a result of a bad CRC you will be working
2692with the compiled-in default environment - *silently*!!! [This is
2693necessary, because the first environment variable we need is the
2694"baudrate" setting for the console - if we have a bad CRC, we don't
2695have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002696
2697Note: once the monitor has been relocated, then it will complain if
2698the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002699use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002700
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002701- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002702 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002703
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002704 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002705 also needs to be defined.
2706
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002707- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002708 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002709
Ron Madridf5675aa2009-02-18 14:30:44 -08002710- CONFIG_NS16550_MIN_FUNCTIONS:
2711 Define this if you desire to only have use of the NS16550_init
2712 and NS16550_putc functions for the serial driver located at
2713 drivers/serial/ns16550.c. This option is useful for saving
2714 space for already greatly restricted images, including but not
2715 limited to NAND_SPL configurations.
2716
wdenkc6097192002-11-03 00:24:07 +00002717Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002718---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002719
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002720- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002721 Cache Line Size of the CPU.
2722
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002723- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002724 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002725
wdenk42d1f032003-10-15 23:53:47 +00002726 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2727 and RPXsuper) to be able to adjust the position of
2728 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002729
wdenk7f6c2cb2002-11-10 22:06:23 +00002730- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002731 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002732
2733 the default drive number (default value 0)
2734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002735 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002736
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002737 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002738 (default value 1)
2739
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002740 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002741
wdenk43d96162003-03-06 00:02:04 +00002742 defines the offset of register from address. It
2743 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002744 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002746 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2747 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002748 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002750 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002751 fdc_hw_init() is called at the beginning of the FDC
2752 setup. fdc_hw_init() must be provided by the board
2753 source code. It is used to make hardware dependant
2754 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002755
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002756- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002757 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002758 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002759
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002760- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002761
wdenk7152b1d2003-09-05 23:19:14 +00002762 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002763 initial data and stack; please note that this must be
2764 writable memory that is working WITHOUT special
2765 initialization, i. e. you CANNOT use normal RAM which
2766 will become available only after programming the
2767 memory controller and running certain initialization
2768 sequences.
2769
2770 U-Boot uses the following memory types:
2771 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2772 - MPC824X: data cache
2773 - PPC4xx: data cache
2774
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002775- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002776
2777 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002778 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2779 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002780 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002781 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002782 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2783 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2784 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002785
2786 Note:
2787 On the MPC824X (or other systems that use the data
2788 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002789 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002790 point to an otherwise UNUSED address space between
2791 the top of RAM and the start of the PCI space.
2792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002793- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002794
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002795- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002797- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002798
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002799- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002801- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002805- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002806 SDRAM timing
2807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002808- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002809 periodic timer for refresh
2810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002811- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002813- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2814 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2815 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2816 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002817 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2818
2819- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002820 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2821 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002822 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002824- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2825 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002826 Machine Mode Register and Memory Periodic Timer
2827 Prescaler definitions (SDRAM timing)
2828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002829- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002830 enable I2C microcode relocation patch (MPC8xx);
2831 define relocation offset in DPRAM [DSP2]
2832
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002833- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002834 enable SMC microcode relocation patch (MPC8xx);
2835 define relocation offset in DPRAM [SMC1]
2836
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002837- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002838 enable SPI microcode relocation patch (MPC8xx);
2839 define relocation offset in DPRAM [SCC4]
2840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002841- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002842 Use OSCM clock mode on MBX8xx board. Be careful,
2843 wrong setting might damage your board. Read
2844 doc/README.MBX before setting this variable!
2845
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002846- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002847 Offset of the bootmode word in DPRAM used by post
2848 (Power On Self Tests). This definition overrides
2849 #define'd default value in commproc.h resp.
2850 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002851
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002852- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2853 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2854 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2855 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2856 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2857 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2858 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2859 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002860 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002861
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002862- CONFIG_PCI_DISABLE_PCIE:
2863 Disable PCI-Express on systems where it is supported but not
2864 required.
2865
Kumar Galaa09b9b62010-12-30 12:09:53 -06002866- CONFIG_SYS_SRIO:
2867 Chip has SRIO or not
2868
2869- CONFIG_SRIO1:
2870 Board has SRIO 1 port available
2871
2872- CONFIG_SRIO2:
2873 Board has SRIO 2 port available
2874
2875- CONFIG_SYS_SRIOn_MEM_VIRT:
2876 Virtual Address of SRIO port 'n' memory region
2877
2878- CONFIG_SYS_SRIOn_MEM_PHYS:
2879 Physical Address of SRIO port 'n' memory region
2880
2881- CONFIG_SYS_SRIOn_MEM_SIZE:
2882 Size of SRIO port 'n' memory region
2883
Ben Warrenbb99ad62006-09-07 16:50:54 -04002884- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002885 Get DDR timing information from an I2C EEPROM. Common
2886 with pluggable memory modules such as SODIMMs
2887
Ben Warrenbb99ad62006-09-07 16:50:54 -04002888 SPD_EEPROM_ADDRESS
2889 I2C address of the SPD EEPROM
2890
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002891- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002892 If SPD EEPROM is on an I2C bus other than the first
2893 one, specify here. Note that the value must resolve
2894 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002896- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002897 Only for 83xx systems. If specified, then DDR should
2898 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002899
wdenkc26e4542004-04-18 10:13:26 +00002900- CONFIG_ETHER_ON_FEC[12]
2901 Define to enable FEC[12] on a 8xx series processor.
2902
2903- CONFIG_FEC[12]_PHY
2904 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002905 to the given FEC; i. e.
2906 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002907 means that the PHY with address 4 is connected to FEC1
2908
2909 When set to -1, means to probe for first available.
2910
2911- CONFIG_FEC[12]_PHY_NORXERR
2912 The PHY does not have a RXERR line (RMII only).
2913 (so program the FEC to ignore it).
2914
2915- CONFIG_RMII
2916 Enable RMII mode for all FECs.
2917 Note that this is a global option, we can't
2918 have one FEC in standard MII mode and another in RMII mode.
2919
wdenk5cf91d62004-04-23 20:32:05 +00002920- CONFIG_CRC32_VERIFY
2921 Add a verify option to the crc32 command.
2922 The syntax is:
2923
2924 => crc32 -v <address> <count> <crc32>
2925
2926 Where address/count indicate a memory area
2927 and crc32 is the correct crc32 which the
2928 area should have.
2929
wdenk56523f12004-07-11 17:40:54 +00002930- CONFIG_LOOPW
2931 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002932 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002933
stroese7b466642004-12-16 18:46:55 +00002934- CONFIG_MX_CYCLIC
2935 Add the "mdc" and "mwc" memory commands. These are cyclic
2936 "md/mw" commands.
2937 Examples:
2938
wdenkefe2a4d2004-12-16 21:44:03 +00002939 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002940 This command will print 4 bytes (10,11,12,13) each 500 ms.
2941
wdenkefe2a4d2004-12-16 21:44:03 +00002942 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002943 This command will write 12345678 to address 100 all 10 ms.
2944
wdenkefe2a4d2004-12-16 21:44:03 +00002945 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002946 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002947
wdenk8aa1a2d2005-04-04 12:44:11 +00002948- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002949 [ARM only] If this variable is defined, then certain
2950 low level initializations (like setting up the memory
2951 controller) are omitted and/or U-Boot does not
2952 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002953
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002954 Normally this variable MUST NOT be defined. The only
2955 exception is when U-Boot is loaded (to RAM) by some
2956 other boot loader or by a debugger which performs
2957 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002958
Magnus Liljadf812382009-06-13 20:50:00 +02002959- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02002960 Modifies the behaviour of start.S when compiling a loader
2961 that is executed before the actual U-Boot. E.g. when
2962 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002963
Matthias Weisserd8834a12011-03-10 21:36:32 +00002964- CONFIG_USE_ARCH_MEMCPY
2965 CONFIG_USE_ARCH_MEMSET
2966 If these options are used a optimized version of memcpy/memset will
2967 be used if available. These functions may be faster under some
2968 conditions but may increase the binary size.
2969
wdenkc6097192002-11-03 00:24:07 +00002970Building the Software:
2971======================
2972
Wolfgang Denk218ca722008-03-26 10:40:12 +01002973Building U-Boot has been tested in several native build environments
2974and in many different cross environments. Of course we cannot support
2975all possibly existing versions of cross development tools in all
2976(potentially obsolete) versions. In case of tool chain problems we
2977recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2978which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002979
Wolfgang Denk218ca722008-03-26 10:40:12 +01002980If you are not using a native environment, it is assumed that you
2981have GNU cross compiling tools available in your path. In this case,
2982you must set the environment variable CROSS_COMPILE in your shell.
2983Note that no changes to the Makefile or any other source files are
2984necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002985
Wolfgang Denk218ca722008-03-26 10:40:12 +01002986 $ CROSS_COMPILE=ppc_4xx-
2987 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002988
Peter Tyser2f8d3962009-03-13 18:54:51 -05002989Note: If you wish to generate Windows versions of the utilities in
2990 the tools directory you can use the MinGW toolchain
2991 (http://www.mingw.org). Set your HOST tools to the MinGW
2992 toolchain and execute 'make tools'. For example:
2993
2994 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2995
2996 Binaries such as tools/mkimage.exe will be created which can
2997 be executed on computers running Windows.
2998
Wolfgang Denk218ca722008-03-26 10:40:12 +01002999U-Boot is intended to be simple to build. After installing the
3000sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003001is done by typing:
3002
3003 make NAME_config
3004
Wolfgang Denk218ca722008-03-26 10:40:12 +01003005where "NAME_config" is the name of one of the existing configu-
3006rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003007
wdenk2729af92004-05-03 20:45:30 +00003008Note: for some board special configuration names may exist; check if
3009 additional information is available from the board vendor; for
3010 instance, the TQM823L systems are available without (standard)
3011 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003012 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003013
wdenk2729af92004-05-03 20:45:30 +00003014 make TQM823L_config
3015 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003016
wdenk2729af92004-05-03 20:45:30 +00003017 make TQM823L_LCD_config
3018 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003019
wdenk2729af92004-05-03 20:45:30 +00003020 etc.
wdenkc6097192002-11-03 00:24:07 +00003021
wdenkc6097192002-11-03 00:24:07 +00003022
wdenk2729af92004-05-03 20:45:30 +00003023Finally, type "make all", and you should get some working U-Boot
3024images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003025
wdenk2729af92004-05-03 20:45:30 +00003026- "u-boot.bin" is a raw binary image
3027- "u-boot" is an image in ELF binary format
3028- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003029
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003030By default the build is performed locally and the objects are saved
3031in the source directory. One of the two methods can be used to change
3032this behavior and build U-Boot to some external directory:
3033
30341. Add O= to the make command line invocations:
3035
3036 make O=/tmp/build distclean
3037 make O=/tmp/build NAME_config
3038 make O=/tmp/build all
3039
30402. Set environment variable BUILD_DIR to point to the desired location:
3041
3042 export BUILD_DIR=/tmp/build
3043 make distclean
3044 make NAME_config
3045 make all
3046
3047Note that the command line "O=" setting overrides the BUILD_DIR environment
3048variable.
3049
wdenkc6097192002-11-03 00:24:07 +00003050
wdenk2729af92004-05-03 20:45:30 +00003051Please be aware that the Makefiles assume you are using GNU make, so
3052for instance on NetBSD you might need to use "gmake" instead of
3053native "make".
wdenkc6097192002-11-03 00:24:07 +00003054
wdenkc6097192002-11-03 00:24:07 +00003055
wdenk2729af92004-05-03 20:45:30 +00003056If the system board that you have is not listed, then you will need
3057to port U-Boot to your hardware platform. To do this, follow these
3058steps:
wdenkc6097192002-11-03 00:24:07 +00003059
wdenk2729af92004-05-03 20:45:30 +000030601. Add a new configuration option for your board to the toplevel
3061 "Makefile" and to the "MAKEALL" script, using the existing
3062 entries as examples. Note that here and at many other places
3063 boards and other names are listed in alphabetical sort order. Please
3064 keep this order.
30652. Create a new directory to hold your board specific code. Add any
3066 files you need. In your board directory, you will need at least
3067 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
30683. Create a new configuration file "include/configs/<board>.h" for
3069 your board
30703. If you're porting U-Boot to a new CPU, then also create a new
3071 directory to hold your CPU specific code. Add any files you need.
30724. Run "make <board>_config" with your new name.
30735. Type "make", and you should get a working "u-boot.srec" file
3074 to be installed on your target system.
30756. Debug and solve any problems that might arise.
3076 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003077
wdenkc6097192002-11-03 00:24:07 +00003078
wdenk2729af92004-05-03 20:45:30 +00003079Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3080==============================================================
wdenkc6097192002-11-03 00:24:07 +00003081
Wolfgang Denk218ca722008-03-26 10:40:12 +01003082If you have modified U-Boot sources (for instance added a new board
3083or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003084provide feedback to the other developers. The feedback normally takes
3085the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003086official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003087
Wolfgang Denk218ca722008-03-26 10:40:12 +01003088But before you submit such a patch, please verify that your modifi-
3089cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003090the supported boards compile WITHOUT ANY compiler warnings. To do so,
3091just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003092for ALL supported system. Be warned, this will take a while. You can
3093select which (cross) compiler to use by passing a `CROSS_COMPILE'
3094environment variable to the script, i. e. to use the ELDK cross tools
3095you can type
wdenkc6097192002-11-03 00:24:07 +00003096
wdenk2729af92004-05-03 20:45:30 +00003097 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003098
wdenk2729af92004-05-03 20:45:30 +00003099or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003100
wdenk2729af92004-05-03 20:45:30 +00003101 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003102
Wolfgang Denk218ca722008-03-26 10:40:12 +01003103When using the MAKEALL script, the default behaviour is to build
3104U-Boot in the source directory. This location can be changed by
3105setting the BUILD_DIR environment variable. Also, for each target
3106built, the MAKEALL script saves two log files (<target>.ERR and
3107<target>.MAKEALL) in the <source dir>/LOG directory. This default
3108location can be changed by setting the MAKEALL_LOGDIR environment
3109variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003110
3111 export BUILD_DIR=/tmp/build
3112 export MAKEALL_LOGDIR=/tmp/log
3113 CROSS_COMPILE=ppc_8xx- MAKEALL
3114
Wolfgang Denk218ca722008-03-26 10:40:12 +01003115With the above settings build objects are saved in the /tmp/build,
3116log files are saved in the /tmp/log and the source tree remains clean
3117during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003118
3119
wdenk2729af92004-05-03 20:45:30 +00003120See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003121
wdenkc6097192002-11-03 00:24:07 +00003122
wdenk2729af92004-05-03 20:45:30 +00003123Monitor Commands - Overview:
3124============================
wdenkc6097192002-11-03 00:24:07 +00003125
wdenk2729af92004-05-03 20:45:30 +00003126go - start application at address 'addr'
3127run - run commands in an environment variable
3128bootm - boot application image from memory
3129bootp - boot image via network using BootP/TFTP protocol
3130tftpboot- boot image via network using TFTP protocol
3131 and env variables "ipaddr" and "serverip"
3132 (and eventually "gatewayip")
3133rarpboot- boot image via network using RARP/TFTP protocol
3134diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3135loads - load S-Record file over serial line
3136loadb - load binary file over serial line (kermit mode)
3137md - memory display
3138mm - memory modify (auto-incrementing)
3139nm - memory modify (constant address)
3140mw - memory write (fill)
3141cp - memory copy
3142cmp - memory compare
3143crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003144i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003145sspi - SPI utility commands
3146base - print or set address offset
3147printenv- print environment variables
3148setenv - set environment variables
3149saveenv - save environment variables to persistent storage
3150protect - enable or disable FLASH write protection
3151erase - erase FLASH memory
3152flinfo - print FLASH memory information
3153bdinfo - print Board Info structure
3154iminfo - print header information for application image
3155coninfo - print console devices and informations
3156ide - IDE sub-system
3157loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003158loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003159mtest - simple RAM test
3160icache - enable or disable instruction cache
3161dcache - enable or disable data cache
3162reset - Perform RESET of the CPU
3163echo - echo args to console
3164version - print monitor version
3165help - print online help
3166? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003167
wdenkc6097192002-11-03 00:24:07 +00003168
wdenk2729af92004-05-03 20:45:30 +00003169Monitor Commands - Detailed Description:
3170========================================
wdenkc6097192002-11-03 00:24:07 +00003171
wdenk2729af92004-05-03 20:45:30 +00003172TODO.
wdenkc6097192002-11-03 00:24:07 +00003173
wdenk2729af92004-05-03 20:45:30 +00003174For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003175
3176
wdenk2729af92004-05-03 20:45:30 +00003177Environment Variables:
3178======================
wdenkc6097192002-11-03 00:24:07 +00003179
wdenk2729af92004-05-03 20:45:30 +00003180U-Boot supports user configuration using Environment Variables which
3181can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003182
wdenk2729af92004-05-03 20:45:30 +00003183Environment Variables are set using "setenv", printed using
3184"printenv", and saved to Flash using "saveenv". Using "setenv"
3185without a value can be used to delete a variable from the
3186environment. As long as you don't save the environment you are
3187working with an in-memory copy. In case the Flash area containing the
3188environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003189
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003190Some configuration options can be set using Environment Variables.
3191
3192List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003193
wdenk2729af92004-05-03 20:45:30 +00003194 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003195
wdenk2729af92004-05-03 20:45:30 +00003196 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003197
wdenk2729af92004-05-03 20:45:30 +00003198 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk2729af92004-05-03 20:45:30 +00003200 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003201
wdenk2729af92004-05-03 20:45:30 +00003202 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003203
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003204 bootm_low - Memory range available for image processing in the bootm
3205 command can be restricted. This variable is given as
3206 a hexadecimal number and defines lowest address allowed
3207 for use by the bootm command. See also "bootm_size"
3208 environment variable. Address defined by "bootm_low" is
3209 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003210 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3211 bootm_mapsize.
3212
3213 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3214 This variable is given as a hexadecimal number and it
3215 defines the size of the memory region starting at base
3216 address bootm_low that is accessible by the Linux kernel
3217 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3218 as the default value if it is defined, and bootm_size is
3219 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003220
3221 bootm_size - Memory range available for image processing in the bootm
3222 command can be restricted. This variable is given as
3223 a hexadecimal number and defines the size of the region
3224 allowed for use by the bootm command. See also "bootm_low"
3225 environment variable.
3226
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003227 updatefile - Location of the software update file on a TFTP server, used
3228 by the automatic software update feature. Please refer to
3229 documentation in doc/README.update for more details.
3230
wdenk2729af92004-05-03 20:45:30 +00003231 autoload - if set to "no" (any string beginning with 'n'),
3232 "bootp" will just load perform a lookup of the
3233 configuration from the BOOTP server, but not try to
3234 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk2729af92004-05-03 20:45:30 +00003236 autostart - if set to "yes", an image loaded using the "bootp",
3237 "rarpboot", "tftpboot" or "diskboot" commands will
3238 be automatically started (by internally calling
3239 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003240
wdenk2729af92004-05-03 20:45:30 +00003241 If set to "no", a standalone image passed to the
3242 "bootm" command will be copied to the load address
3243 (and eventually uncompressed), but NOT be started.
3244 This can be used to load and uncompress arbitrary
3245 data.
wdenkc6097192002-11-03 00:24:07 +00003246
wdenk17ea1172004-06-06 21:51:03 +00003247 i2cfast - (PPC405GP|PPC405EP only)
3248 if set to 'y' configures Linux I2C driver for fast
3249 mode (400kHZ). This environment variable is used in
3250 initialization code. So, for changes to be effective
3251 it must be saved and board must be reset.
3252
wdenk2729af92004-05-03 20:45:30 +00003253 initrd_high - restrict positioning of initrd images:
3254 If this variable is not set, initrd images will be
3255 copied to the highest possible address in RAM; this
3256 is usually what you want since it allows for
3257 maximum initrd size. If for some reason you want to
3258 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003259 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003260 variable to a value of "no" or "off" or "0".
3261 Alternatively, you can set it to a maximum upper
3262 address to use (U-Boot will still check that it
3263 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003264
wdenk2729af92004-05-03 20:45:30 +00003265 For instance, when you have a system with 16 MB
3266 RAM, and want to reserve 4 MB from use by Linux,
3267 you can do this by adding "mem=12M" to the value of
3268 the "bootargs" variable. However, now you must make
3269 sure that the initrd image is placed in the first
3270 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003271
wdenk2729af92004-05-03 20:45:30 +00003272 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003273
wdenk2729af92004-05-03 20:45:30 +00003274 If you set initrd_high to 0xFFFFFFFF, this is an
3275 indication to U-Boot that all addresses are legal
3276 for the Linux kernel, including addresses in flash
3277 memory. In this case U-Boot will NOT COPY the
3278 ramdisk at all. This may be useful to reduce the
3279 boot time on your system, but requires that this
3280 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003281
wdenk2729af92004-05-03 20:45:30 +00003282 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003283
wdenk2729af92004-05-03 20:45:30 +00003284 loadaddr - Default load address for commands like "bootp",
3285 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003286
wdenk2729af92004-05-03 20:45:30 +00003287 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003288
wdenk2729af92004-05-03 20:45:30 +00003289 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003290
wdenk2729af92004-05-03 20:45:30 +00003291 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk2729af92004-05-03 20:45:30 +00003293 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003294
wdenk2729af92004-05-03 20:45:30 +00003295 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003296
wdenk2729af92004-05-03 20:45:30 +00003297 ethprime - When CONFIG_NET_MULTI is enabled controls which
3298 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003299
wdenk2729af92004-05-03 20:45:30 +00003300 ethact - When CONFIG_NET_MULTI is enabled controls which
3301 interface is currently active. For example you
3302 can do the following
wdenkc6097192002-11-03 00:24:07 +00003303
Heiko Schocher48690d82010-07-20 17:45:02 +02003304 => setenv ethact FEC
3305 => ping 192.168.0.1 # traffic sent on FEC
3306 => setenv ethact SCC
3307 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003308
Matthias Fuchse1692572008-01-17 07:45:05 +01003309 ethrotate - When set to "no" U-Boot does not go through all
3310 available network interfaces.
3311 It just stays at the currently selected interface.
3312
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003313 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003314 either succeed or fail without retrying.
3315 When set to "once" the network operation will
3316 fail when all the available network interfaces
3317 are tried once without success.
3318 Useful on scripts which control the retry operation
3319 themselves.
wdenkc6097192002-11-03 00:24:07 +00003320
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003321 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003322
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003323 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003324 UDP source port.
3325
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003326 tftpdstport - If this is set, the value is used for TFTP's UDP
3327 destination port instead of the Well Know Port 69.
3328
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003329 tftpblocksize - Block size to use for TFTP transfers; if not set,
3330 we use the TFTP server's default block size
3331
3332 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3333 seconds, minimum value is 1000 = 1 second). Defines
3334 when a packet is considered to be lost so it has to
3335 be retransmitted. The default is 5000 = 5 seconds.
3336 Lowering this value may make downloads succeed
3337 faster in networks with high packet loss rates or
3338 with unreliable TFTP servers.
3339
3340 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003341 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003342 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003343
wdenk2729af92004-05-03 20:45:30 +00003344The following environment variables may be used and automatically
3345updated by the network boot commands ("bootp" and "rarpboot"),
3346depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003347
wdenk2729af92004-05-03 20:45:30 +00003348 bootfile - see above
3349 dnsip - IP address of your Domain Name Server
3350 dnsip2 - IP address of your secondary Domain Name Server
3351 gatewayip - IP address of the Gateway (Router) to use
3352 hostname - Target hostname
3353 ipaddr - see above
3354 netmask - Subnet Mask
3355 rootpath - Pathname of the root filesystem on the NFS server
3356 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003357
wdenka3d991b2004-04-15 21:48:45 +00003358
wdenk2729af92004-05-03 20:45:30 +00003359There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003360
wdenk2729af92004-05-03 20:45:30 +00003361 serial# - contains hardware identification information such
3362 as type string and/or serial number
3363 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003364
wdenk2729af92004-05-03 20:45:30 +00003365These variables can be set only once (usually during manufacturing of
3366the board). U-Boot refuses to delete or overwrite these variables
3367once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003368
3369
wdenk2729af92004-05-03 20:45:30 +00003370Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003371
wdenk2729af92004-05-03 20:45:30 +00003372 ver - Contains the U-Boot version string as printed
3373 with the "version" command. This variable is
3374 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003375
wdenkc6097192002-11-03 00:24:07 +00003376
wdenk2729af92004-05-03 20:45:30 +00003377Please note that changes to some configuration parameters may take
3378only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003379
stroesec1551ea2003-04-04 15:53:41 +00003380
wdenk2729af92004-05-03 20:45:30 +00003381Command Line Parsing:
3382=====================
stroesec1551ea2003-04-04 15:53:41 +00003383
wdenk2729af92004-05-03 20:45:30 +00003384There are two different command line parsers available with U-Boot:
3385the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003386
wdenk2729af92004-05-03 20:45:30 +00003387Old, simple command line parser:
3388--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003389
wdenk2729af92004-05-03 20:45:30 +00003390- supports environment variables (through setenv / saveenv commands)
3391- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003392- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003393- special characters ('$', ';') can be escaped by prefixing with '\',
3394 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003395 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003396- You can also escape text by enclosing in single apostrophes, for example:
3397 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003398
wdenk2729af92004-05-03 20:45:30 +00003399Hush shell:
3400-----------
wdenkf07771c2003-05-28 08:06:31 +00003401
wdenk2729af92004-05-03 20:45:30 +00003402- similar to Bourne shell, with control structures like
3403 if...then...else...fi, for...do...done; while...do...done,
3404 until...do...done, ...
3405- supports environment ("global") variables (through setenv / saveenv
3406 commands) and local shell variables (through standard shell syntax
3407 "name=value"); only environment variables can be used with "run"
3408 command
wdenkf07771c2003-05-28 08:06:31 +00003409
wdenk2729af92004-05-03 20:45:30 +00003410General rules:
3411--------------
wdenkf07771c2003-05-28 08:06:31 +00003412
wdenk2729af92004-05-03 20:45:30 +00003413(1) If a command line (or an environment variable executed by a "run"
3414 command) contains several commands separated by semicolon, and
3415 one of these commands fails, then the remaining commands will be
3416 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003417
wdenk2729af92004-05-03 20:45:30 +00003418(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003419 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003420 command will cause "run" to terminate, i. e. the remaining
3421 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003422
wdenk2729af92004-05-03 20:45:30 +00003423Note for Redundant Ethernet Interfaces:
3424=======================================
wdenkf07771c2003-05-28 08:06:31 +00003425
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003426Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003427such configurations and is capable of automatic selection of a
3428"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003429
wdenk2729af92004-05-03 20:45:30 +00003430Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3431MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3432"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003433
wdenk2729af92004-05-03 20:45:30 +00003434If the network interface stores some valid MAC address (for instance
3435in SROM), this is used as default address if there is NO correspon-
3436ding setting in the environment; if the corresponding environment
3437variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003438
wdenk2729af92004-05-03 20:45:30 +00003439o If the SROM has a valid MAC address, and there is no address in the
3440 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003441
wdenk2729af92004-05-03 20:45:30 +00003442o If there is no valid address in the SROM, and a definition in the
3443 environment exists, then the value from the environment variable is
3444 used.
wdenkc6097192002-11-03 00:24:07 +00003445
wdenk2729af92004-05-03 20:45:30 +00003446o If both the SROM and the environment contain a MAC address, and
3447 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003448
wdenk2729af92004-05-03 20:45:30 +00003449o If both the SROM and the environment contain a MAC address, and the
3450 addresses differ, the value from the environment is used and a
3451 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003452
wdenk2729af92004-05-03 20:45:30 +00003453o If neither SROM nor the environment contain a MAC address, an error
3454 is raised.
wdenkc6097192002-11-03 00:24:07 +00003455
Ben Warrenecee9322010-04-26 11:11:46 -07003456If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3457will be programmed into hardware as part of the initialization process. This
3458may be skipped by setting the appropriate 'ethmacskip' environment variable.
3459The naming convention is as follows:
3460"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003461
wdenk2729af92004-05-03 20:45:30 +00003462Image Formats:
3463==============
wdenkc6097192002-11-03 00:24:07 +00003464
Marian Balakowicz3310c542008-03-12 12:13:13 +01003465U-Boot is capable of booting (and performing other auxiliary operations on)
3466images in two formats:
3467
3468New uImage format (FIT)
3469-----------------------
3470
3471Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3472to Flattened Device Tree). It allows the use of images with multiple
3473components (several kernels, ramdisks, etc.), with contents protected by
3474SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3475
3476
3477Old uImage format
3478-----------------
3479
3480Old image format is based on binary files which can be basically anything,
3481preceded by a special header; see the definitions in include/image.h for
3482details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3485 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003486 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3487 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3488 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003489* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003490 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3491 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003492* Compression Type (uncompressed, gzip, bzip2)
3493* Load Address
3494* Entry Point
3495* Image Name
3496* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003497
wdenk2729af92004-05-03 20:45:30 +00003498The header is marked by a special Magic Number, and both the header
3499and the data portions of the image are secured against corruption by
3500CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003501
wdenkc6097192002-11-03 00:24:07 +00003502
wdenk2729af92004-05-03 20:45:30 +00003503Linux Support:
3504==============
wdenkc6097192002-11-03 00:24:07 +00003505
wdenk2729af92004-05-03 20:45:30 +00003506Although U-Boot should support any OS or standalone application
3507easily, the main focus has always been on Linux during the design of
3508U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510U-Boot includes many features that so far have been part of some
3511special "boot loader" code within the Linux kernel. Also, any
3512"initrd" images to be used are no longer part of one big Linux image;
3513instead, kernel and "initrd" are separate images. This implementation
3514serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003515
wdenk2729af92004-05-03 20:45:30 +00003516- the same features can be used for other OS or standalone
3517 applications (for instance: using compressed images to reduce the
3518 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003519
wdenk2729af92004-05-03 20:45:30 +00003520- it becomes much easier to port new Linux kernel versions because
3521 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003522
wdenk2729af92004-05-03 20:45:30 +00003523- the same Linux kernel image can now be used with different "initrd"
3524 images; of course this also means that different kernel images can
3525 be run with the same "initrd". This makes testing easier (you don't
3526 have to build a new "zImage.initrd" Linux image when you just
3527 change a file in your "initrd"). Also, a field-upgrade of the
3528 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003529
wdenkc6097192002-11-03 00:24:07 +00003530
wdenk2729af92004-05-03 20:45:30 +00003531Linux HOWTO:
3532============
wdenkc6097192002-11-03 00:24:07 +00003533
wdenk2729af92004-05-03 20:45:30 +00003534Porting Linux to U-Boot based systems:
3535---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003536
wdenk2729af92004-05-03 20:45:30 +00003537U-Boot cannot save you from doing all the necessary modifications to
3538configure the Linux device drivers for use with your target hardware
3539(no, we don't intend to provide a full virtual machine interface to
3540Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003541
Stefan Roesea47a12b2010-04-15 16:07:28 +02003542But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003543
wdenk2729af92004-05-03 20:45:30 +00003544Just make sure your machine specific header file (for instance
3545include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003546Information structure as we define in include/asm-<arch>/u-boot.h,
3547and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003548as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003549
wdenkc6097192002-11-03 00:24:07 +00003550
wdenk2729af92004-05-03 20:45:30 +00003551Configuring the Linux kernel:
3552-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003553
wdenk2729af92004-05-03 20:45:30 +00003554No specific requirements for U-Boot. Make sure you have some root
3555device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003556
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk2729af92004-05-03 20:45:30 +00003558Building a Linux Image:
3559-----------------------
wdenkc6097192002-11-03 00:24:07 +00003560
wdenk2729af92004-05-03 20:45:30 +00003561With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3562not used. If you use recent kernel source, a new build target
3563"uImage" will exist which automatically builds an image usable by
3564U-Boot. Most older kernels also have support for a "pImage" target,
3565which was introduced for our predecessor project PPCBoot and uses a
3566100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003567
wdenk2729af92004-05-03 20:45:30 +00003568Example:
wdenkc6097192002-11-03 00:24:07 +00003569
wdenk2729af92004-05-03 20:45:30 +00003570 make TQM850L_config
3571 make oldconfig
3572 make dep
3573 make uImage
wdenkc6097192002-11-03 00:24:07 +00003574
wdenk2729af92004-05-03 20:45:30 +00003575The "uImage" build target uses a special tool (in 'tools/mkimage') to
3576encapsulate a compressed Linux kernel image with header information,
3577CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003578
wdenk2729af92004-05-03 20:45:30 +00003579* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003580
wdenk2729af92004-05-03 20:45:30 +00003581* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003582
wdenk2729af92004-05-03 20:45:30 +00003583 ${CROSS_COMPILE}-objcopy -O binary \
3584 -R .note -R .comment \
3585 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk2729af92004-05-03 20:45:30 +00003587* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003592
wdenk2729af92004-05-03 20:45:30 +00003593 mkimage -A ppc -O linux -T kernel -C gzip \
3594 -a 0 -e 0 -n "Linux Kernel Image" \
3595 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003596
wdenk24ee89b2002-11-03 17:56:27 +00003597
wdenk2729af92004-05-03 20:45:30 +00003598The "mkimage" tool can also be used to create ramdisk images for use
3599with U-Boot, either separated from the Linux kernel image, or
3600combined into one file. "mkimage" encapsulates the images with a 64
3601byte header containing information about target architecture,
3602operating system, image type, compression method, entry points, time
3603stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003604
wdenk2729af92004-05-03 20:45:30 +00003605"mkimage" can be called in two ways: to verify existing images and
3606print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003607
wdenk2729af92004-05-03 20:45:30 +00003608In the first form (with "-l" option) mkimage lists the information
3609contained in the header of an existing U-Boot image; this includes
3610checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003611
wdenk2729af92004-05-03 20:45:30 +00003612 tools/mkimage -l image
3613 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003614
wdenk2729af92004-05-03 20:45:30 +00003615The second form (with "-d" option) is used to build a U-Boot image
3616from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003617
wdenk2729af92004-05-03 20:45:30 +00003618 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3619 -n name -d data_file image
3620 -A ==> set architecture to 'arch'
3621 -O ==> set operating system to 'os'
3622 -T ==> set image type to 'type'
3623 -C ==> set compression type 'comp'
3624 -a ==> set load address to 'addr' (hex)
3625 -e ==> set entry point to 'ep' (hex)
3626 -n ==> set image name to 'name'
3627 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003628
wdenk69459792004-05-29 16:53:29 +00003629Right now, all Linux kernels for PowerPC systems use the same load
3630address (0x00000000), but the entry point address depends on the
3631kernel version:
wdenkc6097192002-11-03 00:24:07 +00003632
wdenk2729af92004-05-03 20:45:30 +00003633- 2.2.x kernels have the entry point at 0x0000000C,
3634- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003635
wdenk2729af92004-05-03 20:45:30 +00003636So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003637
wdenk2729af92004-05-03 20:45:30 +00003638 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3639 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003640 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003641 > examples/uImage.TQM850L
3642 Image Name: 2.4.4 kernel for TQM850L
3643 Created: Wed Jul 19 02:34:59 2000
3644 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3645 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3646 Load Address: 0x00000000
3647 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003648
wdenk2729af92004-05-03 20:45:30 +00003649To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003650
wdenk2729af92004-05-03 20:45:30 +00003651 -> tools/mkimage -l examples/uImage.TQM850L
3652 Image Name: 2.4.4 kernel for TQM850L
3653 Created: Wed Jul 19 02:34:59 2000
3654 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3655 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3656 Load Address: 0x00000000
3657 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659NOTE: for embedded systems where boot time is critical you can trade
3660speed for memory and install an UNCOMPRESSED image instead: this
3661needs more space in Flash, but boots much faster since it does not
3662need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003663
Stefan Roesea47a12b2010-04-15 16:07:28 +02003664 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003665 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3666 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003667 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003668 > examples/uImage.TQM850L-uncompressed
3669 Image Name: 2.4.4 kernel for TQM850L
3670 Created: Wed Jul 19 02:34:59 2000
3671 Image Type: PowerPC Linux Kernel Image (uncompressed)
3672 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3673 Load Address: 0x00000000
3674 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003675
wdenkc6097192002-11-03 00:24:07 +00003676
wdenk2729af92004-05-03 20:45:30 +00003677Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3678when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003679
wdenk2729af92004-05-03 20:45:30 +00003680 -> tools/mkimage -n 'Simple Ramdisk Image' \
3681 > -A ppc -O linux -T ramdisk -C gzip \
3682 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3683 Image Name: Simple Ramdisk Image
3684 Created: Wed Jan 12 14:01:50 2000
3685 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3686 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3687 Load Address: 0x00000000
3688 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003689
wdenkdb01a2e2004-04-15 23:14:49 +00003690
wdenk2729af92004-05-03 20:45:30 +00003691Installing a Linux Image:
3692-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003693
wdenk2729af92004-05-03 20:45:30 +00003694To downloading a U-Boot image over the serial (console) interface,
3695you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003698
wdenk2729af92004-05-03 20:45:30 +00003699The 'objcopy' does not understand the information in the U-Boot
3700image header, so the resulting S-Record file will be relative to
3701address 0x00000000. To load it to a given address, you need to
3702specify the target address as 'offset' parameter with the 'loads'
3703command.
wdenkc6097192002-11-03 00:24:07 +00003704
wdenk2729af92004-05-03 20:45:30 +00003705Example: install the image to address 0x40100000 (which on the
3706TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003707
wdenk2729af92004-05-03 20:45:30 +00003708 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003709
wdenk2729af92004-05-03 20:45:30 +00003710 .......... done
3711 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk2729af92004-05-03 20:45:30 +00003713 => loads 40100000
3714 ## Ready for S-Record download ...
3715 ~>examples/image.srec
3716 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3717 ...
3718 15989 15990 15991 15992
3719 [file transfer complete]
3720 [connected]
3721 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003722
3723
wdenk2729af92004-05-03 20:45:30 +00003724You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003725this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003726corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk2729af92004-05-03 20:45:30 +00003728 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003729
wdenk2729af92004-05-03 20:45:30 +00003730 ## Checking Image at 40100000 ...
3731 Image Name: 2.2.13 for initrd on TQM850L
3732 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3733 Data Size: 335725 Bytes = 327 kB = 0 MB
3734 Load Address: 00000000
3735 Entry Point: 0000000c
3736 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003737
3738
wdenk2729af92004-05-03 20:45:30 +00003739Boot Linux:
3740-----------
wdenkc6097192002-11-03 00:24:07 +00003741
wdenk2729af92004-05-03 20:45:30 +00003742The "bootm" command is used to boot an application that is stored in
3743memory (RAM or Flash). In case of a Linux kernel image, the contents
3744of the "bootargs" environment variable is passed to the kernel as
3745parameters. You can check and modify this variable using the
3746"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003747
3748
wdenk2729af92004-05-03 20:45:30 +00003749 => printenv bootargs
3750 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003751
wdenk2729af92004-05-03 20:45:30 +00003752 => 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 +00003753
wdenk2729af92004-05-03 20:45:30 +00003754 => printenv bootargs
3755 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 +00003756
wdenk2729af92004-05-03 20:45:30 +00003757 => bootm 40020000
3758 ## Booting Linux kernel at 40020000 ...
3759 Image Name: 2.2.13 for NFS on TQM850L
3760 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3761 Data Size: 381681 Bytes = 372 kB = 0 MB
3762 Load Address: 00000000
3763 Entry Point: 0000000c
3764 Verifying Checksum ... OK
3765 Uncompressing Kernel Image ... OK
3766 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
3767 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3768 time_init: decrementer frequency = 187500000/60
3769 Calibrating delay loop... 49.77 BogoMIPS
3770 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3771 ...
wdenkc6097192002-11-03 00:24:07 +00003772
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003773If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003774the memory addresses of both the kernel and the initrd image (PPBCOOT
3775format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003776
wdenk2729af92004-05-03 20:45:30 +00003777 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003778
wdenk2729af92004-05-03 20:45:30 +00003779 ## Checking Image at 40100000 ...
3780 Image Name: 2.2.13 for initrd on TQM850L
3781 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3782 Data Size: 335725 Bytes = 327 kB = 0 MB
3783 Load Address: 00000000
3784 Entry Point: 0000000c
3785 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003786
wdenk2729af92004-05-03 20:45:30 +00003787 ## Checking Image at 40200000 ...
3788 Image Name: Simple Ramdisk Image
3789 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3790 Data Size: 566530 Bytes = 553 kB = 0 MB
3791 Load Address: 00000000
3792 Entry Point: 00000000
3793 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003794
wdenk2729af92004-05-03 20:45:30 +00003795 => bootm 40100000 40200000
3796 ## Booting Linux kernel at 40100000 ...
3797 Image Name: 2.2.13 for initrd on TQM850L
3798 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3799 Data Size: 335725 Bytes = 327 kB = 0 MB
3800 Load Address: 00000000
3801 Entry Point: 0000000c
3802 Verifying Checksum ... OK
3803 Uncompressing Kernel Image ... OK
3804 ## Loading RAMDisk Image at 40200000 ...
3805 Image Name: Simple Ramdisk Image
3806 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3807 Data Size: 566530 Bytes = 553 kB = 0 MB
3808 Load Address: 00000000
3809 Entry Point: 00000000
3810 Verifying Checksum ... OK
3811 Loading Ramdisk ... OK
3812 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
3813 Boot arguments: root=/dev/ram
3814 time_init: decrementer frequency = 187500000/60
3815 Calibrating delay loop... 49.77 BogoMIPS
3816 ...
3817 RAMDISK: Compressed image found at block 0
3818 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003819
wdenk2729af92004-05-03 20:45:30 +00003820 bash#
wdenkc6097192002-11-03 00:24:07 +00003821
Matthew McClintock02677682006-06-28 10:41:37 -05003822Boot Linux and pass a flat device tree:
3823-----------
3824
3825First, U-Boot must be compiled with the appropriate defines. See the section
3826titled "Linux Kernel Interface" above for a more in depth explanation. The
3827following is an example of how to start a kernel and pass an updated
3828flat device tree:
3829
3830=> print oftaddr
3831oftaddr=0x300000
3832=> print oft
3833oft=oftrees/mpc8540ads.dtb
3834=> tftp $oftaddr $oft
3835Speed: 1000, full duplex
3836Using TSEC0 device
3837TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3838Filename 'oftrees/mpc8540ads.dtb'.
3839Load address: 0x300000
3840Loading: #
3841done
3842Bytes transferred = 4106 (100a hex)
3843=> tftp $loadaddr $bootfile
3844Speed: 1000, full duplex
3845Using TSEC0 device
3846TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3847Filename 'uImage'.
3848Load address: 0x200000
3849Loading:############
3850done
3851Bytes transferred = 1029407 (fb51f hex)
3852=> print loadaddr
3853loadaddr=200000
3854=> print oftaddr
3855oftaddr=0x300000
3856=> bootm $loadaddr - $oftaddr
3857## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003858 Image Name: Linux-2.6.17-dirty
3859 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3860 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003861 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003862 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003863 Verifying Checksum ... OK
3864 Uncompressing Kernel Image ... OK
3865Booting using flat device tree at 0x300000
3866Using MPC85xx ADS machine description
3867Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3868[snip]
3869
3870
wdenk2729af92004-05-03 20:45:30 +00003871More About U-Boot Image Types:
3872------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003875
wdenk2729af92004-05-03 20:45:30 +00003876 "Standalone Programs" are directly runnable in the environment
3877 provided by U-Boot; it is expected that (if they behave
3878 well) you can continue to work in U-Boot after return from
3879 the Standalone Program.
3880 "OS Kernel Images" are usually images of some Embedded OS which
3881 will take over control completely. Usually these programs
3882 will install their own set of exception handlers, device
3883 drivers, set up the MMU, etc. - this means, that you cannot
3884 expect to re-enter U-Boot except by resetting the CPU.
3885 "RAMDisk Images" are more or less just data blocks, and their
3886 parameters (address, size) are passed to an OS kernel that is
3887 being started.
3888 "Multi-File Images" contain several images, typically an OS
3889 (Linux) kernel image and one or more data images like
3890 RAMDisks. This construct is useful for instance when you want
3891 to boot over the network using BOOTP etc., where the boot
3892 server provides just a single image file, but you want to get
3893 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003894
wdenk2729af92004-05-03 20:45:30 +00003895 "Multi-File Images" start with a list of image sizes, each
3896 image size (in bytes) specified by an "uint32_t" in network
3897 byte order. This list is terminated by an "(uint32_t)0".
3898 Immediately after the terminating 0 follow the images, one by
3899 one, all aligned on "uint32_t" boundaries (size rounded up to
3900 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003901
wdenk2729af92004-05-03 20:45:30 +00003902 "Firmware Images" are binary images containing firmware (like
3903 U-Boot or FPGA images) which usually will be programmed to
3904 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003905
wdenk2729af92004-05-03 20:45:30 +00003906 "Script files" are command sequences that will be executed by
3907 U-Boot's command interpreter; this feature is especially
3908 useful when you configure U-Boot to use a real shell (hush)
3909 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003910
wdenkc6097192002-11-03 00:24:07 +00003911
wdenk2729af92004-05-03 20:45:30 +00003912Standalone HOWTO:
3913=================
wdenkc6097192002-11-03 00:24:07 +00003914
wdenk2729af92004-05-03 20:45:30 +00003915One of the features of U-Boot is that you can dynamically load and
3916run "standalone" applications, which can use some resources of
3917U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003918
wdenk2729af92004-05-03 20:45:30 +00003919Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003920
wdenk2729af92004-05-03 20:45:30 +00003921"Hello World" Demo:
3922-------------------
wdenkc6097192002-11-03 00:24:07 +00003923
wdenk2729af92004-05-03 20:45:30 +00003924'examples/hello_world.c' contains a small "Hello World" Demo
3925application; it is automatically compiled when you build U-Boot.
3926It's configured to run at address 0x00040004, so you can play with it
3927like that:
wdenkc6097192002-11-03 00:24:07 +00003928
wdenk2729af92004-05-03 20:45:30 +00003929 => loads
3930 ## Ready for S-Record download ...
3931 ~>examples/hello_world.srec
3932 1 2 3 4 5 6 7 8 9 10 11 ...
3933 [file transfer complete]
3934 [connected]
3935 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937 => go 40004 Hello World! This is a test.
3938 ## Starting application at 0x00040004 ...
3939 Hello World
3940 argc = 7
3941 argv[0] = "40004"
3942 argv[1] = "Hello"
3943 argv[2] = "World!"
3944 argv[3] = "This"
3945 argv[4] = "is"
3946 argv[5] = "a"
3947 argv[6] = "test."
3948 argv[7] = "<NULL>"
3949 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003952
wdenk2729af92004-05-03 20:45:30 +00003953Another example, which demonstrates how to register a CPM interrupt
3954handler with the U-Boot code, can be found in 'examples/timer.c'.
3955Here, a CPM timer is set up to generate an interrupt every second.
3956The interrupt service routine is trivial, just printing a '.'
3957character, but this is just a demo program. The application can be
3958controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003959
wdenk2729af92004-05-03 20:45:30 +00003960 ? - print current values og the CPM Timer registers
3961 b - enable interrupts and start timer
3962 e - stop timer and disable interrupts
3963 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk2729af92004-05-03 20:45:30 +00003965 => loads
3966 ## Ready for S-Record download ...
3967 ~>examples/timer.srec
3968 1 2 3 4 5 6 7 8 9 10 11 ...
3969 [file transfer complete]
3970 [connected]
3971 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973 => go 40004
3974 ## Starting application at 0x00040004 ...
3975 TIMERS=0xfff00980
3976 Using timer 1
3977 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003978
wdenk2729af92004-05-03 20:45:30 +00003979Hit 'b':
3980 [q, b, e, ?] Set interval 1000000 us
3981 Enabling timer
3982Hit '?':
3983 [q, b, e, ?] ........
3984 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3985Hit '?':
3986 [q, b, e, ?] .
3987 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3988Hit '?':
3989 [q, b, e, ?] .
3990 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3991Hit '?':
3992 [q, b, e, ?] .
3993 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3994Hit 'e':
3995 [q, b, e, ?] ...Stopping timer
3996Hit 'q':
3997 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003998
3999
wdenk2729af92004-05-03 20:45:30 +00004000Minicom warning:
4001================
wdenk85ec0bc2003-03-31 16:34:49 +00004002
wdenk2729af92004-05-03 20:45:30 +00004003Over time, many people have reported problems when trying to use the
4004"minicom" terminal emulation program for serial download. I (wd)
4005consider minicom to be broken, and recommend not to use it. Under
4006Unix, I recommend to use C-Kermit for general purpose use (and
4007especially for kermit binary protocol download ("loadb" command), and
4008use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004009
wdenk2729af92004-05-03 20:45:30 +00004010Nevertheless, if you absolutely want to use it try adding this
4011configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004012
wdenk2729af92004-05-03 20:45:30 +00004013 Name Program Name U/D FullScr IO-Red. Multi
4014 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4015 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004016
4017
wdenk2729af92004-05-03 20:45:30 +00004018NetBSD Notes:
4019=============
wdenkc6097192002-11-03 00:24:07 +00004020
wdenk2729af92004-05-03 20:45:30 +00004021Starting at version 0.9.2, U-Boot supports NetBSD both as host
4022(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk2729af92004-05-03 20:45:30 +00004024Building requires a cross environment; it is known to work on
4025NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4026need gmake since the Makefiles are not compatible with BSD make).
4027Note that the cross-powerpc package does not install include files;
4028attempting to build U-Boot will fail because <machine/ansi.h> is
4029missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004030
wdenk2729af92004-05-03 20:45:30 +00004031 # cd /usr/pkg/cross/powerpc-netbsd/include
4032 # mkdir powerpc
4033 # ln -s powerpc machine
4034 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4035 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004036
wdenk2729af92004-05-03 20:45:30 +00004037Native builds *don't* work due to incompatibilities between native
4038and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004039
wdenk2729af92004-05-03 20:45:30 +00004040Booting assumes that (the first part of) the image booted is a
4041stage-2 loader which in turn loads and then invokes the kernel
4042proper. Loader sources will eventually appear in the NetBSD source
4043tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004044meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004045
4046
wdenk2729af92004-05-03 20:45:30 +00004047Implementation Internals:
4048=========================
wdenkc6097192002-11-03 00:24:07 +00004049
wdenk2729af92004-05-03 20:45:30 +00004050The following is not intended to be a complete description of every
4051implementation detail. However, it should help to understand the
4052inner workings of U-Boot and make it easier to port it to custom
4053hardware.
wdenkc6097192002-11-03 00:24:07 +00004054
4055
wdenk2729af92004-05-03 20:45:30 +00004056Initial Stack, Global Data:
4057---------------------------
wdenkc6097192002-11-03 00:24:07 +00004058
wdenk2729af92004-05-03 20:45:30 +00004059The implementation of U-Boot is complicated by the fact that U-Boot
4060starts running out of ROM (flash memory), usually without access to
4061system RAM (because the memory controller is not initialized yet).
4062This means that we don't have writable Data or BSS segments, and BSS
4063is not initialized as zero. To be able to get a C environment working
4064at all, we have to allocate at least a minimal stack. Implementation
4065options for this are defined and restricted by the CPU used: Some CPU
4066models provide on-chip memory (like the IMMR area on MPC8xx and
4067MPC826x processors), on others (parts of) the data cache can be
4068locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004069
Wolfgang Denk218ca722008-03-26 10:40:12 +01004070 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004071 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004072
wdenk2729af92004-05-03 20:45:30 +00004073 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4074 From: "Chris Hallinan" <clh@net1plus.com>
4075 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4076 ...
wdenk43d96162003-03-06 00:02:04 +00004077
wdenk2729af92004-05-03 20:45:30 +00004078 Correct me if I'm wrong, folks, but the way I understand it
4079 is this: Using DCACHE as initial RAM for Stack, etc, does not
4080 require any physical RAM backing up the cache. The cleverness
4081 is that the cache is being used as a temporary supply of
4082 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004083 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004084 can see how this works by studying the cache architecture and
4085 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4088 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004089 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004090 option should work for you. Using CS 4 should be fine if your
4091 board designers haven't used it for something that would
4092 cause you grief during the initial boot! It is frequently not
4093 used.
wdenk43d96162003-03-06 00:02:04 +00004094
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004095 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004096 with your processor/board/system design. The default value
4097 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004098 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004099 than your SDRAM module. If you have a 64MB SDRAM module, set
4100 it above 400_0000. Just make sure your board has no resources
4101 that are supposed to respond to that address! That code in
4102 start.S has been around a while and should work as is when
4103 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004104
wdenk2729af92004-05-03 20:45:30 +00004105 -Chris Hallinan
4106 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108It is essential to remember this, since it has some impact on the C
4109code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004110
wdenk2729af92004-05-03 20:45:30 +00004111* Initialized global data (data segment) is read-only. Do not attempt
4112 to write it.
wdenkc6097192002-11-03 00:24:07 +00004113
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004114* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004115 as zero data - BSS segment) at all - this is undefined, initiali-
4116 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk2729af92004-05-03 20:45:30 +00004118* Stack space is very limited. Avoid big data buffers or things like
4119 that.
wdenkc6097192002-11-03 00:24:07 +00004120
wdenk2729af92004-05-03 20:45:30 +00004121Having only the stack as writable memory limits means we cannot use
4122normal global data to share information beween the code. But it
4123turned out that the implementation of U-Boot can be greatly
4124simplified by making a global data structure (gd_t) available to all
4125functions. We could pass a pointer to this data as argument to _all_
4126functions, but this would bloat the code. Instead we use a feature of
4127the GCC compiler (Global Register Variables) to share the data: we
4128place a pointer (gd) to the global data into a register which we
4129reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131When choosing a register for such a purpose we are restricted by the
4132relevant (E)ABI specifications for the current architecture, and by
4133GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004134
wdenk2729af92004-05-03 20:45:30 +00004135For PowerPC, the following registers have specific use:
4136 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004137 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004138 R3-R4: parameter passing and return values
4139 R5-R10: parameter passing
4140 R13: small data area pointer
4141 R30: GOT pointer
4142 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004143
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004144 (U-Boot also uses R12 as internal GOT pointer. r12
4145 is a volatile register so r12 needs to be reset when
4146 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004147
Wolfgang Denke7670f62008-02-14 22:43:22 +01004148 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004149
wdenk2729af92004-05-03 20:45:30 +00004150 Note: on PPC, we could use a static initializer (since the
4151 address of the global data structure is known at compile time),
4152 but it turned out that reserving a register results in somewhat
4153 smaller code - although the code savings are not that big (on
4154 average for all boards 752 bytes for the whole U-Boot image,
4155 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004156
Robin Getzc4db3352009-08-17 15:23:02 +00004157On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004158 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4159
Robin Getzc4db3352009-08-17 15:23:02 +00004160 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004161
wdenk2729af92004-05-03 20:45:30 +00004162On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004163
wdenk2729af92004-05-03 20:45:30 +00004164 R0: function argument word/integer result
4165 R1-R3: function argument word
4166 R9: GOT pointer
4167 R10: stack limit (used only if stack checking if enabled)
4168 R11: argument (frame) pointer
4169 R12: temporary workspace
4170 R13: stack pointer
4171 R14: link register
4172 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004173
wdenk2729af92004-05-03 20:45:30 +00004174 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004175
Thomas Chou0df01fd2010-05-21 11:08:03 +08004176On Nios II, the ABI is documented here:
4177 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4178
4179 ==> U-Boot will use gp to hold a pointer to the global data
4180
4181 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4182 to access small data sections, so gp is free.
4183
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004184NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4185or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004186
wdenk2729af92004-05-03 20:45:30 +00004187Memory Management:
4188------------------
wdenkc6097192002-11-03 00:24:07 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190U-Boot runs in system state and uses physical addresses, i.e. the
4191MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004192
wdenk2729af92004-05-03 20:45:30 +00004193The available memory is mapped to fixed addresses using the memory
4194controller. In this process, a contiguous block is formed for each
4195memory type (Flash, SDRAM, SRAM), even when it consists of several
4196physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004197
wdenk2729af92004-05-03 20:45:30 +00004198U-Boot is installed in the first 128 kB of the first Flash bank (on
4199TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4200booting and sizing and initializing DRAM, the code relocates itself
4201to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004202memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004203configuration setting]. Below that, a structure with global Board
4204Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk2729af92004-05-03 20:45:30 +00004206Additionally, some exception handler code is copied to the low 8 kB
4207of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004208
wdenk2729af92004-05-03 20:45:30 +00004209So a typical memory configuration with 16 MB of DRAM could look like
4210this:
wdenkc6097192002-11-03 00:24:07 +00004211
wdenk2729af92004-05-03 20:45:30 +00004212 0x0000 0000 Exception Vector code
4213 :
4214 0x0000 1FFF
4215 0x0000 2000 Free for Application Use
4216 :
4217 :
wdenkc6097192002-11-03 00:24:07 +00004218
wdenk2729af92004-05-03 20:45:30 +00004219 :
4220 :
4221 0x00FB FF20 Monitor Stack (Growing downward)
4222 0x00FB FFAC Board Info Data and permanent copy of global data
4223 0x00FC 0000 Malloc Arena
4224 :
4225 0x00FD FFFF
4226 0x00FE 0000 RAM Copy of Monitor Code
4227 ... eventually: LCD or video framebuffer
4228 ... eventually: pRAM (Protected RAM - unchanged by reset)
4229 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004230
4231
wdenk2729af92004-05-03 20:45:30 +00004232System Initialization:
4233----------------------
wdenkc6097192002-11-03 00:24:07 +00004234
wdenk2729af92004-05-03 20:45:30 +00004235In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004236(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004237configuration for CS0# this is a mirror of the onboard Flash memory.
4238To be able to re-map memory U-Boot then jumps to its link address.
4239To be able to implement the initialization code in C, a (small!)
4240initial stack is set up in the internal Dual Ported RAM (in case CPUs
4241which provide such a feature like MPC8xx or MPC8260), or in a locked
4242part of the data cache. After that, U-Boot initializes the CPU core,
4243the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004244
wdenk2729af92004-05-03 20:45:30 +00004245Next, all (potentially) available memory banks are mapped using a
4246preliminary mapping. For example, we put them on 512 MB boundaries
4247(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4248on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4249programmed for SDRAM access. Using the temporary configuration, a
4250simple memory test is run that determines the size of the SDRAM
4251banks.
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253When there is more than one SDRAM bank, and the banks are of
4254different size, the largest is mapped first. For equal size, the first
4255bank (CS2#) is mapped first. The first mapping is always for address
42560x00000000, with any additional banks following immediately to create
4257contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004258
wdenk2729af92004-05-03 20:45:30 +00004259Then, the monitor installs itself at the upper end of the SDRAM area
4260and allocates memory for use by malloc() and for the global Board
4261Info data; also, the exception vector code is copied to the low RAM
4262pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264Only after this relocation will you have a "normal" C environment;
4265until that you are restricted in several ways, mostly because you are
4266running from ROM, and because the code will have to be relocated to a
4267new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004268
4269
wdenk2729af92004-05-03 20:45:30 +00004270U-Boot Porting Guide:
4271----------------------
wdenkc6097192002-11-03 00:24:07 +00004272
wdenk2729af92004-05-03 20:45:30 +00004273[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4274list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004275
4276
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004277int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004278{
4279 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004280
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004281 signal(SIGALRM, no_more_time);
4282 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004283
wdenk2729af92004-05-03 20:45:30 +00004284 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004285 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004286 return 0;
4287 }
4288
wdenk2729af92004-05-03 20:45:30 +00004289 Download latest U-Boot source;
4290
Wolfgang Denk06682362008-12-30 22:56:11 +01004291 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004292
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004293 if (clueless)
4294 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004295
wdenk2729af92004-05-03 20:45:30 +00004296 while (learning) {
4297 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004298 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4299 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004300 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004301 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004302 }
wdenkc6097192002-11-03 00:24:07 +00004303
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004304 if (available_money > toLocalCurrency ($2500))
4305 Buy a BDI3000;
4306 else
wdenk2729af92004-05-03 20:45:30 +00004307 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004308
4309 if (a similar board exists) { /* hopefully... */
4310 cp -a board/<similar> board/<myboard>
4311 cp include/configs/<similar>.h include/configs/<myboard>.h
4312 } else {
4313 Create your own board support subdirectory;
4314 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004315 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004316 Edit new board/<myboard> files
4317 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004318
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004319 while (!accepted) {
4320 while (!running) {
4321 do {
4322 Add / modify source code;
4323 } until (compiles);
4324 Debug;
4325 if (clueless)
4326 email("Hi, I am having problems...");
4327 }
4328 Send patch file to the U-Boot email list;
4329 if (reasonable critiques)
4330 Incorporate improvements from email list code review;
4331 else
4332 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004333 }
wdenkc6097192002-11-03 00:24:07 +00004334
wdenk2729af92004-05-03 20:45:30 +00004335 return 0;
4336}
4337
4338void no_more_time (int sig)
4339{
4340 hire_a_guru();
4341}
wdenkc6097192002-11-03 00:24:07 +00004342
4343
wdenk2729af92004-05-03 20:45:30 +00004344Coding Standards:
4345-----------------
wdenkc6097192002-11-03 00:24:07 +00004346
wdenk2729af92004-05-03 20:45:30 +00004347All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004348coding style; see the file "Documentation/CodingStyle" and the script
4349"scripts/Lindent" in your Linux kernel source directory. In sources
4350originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4351spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004352
Detlev Zundel2c051652006-09-01 15:39:02 +02004353Source files originating from a different project (for example the
4354MTD subsystem) are generally exempt from these guidelines and are not
4355reformated to ease subsequent migration to newer versions of those
4356sources.
4357
4358Please note that U-Boot is implemented in C (and to some small parts in
4359Assembler); no C++ is used, so please do not use C++ style comments (//)
4360in your code.
wdenk2729af92004-05-03 20:45:30 +00004361
4362Please also stick to the following formatting rules:
4363- remove any trailing white space
4364- use TAB characters for indentation, not spaces
4365- make sure NOT to use DOS '\r\n' line feeds
4366- do not add more than 2 empty lines to source files
4367- do not add trailing empty lines to source files
4368
4369Submissions which do not conform to the standards may be returned
4370with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004371
4372
wdenk2729af92004-05-03 20:45:30 +00004373Submitting Patches:
4374-------------------
wdenkc6097192002-11-03 00:24:07 +00004375
wdenk2729af92004-05-03 20:45:30 +00004376Since the number of patches for U-Boot is growing, we need to
4377establish some rules. Submissions which do not conform to these rules
4378may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004379
Magnus Lilja0d28f342008-08-06 19:32:33 +02004380Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004381
Wolfgang Denk06682362008-12-30 22:56:11 +01004382Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4383see http://lists.denx.de/mailman/listinfo/u-boot
4384
wdenk2729af92004-05-03 20:45:30 +00004385When you send a patch, please include the following information with
4386it:
wdenkc6097192002-11-03 00:24:07 +00004387
wdenk2729af92004-05-03 20:45:30 +00004388* For bug fixes: a description of the bug and how your patch fixes
4389 this bug. Please try to include a way of demonstrating that the
4390 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004391
wdenk2729af92004-05-03 20:45:30 +00004392* For new features: a description of the feature and your
4393 implementation.
wdenkc6097192002-11-03 00:24:07 +00004394
wdenk2729af92004-05-03 20:45:30 +00004395* A CHANGELOG entry as plaintext (separate from the patch)
4396
4397* For major contributions, your entry to the CREDITS file
4398
4399* When you add support for a new board, don't forget to add this
4400 board to the MAKEALL script, too.
4401
4402* If your patch adds new configuration options, don't forget to
4403 document these in the README file.
4404
Wolfgang Denk218ca722008-03-26 10:40:12 +01004405* The patch itself. If you are using git (which is *strongly*
4406 recommended) you can easily generate the patch using the
4407 "git-format-patch". If you then use "git-send-email" to send it to
4408 the U-Boot mailing list, you will avoid most of the common problems
4409 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004410
Wolfgang Denk218ca722008-03-26 10:40:12 +01004411 If you cannot use git, use "diff -purN OLD NEW". If your version of
4412 diff does not support these options, then get the latest version of
4413 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004414
Wolfgang Denk218ca722008-03-26 10:40:12 +01004415 The current directory when running this command shall be the parent
4416 directory of the U-Boot source tree (i. e. please make sure that
4417 your patch includes sufficient directory information for the
4418 affected files).
4419
4420 We prefer patches as plain text. MIME attachments are discouraged,
4421 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004422
4423* If one logical set of modifications affects or creates several
4424 files, all these changes shall be submitted in a SINGLE patch file.
4425
4426* Changesets that contain different, unrelated modifications shall be
4427 submitted as SEPARATE patches, one patch per changeset.
4428
4429
4430Notes:
4431
4432* Before sending the patch, run the MAKEALL script on your patched
4433 source tree and make sure that no errors or warnings are reported
4434 for any of the boards.
4435
4436* Keep your modifications to the necessary minimum: A patch
4437 containing several unrelated changes or arbitrary reformats will be
4438 returned with a request to re-formatting / split it.
4439
4440* If you modify existing code, make sure that your new code does not
4441 add to the memory footprint of the code ;-) Small is beautiful!
4442 When adding new features, these should compile conditionally only
4443 (using #ifdef), and the resulting code with the new feature
4444 disabled must not need more memory than the old code without your
4445 modification.
wdenk90dc6702005-05-03 14:12:25 +00004446
Wolfgang Denk06682362008-12-30 22:56:11 +01004447* Remember that there is a size limit of 100 kB per message on the
4448 u-boot mailing list. Bigger patches will be moderated. If they are
4449 reasonable and not too big, they will be acknowledged. But patches
4450 bigger than the size limit should be avoided.