blob: 2da0f96abee36c008b8d8ae1a49d24baa97b06bc [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00002# (C) Copyright 2000 - 2011
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
Kumar Gala66412c62011-02-18 05:40:54 -0600359- 85xx CPU Options:
360 CONFIG_SYS_FSL_TBCLK_DIV
361
362 Defines the core time base clock divider ratio compared to the
363 system clock. On most PQ3 devices this is 8, on newer QorIQ
364 devices it can be 16 or 32. The ratio varies from SoC to Soc.
365
Kumar Gala8f290842011-05-20 00:39:21 -0500366 CONFIG_SYS_FSL_PCIE_COMPAT
367
368 Defines the string to utilize when trying to match PCIe device
369 tree nodes for the given platform.
370
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100371- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200372 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100373
374 Defines the Monahans run mode to oscillator
375 ratio. Valid values are 8, 16, 24, 31. The core
376 frequency is this value multiplied by 13 MHz.
377
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200378 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200379
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100380 Defines the Monahans turbo mode to oscillator
381 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200382 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100383 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200384
wdenk5da627a2003-10-09 20:09:04 +0000385- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000386 CONFIG_CLOCKS_IN_MHZ
387
388 U-Boot stores all clock information in Hz
389 internally. For binary compatibility with older Linux
390 kernels (which expect the clocks passed in the
391 bd_info data to be in MHz) the environment variable
392 "clocks_in_mhz" can be defined so that U-Boot
393 converts clock data to MHZ before passing it to the
394 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000395 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100396 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000397 default environment.
398
wdenk5da627a2003-10-09 20:09:04 +0000399 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
400
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200401 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000402 expect it to be in bytes, others in MB.
403 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
404
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400405 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200406
407 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400408 passed using flattened device trees (based on open firmware
409 concepts).
410
411 CONFIG_OF_LIBFDT
412 * New libfdt-based support
413 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500414 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400415
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200416 OF_CPU - The proper name of the cpus node (only required for
417 MPC512X and MPC5xxx based boards).
418 OF_SOC - The proper name of the soc node (only required for
419 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200420 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600421 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200422
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200423 boards with QUICC Engines require OF_QE to set UCC MAC
424 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500425
Kumar Gala4e253132006-01-11 13:54:17 -0600426 CONFIG_OF_BOARD_SETUP
427
428 Board code has addition modification that it wants to make
429 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000430
Matthew McClintock02677682006-06-28 10:41:37 -0500431 CONFIG_OF_BOOT_CPU
432
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200433 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500434 param header, the default value is zero if undefined.
435
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200436 CONFIG_OF_IDE_FIXUP
437
438 U-Boot can detect if an IDE device is present or not.
439 If not, and this new config option is activated, U-Boot
440 removes the ATA node from the DTS before booting Linux,
441 so the Linux IDE driver does not probe the device and
442 crash. This is needed for buggy hardware (uc101) where
443 no pull down resistor is connected to the signal IDE5V_DD7.
444
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100445- vxWorks boot parameters:
446
447 bootvx constructs a valid bootline using the following
448 environments variables: bootfile, ipaddr, serverip, hostname.
449 It loads the vxWorks image pointed bootfile.
450
451 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
452 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
453 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
454 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
455
456 CONFIG_SYS_VXWORKS_ADD_PARAMS
457
458 Add it at the end of the bootline. E.g "u=username pw=secret"
459
460 Note: If a "bootargs" environment is defined, it will overwride
461 the defaults discussed just above.
462
Aneesh V2c451f72011-06-16 23:30:47 +0000463- Cache Configuration:
464 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
465 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
466 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
467
Aneesh V93bc2192011-06-16 23:30:51 +0000468- Cache Configuration for ARM:
469 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
470 controller
471 CONFIG_SYS_PL310_BASE - Physical base address of PL310
472 controller register space
473
wdenk6705d812004-08-02 23:22:59 +0000474- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200475 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000476
477 Define this if you want support for Amba PrimeCell PL010 UARTs.
478
Andreas Engel48d01922008-09-08 14:30:53 +0200479 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000480
481 Define this if you want support for Amba PrimeCell PL011 UARTs.
482
483 CONFIG_PL011_CLOCK
484
485 If you have Amba PrimeCell PL011 UARTs, set this variable to
486 the clock speed of the UARTs.
487
488 CONFIG_PL01x_PORTS
489
490 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
491 define this to a list of base addresses for each (supported)
492 port. See e.g. include/configs/versatile.h
493
John Rigby910f1ae2011-04-19 10:42:39 +0000494 CONFIG_PL011_SERIAL_RLCR
495
496 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
497 have separate receive and transmit line control registers. Set
498 this variable to initialize the extra register.
499
500 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
501
502 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
503 boot loader that has already initialized the UART. Define this
504 variable to flush the UART at init time.
505
wdenk6705d812004-08-02 23:22:59 +0000506
wdenkc6097192002-11-03 00:24:07 +0000507- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000508 Depending on board, define exactly one serial port
509 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
510 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
511 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000512
513 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
514 port routines must be defined elsewhere
515 (i.e. serial_init(), serial_getc(), ...)
516
517 CONFIG_CFB_CONSOLE
518 Enables console device for a color framebuffer. Needs following
519 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
520 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
521 (default big endian)
522 VIDEO_HW_RECTFILL graphic chip supports
523 rectangle fill
524 (cf. smiLynxEM)
525 VIDEO_HW_BITBLT graphic chip supports
526 bit-blit (cf. smiLynxEM)
527 VIDEO_VISIBLE_COLS visible pixel columns
528 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000529 VIDEO_VISIBLE_ROWS visible pixel rows
530 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000531 VIDEO_DATA_FORMAT graphic data format
532 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000533 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000534 VIDEO_KBD_INIT_FCT keyboard int fct
535 (i.e. i8042_kbd_init())
536 VIDEO_TSTC_FCT test char fct
537 (i.e. i8042_tstc)
538 VIDEO_GETC_FCT get char fct
539 (i.e. i8042_getc)
540 CONFIG_CONSOLE_CURSOR cursor drawing on/off
541 (requires blink timer
542 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200543 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000544 CONFIG_CONSOLE_TIME display time/date info in
545 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500546 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000547 CONFIG_VIDEO_LOGO display Linux logo in
548 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000549 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
550 linux_logo.h for logo.
551 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000552 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200553 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000554 the logo
555
wdenk43d96162003-03-06 00:02:04 +0000556 When CONFIG_CFB_CONSOLE is defined, video console is
557 default i/o. Serial console can be forced with
558 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000559
wdenkd4ca31c2004-01-02 14:00:00 +0000560 When CONFIG_SILENT_CONSOLE is defined, all console
561 messages (by U-Boot and Linux!) can be silenced with
562 the "silent" environment variable. See
563 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000564
wdenkc6097192002-11-03 00:24:07 +0000565- Console Baudrate:
566 CONFIG_BAUDRATE - in bps
567 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200568 CONFIG_SYS_BAUDRATE_TABLE, see below.
569 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000570
Heiko Schocherc92fac92009-01-30 12:55:38 +0100571- Console Rx buffer length
572 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
573 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100574 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100575 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
576 must be defined, to setup the maximum idle timeout for
577 the SMC.
578
wdenkc6097192002-11-03 00:24:07 +0000579- Boot Delay: CONFIG_BOOTDELAY - in seconds
580 Delay before automatically booting the default image;
581 set to -1 to disable autoboot.
582
583 See doc/README.autoboot for these options that
584 work with CONFIG_BOOTDELAY. None are required.
585 CONFIG_BOOT_RETRY_TIME
586 CONFIG_BOOT_RETRY_MIN
587 CONFIG_AUTOBOOT_KEYED
588 CONFIG_AUTOBOOT_PROMPT
589 CONFIG_AUTOBOOT_DELAY_STR
590 CONFIG_AUTOBOOT_STOP_STR
591 CONFIG_AUTOBOOT_DELAY_STR2
592 CONFIG_AUTOBOOT_STOP_STR2
593 CONFIG_ZERO_BOOTDELAY_CHECK
594 CONFIG_RESET_TO_RETRY
595
596- Autoboot Command:
597 CONFIG_BOOTCOMMAND
598 Only needed when CONFIG_BOOTDELAY is enabled;
599 define a command string that is automatically executed
600 when no character is read on the console interface
601 within "Boot Delay" after reset.
602
603 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000604 This can be used to pass arguments to the bootm
605 command. The value of CONFIG_BOOTARGS goes into the
606 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000607
608 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000609 The value of these goes into the environment as
610 "ramboot" and "nfsboot" respectively, and can be used
611 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200612 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000613
614- Pre-Boot Commands:
615 CONFIG_PREBOOT
616
617 When this option is #defined, the existence of the
618 environment variable "preboot" will be checked
619 immediately before starting the CONFIG_BOOTDELAY
620 countdown and/or running the auto-boot command resp.
621 entering interactive mode.
622
623 This feature is especially useful when "preboot" is
624 automatically generated or modified. For an example
625 see the LWMON board specific code: here "preboot" is
626 modified when the user holds down a certain
627 combination of keys on the (special) keyboard when
628 booting the systems
629
630- Serial Download Echo Mode:
631 CONFIG_LOADS_ECHO
632 If defined to 1, all characters received during a
633 serial download (using the "loads" command) are
634 echoed back. This might be needed by some terminal
635 emulations (like "cu"), but may as well just take
636 time on others. This setting #define's the initial
637 value of the "loads_echo" environment variable.
638
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500639- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000640 CONFIG_KGDB_BAUDRATE
641 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200642 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000643
644- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500645 Monitor commands can be included or excluded
646 from the build by using the #include files
647 "config_cmd_all.h" and #undef'ing unwanted
648 commands, or using "config_cmd_default.h"
649 and augmenting with additional #define's
650 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000651
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500652 The default command configuration includes all commands
653 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000654
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500655 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500656 CONFIG_CMD_BDI bdinfo
657 CONFIG_CMD_BEDBUG * Include BedBug Debugger
658 CONFIG_CMD_BMP * BMP support
659 CONFIG_CMD_BSP * Board specific commands
660 CONFIG_CMD_BOOTD bootd
661 CONFIG_CMD_CACHE * icache, dcache
662 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500663 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500664 CONFIG_CMD_DATE * support for RTC, date/time...
665 CONFIG_CMD_DHCP * DHCP support
666 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600667 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
668 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
669 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
670 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500671 CONFIG_CMD_DTT * Digital Therm and Thermostat
672 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500673 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500674 CONFIG_CMD_EEPROM * EEPROM read/write support
675 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500676 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500677 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500678 CONFIG_CMD_FDC * Floppy Disk Support
679 CONFIG_CMD_FAT * FAT partition support
680 CONFIG_CMD_FDOS * Dos diskette Support
681 CONFIG_CMD_FLASH flinfo, erase, protect
682 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500683 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000684 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500685 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
686 CONFIG_CMD_I2C * I2C serial bus support
687 CONFIG_CMD_IDE * IDE harddisk support
688 CONFIG_CMD_IMI iminfo
689 CONFIG_CMD_IMLS List all found images
690 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500691 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500692 CONFIG_CMD_IRQ * irqinfo
693 CONFIG_CMD_ITEST Integer/string test of 2 values
694 CONFIG_CMD_JFFS2 * JFFS2 Support
695 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500696 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500697 CONFIG_CMD_LOADB loadb
698 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400699 CONFIG_CMD_MD5SUM print md5 message digest
700 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500701 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
702 loop, loopw, mtest
703 CONFIG_CMD_MISC Misc functions like sleep etc
704 CONFIG_CMD_MMC * MMC memory mapped support
705 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100706 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500707 CONFIG_CMD_NAND * NAND support
708 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600709 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
710 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500711 CONFIG_CMD_PCI * pciinfo
712 CONFIG_CMD_PCMCIA * PCMCIA support
713 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
714 host
715 CONFIG_CMD_PORTIO * Port I/O
716 CONFIG_CMD_REGINFO * Register dump
717 CONFIG_CMD_RUN run command in env variable
718 CONFIG_CMD_SAVES * save S record dump
719 CONFIG_CMD_SCSI * SCSI Support
720 CONFIG_CMD_SDRAM * print SDRAM configuration information
721 (requires CONFIG_CMD_I2C)
722 CONFIG_CMD_SETGETDCR Support for DCR Register access
723 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100724 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400725 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200726 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500727 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000728 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500729 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500730 CONFIG_CMD_CDP * Cisco Discover Protocol support
731 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000732
wdenkc6097192002-11-03 00:24:07 +0000733
734 EXAMPLE: If you want all functions except of network
735 support you can write:
736
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500737 #include "config_cmd_all.h"
738 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000739
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400740 Other Commands:
741 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000742
743 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500744 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000745 what you (and your U-Boot users) are doing. Data
746 cache cannot be enabled on systems like the 8xx or
747 8260 (where accesses to the IMMR region must be
748 uncached), and it cannot be disabled on all other
749 systems where we (mis-) use the data cache to hold an
750 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000751
752
753 XXX - this list needs to get updated!
754
755- Watchdog:
756 CONFIG_WATCHDOG
757 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000758 support for the SoC. There must be support in the SoC
759 specific code for a watchdog. For the 8xx and 8260
760 CPUs, the SIU Watchdog feature is enabled in the SYPCR
761 register. When supported for a specific SoC is
762 available, then no further board specific code should
763 be needed to use it.
764
765 CONFIG_HW_WATCHDOG
766 When using a watchdog circuitry external to the used
767 SoC, then define this variable and provide board
768 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000769
stroesec1551ea2003-04-04 15:53:41 +0000770- U-Boot Version:
771 CONFIG_VERSION_VARIABLE
772 If this variable is defined, an environment variable
773 named "ver" is created by U-Boot showing the U-Boot
774 version as printed by the "version" command.
775 This variable is readonly.
776
wdenkc6097192002-11-03 00:24:07 +0000777- Real-Time Clock:
778
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500779 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000780 has to be selected, too. Define exactly one of the
781 following options:
782
783 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
784 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200785 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000786 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000787 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000788 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000789 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000790 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100791 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000792 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200793 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200794 CONFIG_SYS_RV3029_TCR - enable trickle charger on
795 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000796
wdenkb37c7e52003-06-30 16:24:52 +0000797 Note that if the RTC uses I2C, then the I2C interface
798 must also be configured. See I2C Support, below.
799
Peter Tysere92739d2008-12-17 16:36:21 -0600800- GPIO Support:
801 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
802 CONFIG_PCA953X_INFO - enable pca953x info command
803
Chris Packham5dec49c2010-12-19 10:12:13 +0000804 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
805 chip-ngpio pairs that tell the PCA953X driver the number of
806 pins supported by a particular chip.
807
Peter Tysere92739d2008-12-17 16:36:21 -0600808 Note that if the GPIO device uses I2C, then the I2C interface
809 must also be configured. See I2C Support, below.
810
wdenkc6097192002-11-03 00:24:07 +0000811- Timestamp Support:
812
wdenk43d96162003-03-06 00:02:04 +0000813 When CONFIG_TIMESTAMP is selected, the timestamp
814 (date and time) of an image is printed by image
815 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500816 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000817
818- Partition Support:
819 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400820 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000821
Wolfgang Denk218ca722008-03-26 10:40:12 +0100822 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
823 CONFIG_CMD_SCSI) you must configure support for at
824 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000825
826- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000827 CONFIG_IDE_RESET_ROUTINE - this is defined in several
828 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000829
wdenk4d13cba2004-03-14 14:09:05 +0000830 CONFIG_IDE_RESET - is this is defined, IDE Reset will
831 be performed by calling the function
832 ide_set_reset(int reset)
833 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000834
835- ATAPI Support:
836 CONFIG_ATAPI
837
838 Set this to enable ATAPI support.
839
wdenkc40b2952004-03-13 23:29:43 +0000840- LBA48 Support
841 CONFIG_LBA48
842
843 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100844 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000845 Whithout these , LBA48 support uses 32bit variables and will 'only'
846 support disks up to 2.1TB.
847
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200848 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000849 When enabled, makes the IDE subsystem use 64bit sector addresses.
850 Default is 32bit.
851
wdenkc6097192002-11-03 00:24:07 +0000852- SCSI Support:
853 At the moment only there is only support for the
854 SYM53C8XX SCSI controller; define
855 CONFIG_SCSI_SYM53C8XX to enable it.
856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200857 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
858 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
859 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000860 maximum numbers of LUNs, SCSI ID's and target
861 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200862 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000863
864- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000865 CONFIG_E1000
866 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000867
Andre Schwarzac3315c2008-03-06 16:45:44 +0100868 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200869 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100870
wdenkc6097192002-11-03 00:24:07 +0000871 CONFIG_EEPRO100
872 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200873 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000874 write routine for first time initialisation.
875
876 CONFIG_TULIP
877 Support for Digital 2114x chips.
878 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
879 modem chip initialisation (KS8761/QS6611).
880
881 CONFIG_NATSEMI
882 Support for National dp83815 chips.
883
884 CONFIG_NS8382X
885 Support for National dp8382[01] gigabit chips.
886
wdenk45219c42003-05-12 21:50:16 +0000887- NETWORK Support (other):
888
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100889 CONFIG_DRIVER_AT91EMAC
890 Support for AT91RM9200 EMAC.
891
892 CONFIG_RMII
893 Define this to use reduced MII inteface
894
895 CONFIG_DRIVER_AT91EMAC_QUIET
896 If this defined, the driver is quiet.
897 The driver doen't show link status messages.
898
wdenk45219c42003-05-12 21:50:16 +0000899 CONFIG_DRIVER_LAN91C96
900 Support for SMSC's LAN91C96 chips.
901
902 CONFIG_LAN91C96_BASE
903 Define this to hold the physical address
904 of the LAN91C96's I/O space
905
906 CONFIG_LAN91C96_USE_32_BIT
907 Define this to enable 32 bit addressing
908
wdenkf39748a2004-06-09 13:37:52 +0000909 CONFIG_DRIVER_SMC91111
910 Support for SMSC's LAN91C111 chip
911
912 CONFIG_SMC91111_BASE
913 Define this to hold the physical address
914 of the device (I/O space)
915
916 CONFIG_SMC_USE_32_BIT
917 Define this if data bus is 32 bits
918
919 CONFIG_SMC_USE_IOFUNCS
920 Define this to use i/o functions instead of macros
921 (some hardware wont work with macros)
922
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800923 CONFIG_FTGMAC100
924 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
925
926 CONFIG_FTGMAC100_EGIGA
927 Define this to use GE link update with gigabit PHY.
928 Define this if FTGMAC100 is connected to gigabit PHY.
929 If your system has 10/100 PHY only, it might not occur
930 wrong behavior. Because PHY usually return timeout or
931 useless data when polling gigabit status and gigabit
932 control registers. This behavior won't affect the
933 correctnessof 10/100 link speed update.
934
Mike Rapoportc2fff332009-11-11 10:03:03 +0200935 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200936 Support for SMSC's LAN911x and LAN921x chips
937
Mike Rapoportc2fff332009-11-11 10:03:03 +0200938 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200939 Define this to hold the physical address
940 of the device (I/O space)
941
Mike Rapoportc2fff332009-11-11 10:03:03 +0200942 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200943 Define this if data bus is 32 bits
944
Mike Rapoportc2fff332009-11-11 10:03:03 +0200945 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200946 Define this if data bus is 16 bits. If your processor
947 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200948 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200949
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900950 CONFIG_SH_ETHER
951 Support for Renesas on-chip Ethernet controller
952
953 CONFIG_SH_ETHER_USE_PORT
954 Define the number of ports to be used
955
956 CONFIG_SH_ETHER_PHY_ADDR
957 Define the ETH PHY's address
958
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900959 CONFIG_SH_ETHER_CACHE_WRITEBACK
960 If this option is set, the driver enables cache flush.
961
wdenkc6097192002-11-03 00:24:07 +0000962- USB Support:
963 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000964 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000965 CONFIG_USB_UHCI to enable it.
966 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000967 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000968 storage devices.
969 Note:
970 Supported are USB Keyboards and USB Floppy drives
971 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000972 MPC5200 USB requires additional defines:
973 CONFIG_USB_CLOCK
974 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500975 CONFIG_PSC3_USB
976 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000977 CONFIG_USB_CONFIG
978 for differential drivers: 0x00001000
979 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500980 for differential drivers on PSC3: 0x00000100
981 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200982 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200983 May be defined to allow interrupt polling
984 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000985
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200986- USB Device:
987 Define the below if you wish to use the USB console.
988 Once firmware is rebuilt from a serial console issue the
989 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200990 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200991 it has found a new device. The environment variable usbtty
992 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200993 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200994 Common Device Class Abstract Control Model serial device.
995 If you select usbtty = gserial you should be able to enumerate
996 a Linux host by
997 # modprobe usbserial vendor=0xVendorID product=0xProductID
998 else if using cdc_acm, simply setting the environment
999 variable usbtty to be cdc_acm should suffice. The following
1000 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001001
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001002 CONFIG_USB_DEVICE
1003 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001004
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001005 CONFIG_USB_TTY
1006 Define this to have a tty type of device available to
1007 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001008
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001009 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001010 Define this if you want stdin, stdout &/or stderr to
1011 be set to usbtty.
1012
1013 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001014 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001015 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001016 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001017
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001018 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001019 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001020 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001021
Wolfgang Denk386eda02006-06-14 18:14:56 +02001022 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001023 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001024 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001025 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1026 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1027 should pretend to be a Linux device to it's target host.
1028
1029 CONFIG_USBD_MANUFACTURER
1030 Define this string as the name of your company for
1031 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001032
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001033 CONFIG_USBD_PRODUCT_NAME
1034 Define this string as the name of your product
1035 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1036
1037 CONFIG_USBD_VENDORID
1038 Define this as your assigned Vendor ID from the USB
1039 Implementors Forum. This *must* be a genuine Vendor ID
1040 to avoid polluting the USB namespace.
1041 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001042
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001043 CONFIG_USBD_PRODUCTID
1044 Define this as the unique Product ID
1045 for your device
1046 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001047
1048
1049- MMC Support:
1050 The MMC controller on the Intel PXA is supported. To
1051 enable this define CONFIG_MMC. The MMC can be
1052 accessed from the boot prompt by mapping the device
1053 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001054 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1055 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001056
wdenk6705d812004-08-02 23:22:59 +00001057- Journaling Flash filesystem support:
1058 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1059 CONFIG_JFFS2_NAND_DEV
1060 Define these for a default partition on a NAND device
1061
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001062 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1063 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001064 Define these for a default partition on a NOR device
1065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001066 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001067 Define this to create an own partition. You have to provide a
1068 function struct part_info* jffs2_part_info(int part_num)
1069
1070 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001071 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001072 to disable the command chpart. This is the default when you
1073 have not defined a custom partition
1074
wdenkc6097192002-11-03 00:24:07 +00001075- Keyboard Support:
1076 CONFIG_ISA_KEYBOARD
1077
1078 Define this to enable standard (PC-Style) keyboard
1079 support
1080
1081 CONFIG_I8042_KBD
1082 Standard PC keyboard driver with US (is default) and
1083 GERMAN key layout (switch via environment 'keymap=de') support.
1084 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1085 for cfb_console. Supports cursor blinking.
1086
1087- Video support:
1088 CONFIG_VIDEO
1089
1090 Define this to enable video support (for output to
1091 video).
1092
1093 CONFIG_VIDEO_CT69000
1094
1095 Enable Chips & Technologies 69000 Video chip
1096
1097 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001098 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001099 video output is selected via environment 'videoout'
1100 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1101 assumed.
wdenkc6097192002-11-03 00:24:07 +00001102
wdenkb79a11c2004-03-25 15:14:43 +00001103 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001104 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001105 are possible:
1106 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001107 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001108
1109 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1110 -------------+---------------------------------------------
1111 8 bits | 0x301* 0x303 0x305 0x161 0x307
1112 15 bits | 0x310 0x313 0x316 0x162 0x319
1113 16 bits | 0x311 0x314 0x317 0x163 0x31A
1114 24 bits | 0x312 0x315 0x318 ? 0x31B
1115 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001116 (i.e. setenv videomode 317; saveenv; reset;)
1117
wdenkb79a11c2004-03-25 15:14:43 +00001118 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001119 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001120
1121
stroesec1551ea2003-04-04 15:53:41 +00001122 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001123 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001124 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1125 or CONFIG_VIDEO_SED13806_16BPP
1126
Timur Tabi7d3053f2011-02-15 17:09:19 -06001127 CONFIG_FSL_DIU_FB
1128 Enable the Freescale DIU video driver. Reference boards for
1129 SOCs that have a DIU should define this macro to enable DIU
1130 support, and should also define these other macros:
1131
1132 CONFIG_SYS_DIU_ADDR
1133 CONFIG_VIDEO
1134 CONFIG_CMD_BMP
1135 CONFIG_CFB_CONSOLE
1136 CONFIG_VIDEO_SW_CURSOR
1137 CONFIG_VGA_AS_SINGLE_DEVICE
1138 CONFIG_VIDEO_LOGO
1139 CONFIG_VIDEO_BMP_LOGO
1140
Timur Tabiba8e76b2011-04-11 14:18:22 -05001141 The DIU driver will look for the 'video-mode' environment
1142 variable, and if defined, enable the DIU as a console during
1143 boot. See the documentation file README.video for a
1144 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001145
wdenk682011f2003-06-03 23:54:09 +00001146- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001147 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001148
wdenk8bde7f72003-06-27 21:31:46 +00001149 Define this to enable a custom keyboard support.
1150 This simply calls drv_keyboard_init() which must be
1151 defined in your board-specific files.
1152 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001153
wdenkc6097192002-11-03 00:24:07 +00001154- LCD Support: CONFIG_LCD
1155
1156 Define this to enable LCD support (for output to LCD
1157 display); also select one of the supported displays
1158 by defining one of these:
1159
Stelian Pop39cf4802008-05-09 21:57:18 +02001160 CONFIG_ATMEL_LCD:
1161
1162 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1163
wdenkfd3103b2003-11-25 16:55:19 +00001164 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001165
wdenkfd3103b2003-11-25 16:55:19 +00001166 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001167
wdenkfd3103b2003-11-25 16:55:19 +00001168 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001169
wdenkfd3103b2003-11-25 16:55:19 +00001170 NEC NL6448BC20-08. 6.5", 640x480.
1171 Active, color, single scan.
1172
1173 CONFIG_NEC_NL6448BC33_54
1174
1175 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001176 Active, color, single scan.
1177
1178 CONFIG_SHARP_16x9
1179
1180 Sharp 320x240. Active, color, single scan.
1181 It isn't 16x9, and I am not sure what it is.
1182
1183 CONFIG_SHARP_LQ64D341
1184
1185 Sharp LQ64D341 display, 640x480.
1186 Active, color, single scan.
1187
1188 CONFIG_HLD1045
1189
1190 HLD1045 display, 640x480.
1191 Active, color, single scan.
1192
1193 CONFIG_OPTREX_BW
1194
1195 Optrex CBL50840-2 NF-FW 99 22 M5
1196 or
1197 Hitachi LMG6912RPFC-00T
1198 or
1199 Hitachi SP14Q002
1200
1201 320x240. Black & white.
1202
1203 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001204 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001205
wdenk7152b1d2003-09-05 23:19:14 +00001206- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001207
wdenk8bde7f72003-06-27 21:31:46 +00001208 If this option is set, the environment is checked for
1209 a variable "splashimage". If found, the usual display
1210 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001211 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001212 specified in "splashimage" is loaded instead. The
1213 console is redirected to the "nulldev", too. This
1214 allows for a "silent" boot where a splash screen is
1215 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001216
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001217 CONFIG_SPLASH_SCREEN_ALIGN
1218
1219 If this option is set the splash image can be freely positioned
1220 on the screen. Environment variable "splashpos" specifies the
1221 position as "x,y". If a positive number is given it is used as
1222 number of pixel from left/top. If a negative number is given it
1223 is used as number of pixel from right/bottom. You can also
1224 specify 'm' for centering the image.
1225
1226 Example:
1227 setenv splashpos m,m
1228 => image at center of screen
1229
1230 setenv splashpos 30,20
1231 => image at x = 30 and y = 20
1232
1233 setenv splashpos -10,m
1234 => vertically centered image
1235 at x = dspWidth - bmpWidth - 9
1236
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001237- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1238
1239 If this option is set, additionally to standard BMP
1240 images, gzipped BMP images can be displayed via the
1241 splashscreen support or the bmp command.
1242
Anatolij Gustschind5011762010-03-15 14:50:25 +01001243- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1244
1245 If this option is set, 8-bit RLE compressed BMP images
1246 can be displayed via the splashscreen support or the
1247 bmp command.
1248
wdenkc29fdfc2003-08-29 20:57:53 +00001249- Compression support:
1250 CONFIG_BZIP2
1251
1252 If this option is set, support for bzip2 compressed
1253 images is included. If not, only uncompressed and gzip
1254 compressed images are supported.
1255
wdenk42d1f032003-10-15 23:53:47 +00001256 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001257 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001258 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001259
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001260 CONFIG_LZMA
1261
1262 If this option is set, support for lzma compressed
1263 images is included.
1264
1265 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1266 requires an amount of dynamic memory that is given by the
1267 formula:
1268
1269 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1270
1271 Where lc and lp stand for, respectively, Literal context bits
1272 and Literal pos bits.
1273
1274 This value is upper-bounded by 14MB in the worst case. Anyway,
1275 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1276 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1277 a very small buffer.
1278
1279 Use the lzmainfo tool to determinate the lc and lp values and
1280 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001281 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001282
wdenk17ea1172004-06-06 21:51:03 +00001283- MII/PHY support:
1284 CONFIG_PHY_ADDR
1285
1286 The address of PHY on MII bus.
1287
1288 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1289
1290 The clock frequency of the MII bus
1291
1292 CONFIG_PHY_GIGE
1293
1294 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001295 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001296
1297 CONFIG_PHY_RESET_DELAY
1298
1299 Some PHY like Intel LXT971A need extra delay after
1300 reset before any MII register access is possible.
1301 For such PHY, set this option to the usec delay
1302 required. (minimum 300usec for LXT971A)
1303
1304 CONFIG_PHY_CMD_DELAY (ppc4xx)
1305
1306 Some PHY like Intel LXT971A need extra delay after
1307 command issued before MII status register can be read
1308
wdenkc6097192002-11-03 00:24:07 +00001309- Ethernet address:
1310 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001311 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001312 CONFIG_ETH2ADDR
1313 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001314 CONFIG_ETH4ADDR
1315 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001316
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001317 Define a default value for Ethernet address to use
1318 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001319 is not determined automatically.
1320
1321- IP address:
1322 CONFIG_IPADDR
1323
1324 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001325 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001326 determined through e.g. bootp.
1327
1328- Server IP address:
1329 CONFIG_SERVERIP
1330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001331 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001332 server to contact when using the "tftboot" command.
1333
Robin Getz97cfe862009-07-21 12:15:28 -04001334 CONFIG_KEEP_SERVERADDR
1335
1336 Keeps the server's MAC address, in the env 'serveraddr'
1337 for passing to bootargs (like Linux's netconsole option)
1338
David Updegraff53a5c422007-06-11 10:41:07 -05001339- Multicast TFTP Mode:
1340 CONFIG_MCAST_TFTP
1341
1342 Defines whether you want to support multicast TFTP as per
1343 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001344 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001345 driver in use must provide a function: mcast() to join/leave a
1346 multicast group.
1347
wdenkc6097192002-11-03 00:24:07 +00001348- BOOTP Recovery Mode:
1349 CONFIG_BOOTP_RANDOM_DELAY
1350
1351 If you have many targets in a network that try to
1352 boot using BOOTP, you may want to avoid that all
1353 systems send out BOOTP requests at precisely the same
1354 moment (which would happen for instance at recovery
1355 from a power failure, when all systems will try to
1356 boot, thus flooding the BOOTP server. Defining
1357 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1358 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001359 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001360
1361 1st BOOTP request: delay 0 ... 1 sec
1362 2nd BOOTP request: delay 0 ... 2 sec
1363 3rd BOOTP request: delay 0 ... 4 sec
1364 4th and following
1365 BOOTP requests: delay 0 ... 8 sec
1366
stroesefe389a82003-08-28 14:17:32 +00001367- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001368 You can fine tune the DHCP functionality by defining
1369 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001370
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001371 CONFIG_BOOTP_SUBNETMASK
1372 CONFIG_BOOTP_GATEWAY
1373 CONFIG_BOOTP_HOSTNAME
1374 CONFIG_BOOTP_NISDOMAIN
1375 CONFIG_BOOTP_BOOTPATH
1376 CONFIG_BOOTP_BOOTFILESIZE
1377 CONFIG_BOOTP_DNS
1378 CONFIG_BOOTP_DNS2
1379 CONFIG_BOOTP_SEND_HOSTNAME
1380 CONFIG_BOOTP_NTPSERVER
1381 CONFIG_BOOTP_TIMEOFFSET
1382 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001383
Wilson Callan5d110f02007-07-28 10:56:13 -04001384 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1385 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001386
1387 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1388 serverip from a DHCP server, it is possible that more
1389 than one DNS serverip is offered to the client.
1390 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1391 serverip will be stored in the additional environment
1392 variable "dnsip2". The first DNS serverip is always
1393 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001394 is defined.
stroesefe389a82003-08-28 14:17:32 +00001395
1396 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1397 to do a dynamic update of a DNS server. To do this, they
1398 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001399 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001400 of the "hostname" environment variable is passed as
1401 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001402
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001403 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1404
1405 A 32bit value in microseconds for a delay between
1406 receiving a "DHCP Offer" and sending the "DHCP Request".
1407 This fixes a problem with certain DHCP servers that don't
1408 respond 100% of the time to a "DHCP request". E.g. On an
1409 AT91RM9200 processor running at 180MHz, this delay needed
1410 to be *at least* 15,000 usec before a Windows Server 2003
1411 DHCP server would reply 100% of the time. I recommend at
1412 least 50,000 usec to be safe. The alternative is to hope
1413 that one of the retries will be successful but note that
1414 the DHCP timeout and retry process takes a longer than
1415 this delay.
1416
wdenka3d991b2004-04-15 21:48:45 +00001417 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001418 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001419
1420 The device id used in CDP trigger frames.
1421
1422 CONFIG_CDP_DEVICE_ID_PREFIX
1423
1424 A two character string which is prefixed to the MAC address
1425 of the device.
1426
1427 CONFIG_CDP_PORT_ID
1428
1429 A printf format string which contains the ascii name of
1430 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001431 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001432
1433 CONFIG_CDP_CAPABILITIES
1434
1435 A 32bit integer which indicates the device capabilities;
1436 0x00000010 for a normal host which does not forwards.
1437
1438 CONFIG_CDP_VERSION
1439
1440 An ascii string containing the version of the software.
1441
1442 CONFIG_CDP_PLATFORM
1443
1444 An ascii string containing the name of the platform.
1445
1446 CONFIG_CDP_TRIGGER
1447
1448 A 32bit integer sent on the trigger.
1449
1450 CONFIG_CDP_POWER_CONSUMPTION
1451
1452 A 16bit integer containing the power consumption of the
1453 device in .1 of milliwatts.
1454
1455 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1456
1457 A byte containing the id of the VLAN.
1458
wdenkc6097192002-11-03 00:24:07 +00001459- Status LED: CONFIG_STATUS_LED
1460
1461 Several configurations allow to display the current
1462 status using a LED. For instance, the LED will blink
1463 fast while running U-Boot code, stop blinking as
1464 soon as a reply to a BOOTP request was received, and
1465 start blinking slow once the Linux kernel is running
1466 (supported by a status LED driver in the Linux
1467 kernel). Defining CONFIG_STATUS_LED enables this
1468 feature in U-Boot.
1469
1470- CAN Support: CONFIG_CAN_DRIVER
1471
1472 Defining CONFIG_CAN_DRIVER enables CAN driver support
1473 on those systems that support this (optional)
1474 feature, like the TQM8xxL modules.
1475
1476- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1477
wdenkb37c7e52003-06-30 16:24:52 +00001478 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001479 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001480 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001481
wdenk945af8d2003-07-16 21:53:01 +00001482 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001483 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001484 CONFIG_COMMANDS) and communicate with i2c based realtime
1485 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001486 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001487
Ben Warrenbb99ad62006-09-07 16:50:54 -04001488 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001489
wdenk945af8d2003-07-16 21:53:01 +00001490 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001491 bit-banging) driver instead of CPM or similar hardware
1492 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001493
wdenk945af8d2003-07-16 21:53:01 +00001494 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001495 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001497 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001498 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001499 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001500 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001501
Peter Tyser8d321b82010-04-12 22:28:21 -05001502 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001503 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001504 and so its address should therefore be cleared to 0 (See,
1505 eg, MPC823e User's Manual p.16-473). So, set
1506 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001507
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001508 CONFIG_SYS_I2C_INIT_MPC5XXX
1509
1510 When a board is reset during an i2c bus transfer
1511 chips might think that the current transfer is still
1512 in progress. Reset the slave devices by sending start
1513 commands until the slave device responds.
1514
wdenk945af8d2003-07-16 21:53:01 +00001515 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001516
1517 If you use the software i2c interface (CONFIG_SOFT_I2C)
1518 then the following macros need to be defined (examples are
1519 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001520
1521 I2C_INIT
1522
wdenkb37c7e52003-06-30 16:24:52 +00001523 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001524 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001525
wdenkba56f622004-02-06 23:19:44 +00001526 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001527
wdenkc6097192002-11-03 00:24:07 +00001528 I2C_PORT
1529
wdenk43d96162003-03-06 00:02:04 +00001530 (Only for MPC8260 CPU). The I/O port to use (the code
1531 assumes both bits are on the same port). Valid values
1532 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001533
1534 I2C_ACTIVE
1535
1536 The code necessary to make the I2C data line active
1537 (driven). If the data line is open collector, this
1538 define can be null.
1539
wdenkb37c7e52003-06-30 16:24:52 +00001540 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1541
wdenkc6097192002-11-03 00:24:07 +00001542 I2C_TRISTATE
1543
1544 The code necessary to make the I2C data line tri-stated
1545 (inactive). If the data line is open collector, this
1546 define can be null.
1547
wdenkb37c7e52003-06-30 16:24:52 +00001548 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1549
wdenkc6097192002-11-03 00:24:07 +00001550 I2C_READ
1551
1552 Code that returns TRUE if the I2C data line is high,
1553 FALSE if it is low.
1554
wdenkb37c7e52003-06-30 16:24:52 +00001555 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1556
wdenkc6097192002-11-03 00:24:07 +00001557 I2C_SDA(bit)
1558
1559 If <bit> is TRUE, sets the I2C data line high. If it
1560 is FALSE, it clears it (low).
1561
wdenkb37c7e52003-06-30 16:24:52 +00001562 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001563 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001564 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001565
wdenkc6097192002-11-03 00:24:07 +00001566 I2C_SCL(bit)
1567
1568 If <bit> is TRUE, sets the I2C clock line high. If it
1569 is FALSE, it clears it (low).
1570
wdenkb37c7e52003-06-30 16:24:52 +00001571 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001572 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001573 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001574
wdenkc6097192002-11-03 00:24:07 +00001575 I2C_DELAY
1576
1577 This delay is invoked four times per clock cycle so this
1578 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001579 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001580 like:
1581
wdenkb37c7e52003-06-30 16:24:52 +00001582 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001583
Mike Frysinger793b5722010-07-21 13:38:02 -04001584 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1585
1586 If your arch supports the generic GPIO framework (asm/gpio.h),
1587 then you may alternatively define the two GPIOs that are to be
1588 used as SCL / SDA. Any of the previous I2C_xxx macros will
1589 have GPIO-based defaults assigned to them as appropriate.
1590
1591 You should define these to the GPIO value as given directly to
1592 the generic GPIO functions.
1593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001594 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001595
wdenk8bde7f72003-06-27 21:31:46 +00001596 When a board is reset during an i2c bus transfer
1597 chips might think that the current transfer is still
1598 in progress. On some boards it is possible to access
1599 the i2c SCLK line directly, either by using the
1600 processor pin as a GPIO or by having a second pin
1601 connected to the bus. If this option is defined a
1602 custom i2c_init_board() routine in boards/xxx/board.c
1603 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001604
Richard Retanubun26a33502010-04-12 15:08:17 -04001605 CONFIG_SYS_I2C_BOARD_LATE_INIT
1606
1607 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1608 defined a custom i2c_board_late_init() routine in
1609 boards/xxx/board.c is run AFTER the operations in i2c_init()
1610 is completed. This callpoint can be used to unreset i2c bus
1611 using CPU i2c controller register accesses for CPUs whose i2c
1612 controller provide such a method. It is called at the end of
1613 i2c_init() to allow i2c_init operations to setup the i2c bus
1614 controller on the CPU (e.g. setting bus speed & slave address).
1615
wdenk17ea1172004-06-06 21:51:03 +00001616 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1617
1618 This option enables configuration of bi_iic_fast[] flags
1619 in u-boot bd_info structure based on u-boot environment
1620 variable "i2cfast". (see also i2cfast)
1621
Ben Warrenbb99ad62006-09-07 16:50:54 -04001622 CONFIG_I2C_MULTI_BUS
1623
1624 This option allows the use of multiple I2C buses, each of which
1625 must have a controller. At any point in time, only one bus is
1626 active. To switch to a different bus, use the 'i2c dev' command.
1627 Note that bus numbering is zero-based.
1628
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001629 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001630
1631 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001632 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1633 is set, specify a list of bus-device pairs. Otherwise, specify
1634 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001635
1636 e.g.
1637 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001638 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001639
1640 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1641
1642 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001643 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001644
1645 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1646
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001647 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001648
1649 If defined, then this indicates the I2C bus number for DDR SPD.
1650 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1651
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001652 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001653
1654 If defined, then this indicates the I2C bus number for the RTC.
1655 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001657 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001658
1659 If defined, then this indicates the I2C bus number for the DTT.
1660 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1661
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001662 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001663
1664 If defined, specifies the I2C address of the DTT device.
1665 If not defined, then U-Boot uses predefined value for
1666 specified DTT device.
1667
Timur Tabibe5e6182006-11-03 19:15:00 -06001668 CONFIG_FSL_I2C
1669
1670 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001671 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001672
Heiko Schocher67b23a32008-10-15 09:39:47 +02001673 CONFIG_I2C_MUX
1674
1675 Define this option if you have I2C devices reached over 1 .. n
1676 I2C Muxes like the pca9544a. This option addes a new I2C
1677 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1678 new I2C Bus to the existing I2C Busses. If you select the
1679 new Bus with "i2c dev", u-bbot sends first the commandos for
1680 the muxes to activate this new "bus".
1681
1682 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1683 feature!
1684
1685 Example:
1686 Adding a new I2C Bus reached over 2 pca9544a muxes
1687 The First mux with address 70 and channel 6
1688 The Second mux with address 71 and channel 4
1689
1690 => i2c bus pca9544a:70:6:pca9544a:71:4
1691
1692 Use the "i2c bus" command without parameter, to get a list
1693 of I2C Busses with muxes:
1694
1695 => i2c bus
1696 Busses reached over muxes:
1697 Bus ID: 2
1698 reached over Mux(es):
1699 pca9544a@70 ch: 4
1700 Bus ID: 3
1701 reached over Mux(es):
1702 pca9544a@70 ch: 6
1703 pca9544a@71 ch: 4
1704 =>
1705
1706 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1707 u-boot sends First the Commando to the mux@70 to enable
1708 channel 6, and then the Commando to the mux@71 to enable
1709 the channel 4.
1710
1711 After that, you can use the "normal" i2c commands as
1712 usual, to communicate with your I2C devices behind
1713 the 2 muxes.
1714
1715 This option is actually implemented for the bitbanging
1716 algorithm in common/soft_i2c.c and for the Hardware I2C
1717 Bus on the MPC8260. But it should be not so difficult
1718 to add this option to other architectures.
1719
Andrew Dyer2ac69852008-12-29 17:36:01 -06001720 CONFIG_SOFT_I2C_READ_REPEATED_START
1721
1722 defining this will force the i2c_read() function in
1723 the soft_i2c driver to perform an I2C repeated start
1724 between writing the address pointer and reading the
1725 data. If this define is omitted the default behaviour
1726 of doing a stop-start sequence will be used. Most I2C
1727 devices can use either method, but some require one or
1728 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001729
wdenkc6097192002-11-03 00:24:07 +00001730- SPI Support: CONFIG_SPI
1731
1732 Enables SPI driver (so far only tested with
1733 SPI EEPROM, also an instance works with Crystal A/D and
1734 D/As on the SACSng board)
1735
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001736 CONFIG_SH_SPI
1737
1738 Enables the driver for SPI controller on SuperH. Currently
1739 only SH7757 is supported.
1740
wdenkc6097192002-11-03 00:24:07 +00001741 CONFIG_SPI_X
1742
1743 Enables extended (16-bit) SPI EEPROM addressing.
1744 (symmetrical to CONFIG_I2C_X)
1745
1746 CONFIG_SOFT_SPI
1747
wdenk43d96162003-03-06 00:02:04 +00001748 Enables a software (bit-bang) SPI driver rather than
1749 using hardware support. This is a general purpose
1750 driver that only requires three general I/O port pins
1751 (two outputs, one input) to function. If this is
1752 defined, the board configuration must define several
1753 SPI configuration items (port pins to use, etc). For
1754 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001755
Ben Warren04a9e112008-01-16 22:37:35 -05001756 CONFIG_HARD_SPI
1757
1758 Enables a hardware SPI driver for general-purpose reads
1759 and writes. As with CONFIG_SOFT_SPI, the board configuration
1760 must define a list of chip-select function pointers.
1761 Currently supported on some MPC8xxx processors. For an
1762 example, see include/configs/mpc8349emds.h.
1763
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001764 CONFIG_MXC_SPI
1765
1766 Enables the driver for the SPI controllers on i.MX and MXC
1767 SoCs. Currently only i.MX31 is supported.
1768
Matthias Fuchs01335022007-12-27 17:12:34 +01001769- FPGA Support: CONFIG_FPGA
1770
1771 Enables FPGA subsystem.
1772
1773 CONFIG_FPGA_<vendor>
1774
1775 Enables support for specific chip vendors.
1776 (ALTERA, XILINX)
1777
1778 CONFIG_FPGA_<family>
1779
1780 Enables support for FPGA family.
1781 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1782
1783 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001784
wdenk43d96162003-03-06 00:02:04 +00001785 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001787 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001788
wdenk8bde7f72003-06-27 21:31:46 +00001789 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001791 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001792
wdenk43d96162003-03-06 00:02:04 +00001793 Enable checks on FPGA configuration interface busy
1794 status by the configuration function. This option
1795 will require a board or device specific function to
1796 be written.
wdenkc6097192002-11-03 00:24:07 +00001797
1798 CONFIG_FPGA_DELAY
1799
1800 If defined, a function that provides delays in the FPGA
1801 configuration driver.
1802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001803 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001804 Allow Control-C to interrupt FPGA configuration
1805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001806 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001807
wdenk43d96162003-03-06 00:02:04 +00001808 Check for configuration errors during FPGA bitfile
1809 loading. For example, abort during Virtex II
1810 configuration if the INIT_B line goes low (which
1811 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001813 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001814
wdenk43d96162003-03-06 00:02:04 +00001815 Maximum time to wait for the INIT_B line to deassert
1816 after PROB_B has been deasserted during a Virtex II
1817 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001818 ms.
wdenkc6097192002-11-03 00:24:07 +00001819
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001820 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001821
wdenk43d96162003-03-06 00:02:04 +00001822 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001823 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001825 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001826
wdenk43d96162003-03-06 00:02:04 +00001827 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001828 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001829
1830- Configuration Management:
1831 CONFIG_IDENT_STRING
1832
wdenk43d96162003-03-06 00:02:04 +00001833 If defined, this string will be added to the U-Boot
1834 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001835
1836- Vendor Parameter Protection:
1837
wdenk43d96162003-03-06 00:02:04 +00001838 U-Boot considers the values of the environment
1839 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001840 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001841 are set once by the board vendor / manufacturer, and
1842 protects these variables from casual modification by
1843 the user. Once set, these variables are read-only,
1844 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001845 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001846
1847 If CONFIG_ENV_OVERWRITE is #defined in your config
1848 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001849 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001850 these parameters.
1851
1852 Alternatively, if you #define _both_ CONFIG_ETHADDR
1853 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001854 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001855 which can be changed exactly ONCE by the user. [The
1856 serial# is unaffected by this, i. e. it remains
1857 read-only.]
1858
1859- Protected RAM:
1860 CONFIG_PRAM
1861
1862 Define this variable to enable the reservation of
1863 "protected RAM", i. e. RAM which is not overwritten
1864 by U-Boot. Define CONFIG_PRAM to hold the number of
1865 kB you want to reserve for pRAM. You can overwrite
1866 this default value by defining an environment
1867 variable "pram" to the number of kB you want to
1868 reserve. Note that the board info structure will
1869 still show the full amount of RAM. If pRAM is
1870 reserved, a new environment variable "mem" will
1871 automatically be defined to hold the amount of
1872 remaining RAM in a form that can be passed as boot
1873 argument to Linux, for instance like that:
1874
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001875 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001876 saveenv
1877
1878 This way you can tell Linux not to use this memory,
1879 either, which results in a memory region that will
1880 not be affected by reboots.
1881
1882 *WARNING* If your board configuration uses automatic
1883 detection of the RAM size, you must make sure that
1884 this memory test is non-destructive. So far, the
1885 following board configurations are known to be
1886 "pRAM-clean":
1887
1888 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1889 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001890 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001891
1892- Error Recovery:
1893 CONFIG_PANIC_HANG
1894
1895 Define this variable to stop the system in case of a
1896 fatal error, so that you have to reset it manually.
1897 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001898 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001899 automatically as fast as possible, but it may be
1900 useful during development since you can try to debug
1901 the conditions that lead to the situation.
1902
1903 CONFIG_NET_RETRY_COUNT
1904
wdenk43d96162003-03-06 00:02:04 +00001905 This variable defines the number of retries for
1906 network operations like ARP, RARP, TFTP, or BOOTP
1907 before giving up the operation. If not defined, a
1908 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001909
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001910 CONFIG_ARP_TIMEOUT
1911
1912 Timeout waiting for an ARP reply in milliseconds.
1913
wdenkc6097192002-11-03 00:24:07 +00001914- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001915 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001916
1917 Enable auto completion of commands using TAB.
1918
Wolfgang Denka9398e02006-11-27 15:32:42 +01001919 Note that this feature has NOT been implemented yet
1920 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001921
1922
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001923 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001924
1925 Define this variable to enable the "hush" shell (from
1926 Busybox) as command line interpreter, thus enabling
1927 powerful command line syntax like
1928 if...then...else...fi conditionals or `&&' and '||'
1929 constructs ("shell scripts").
1930
1931 If undefined, you get the old, much simpler behaviour
1932 with a somewhat smaller memory footprint.
1933
1934
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001935 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001936
1937 This defines the secondary prompt string, which is
1938 printed when the command interpreter needs more input
1939 to complete a command. Usually "> ".
1940
1941 Note:
1942
wdenk8bde7f72003-06-27 21:31:46 +00001943 In the current implementation, the local variables
1944 space and global environment variables space are
1945 separated. Local variables are those you define by
1946 simply typing `name=value'. To access a local
1947 variable later on, you have write `$name' or
1948 `${name}'; to execute the contents of a variable
1949 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001950
wdenk43d96162003-03-06 00:02:04 +00001951 Global environment variables are those you use
1952 setenv/printenv to work with. To run a command stored
1953 in such a variable, you need to use the run command,
1954 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001955
1956 To store commands and special characters in a
1957 variable, please use double quotation marks
1958 surrounding the whole text of the variable, instead
1959 of the backslashes before semicolons and special
1960 symbols.
1961
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001962- Commandline Editing and History:
1963 CONFIG_CMDLINE_EDITING
1964
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001965 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001966 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001967
wdenka8c7c702003-12-06 19:49:23 +00001968- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001969 CONFIG_EXTRA_ENV_SETTINGS
1970
wdenk43d96162003-03-06 00:02:04 +00001971 Define this to contain any number of null terminated
1972 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001973 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001974
wdenk43d96162003-03-06 00:02:04 +00001975 For example, place something like this in your
1976 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001977
1978 #define CONFIG_EXTRA_ENV_SETTINGS \
1979 "myvar1=value1\0" \
1980 "myvar2=value2\0"
1981
wdenk43d96162003-03-06 00:02:04 +00001982 Warning: This method is based on knowledge about the
1983 internal format how the environment is stored by the
1984 U-Boot code. This is NOT an official, exported
1985 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001986 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001987 You better know what you are doing here.
1988
wdenk43d96162003-03-06 00:02:04 +00001989 Note: overly (ab)use of the default environment is
1990 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001991 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001992 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001993
wdenka8c7c702003-12-06 19:49:23 +00001994- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001995 CONFIG_HAS_DATAFLASH
1996
wdenk8bde7f72003-06-27 21:31:46 +00001997 Defining this option enables DataFlash features and
1998 allows to read/write in Dataflash via the standard
1999 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002000
wdenk3f85ce22004-02-23 16:11:30 +00002001- SystemACE Support:
2002 CONFIG_SYSTEMACE
2003
2004 Adding this option adds support for Xilinx SystemACE
2005 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002006 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002007 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002008
2009 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002010 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002011
2012 When SystemACE support is added, the "ace" device type
2013 becomes available to the fat commands, i.e. fatls.
2014
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002015- TFTP Fixed UDP Port:
2016 CONFIG_TFTP_PORT
2017
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002018 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002019 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002020 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002021 number generator is used.
2022
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002023 Also, the environment variable tftpdstp is used to supply
2024 the TFTP UDP destination port value. If tftpdstp isn't
2025 defined, the normal port 69 is used.
2026
2027 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002028 blindly start the TFTP transfer using the pre-configured
2029 target IP address and UDP port. This has the effect of
2030 "punching through" the (Windows XP) firewall, allowing
2031 the remainder of the TFTP transfer to proceed normally.
2032 A better solution is to properly configure the firewall,
2033 but sometimes that is not allowed.
2034
wdenka8c7c702003-12-06 19:49:23 +00002035- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002036 CONFIG_SHOW_BOOT_PROGRESS
2037
wdenk43d96162003-03-06 00:02:04 +00002038 Defining this option allows to add some board-
2039 specific code (calling a user-provided function
2040 "show_boot_progress(int)") that enables you to show
2041 the system's boot progress on some display (for
2042 example, some LED's) on your board. At the moment,
2043 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002044
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002045- Standalone program support:
2046 CONFIG_STANDALONE_LOAD_ADDR
2047
2048 This option allows to define board specific values
2049 for the address where standalone program gets loaded,
2050 thus overwriting the architecutre dependent default
2051 settings.
2052
Minkyu Kangd32a1a42011-04-24 22:22:34 +00002053- Frame Buffer Address:
2054 CONFIG_FB_ADDR
2055
2056 Define CONFIG_FB_ADDR if you want to use specific address for
2057 frame buffer.
2058 Then system will reserve the frame buffer address to defined address
2059 instead of lcd_setmem (this function grab the memory for frame buffer
2060 by panel's size).
2061
2062 Please see board_init_f function.
2063
2064 If you want this config option then,
2065 please define it at your board config file
2066
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002067Legacy uImage format:
2068
wdenkc6097192002-11-03 00:24:07 +00002069 Arg Where When
2070 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002071 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002072 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002073 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002074 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002075 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002076 4 common/cmd_bootm.c Image data has correct checksum
2077 -4 common/cmd_bootm.c Image is for unsupported architecture
2078 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002079 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002080 6 common/cmd_bootm.c Image Type check OK
2081 -6 common/cmd_bootm.c gunzip uncompression error
2082 -7 common/cmd_bootm.c Unimplemented compression type
2083 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002084 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002085 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002086
2087 9 common/image.c Start initial ramdisk verification
2088 -10 common/image.c Ramdisk header has bad magic number
2089 -11 common/image.c Ramdisk header has bad checksum
2090 10 common/image.c Ramdisk header is OK
2091 -12 common/image.c Ramdisk data has bad checksum
2092 11 common/image.c Ramdisk data has correct checksum
2093 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002094 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002095 13 common/image.c Start multifile image verification
2096 14 common/image.c No initial ramdisk, no multifile, continue.
2097
Peter Tyserea0364f2010-04-12 22:28:04 -05002098 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002099
Stefan Roesea47a12b2010-04-15 16:07:28 +02002100 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002101 -31 post/post.c POST test failed, detected by post_output_backlog()
2102 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002103
Heiko Schocher566a4942007-06-22 19:11:54 +02002104 34 common/cmd_doc.c before loading a Image from a DOC device
2105 -35 common/cmd_doc.c Bad usage of "doc" command
2106 35 common/cmd_doc.c correct usage of "doc" command
2107 -36 common/cmd_doc.c No boot device
2108 36 common/cmd_doc.c correct boot device
2109 -37 common/cmd_doc.c Unknown Chip ID on boot device
2110 37 common/cmd_doc.c correct chip ID found, device available
2111 -38 common/cmd_doc.c Read Error on boot device
2112 38 common/cmd_doc.c reading Image header from DOC device OK
2113 -39 common/cmd_doc.c Image header has bad magic number
2114 39 common/cmd_doc.c Image header has correct magic number
2115 -40 common/cmd_doc.c Error reading Image from DOC device
2116 40 common/cmd_doc.c Image header has correct magic number
2117 41 common/cmd_ide.c before loading a Image from a IDE device
2118 -42 common/cmd_ide.c Bad usage of "ide" command
2119 42 common/cmd_ide.c correct usage of "ide" command
2120 -43 common/cmd_ide.c No boot device
2121 43 common/cmd_ide.c boot device found
2122 -44 common/cmd_ide.c Device not available
2123 44 common/cmd_ide.c Device available
2124 -45 common/cmd_ide.c wrong partition selected
2125 45 common/cmd_ide.c partition selected
2126 -46 common/cmd_ide.c Unknown partition table
2127 46 common/cmd_ide.c valid partition table found
2128 -47 common/cmd_ide.c Invalid partition type
2129 47 common/cmd_ide.c correct partition type
2130 -48 common/cmd_ide.c Error reading Image Header on boot device
2131 48 common/cmd_ide.c reading Image Header from IDE device OK
2132 -49 common/cmd_ide.c Image header has bad magic number
2133 49 common/cmd_ide.c Image header has correct magic number
2134 -50 common/cmd_ide.c Image header has bad checksum
2135 50 common/cmd_ide.c Image header has correct checksum
2136 -51 common/cmd_ide.c Error reading Image from IDE device
2137 51 common/cmd_ide.c reading Image from IDE device OK
2138 52 common/cmd_nand.c before loading a Image from a NAND device
2139 -53 common/cmd_nand.c Bad usage of "nand" command
2140 53 common/cmd_nand.c correct usage of "nand" command
2141 -54 common/cmd_nand.c No boot device
2142 54 common/cmd_nand.c boot device found
2143 -55 common/cmd_nand.c Unknown Chip ID on boot device
2144 55 common/cmd_nand.c correct chip ID found, device available
2145 -56 common/cmd_nand.c Error reading Image Header on boot device
2146 56 common/cmd_nand.c reading Image Header from NAND device OK
2147 -57 common/cmd_nand.c Image header has bad magic number
2148 57 common/cmd_nand.c Image header has correct magic number
2149 -58 common/cmd_nand.c Error reading Image from NAND device
2150 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002151
Heiko Schocher566a4942007-06-22 19:11:54 +02002152 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002153
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002154 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002155 -64 net/eth.c no Ethernet found.
2156 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002157
Heiko Schocher566a4942007-06-22 19:11:54 +02002158 -80 common/cmd_net.c usage wrong
2159 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002160 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002161 81 common/cmd_net.c NetLoop() back without error
2162 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2163 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002164 83 common/cmd_net.c running "source" command
2165 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002166 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002167
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002168FIT uImage format:
2169
2170 Arg Where When
2171 100 common/cmd_bootm.c Kernel FIT Image has correct format
2172 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2173 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2174 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2175 102 common/cmd_bootm.c Kernel unit name specified
2176 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002177 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002178 104 common/cmd_bootm.c Got kernel subimage node offset
2179 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2180 105 common/cmd_bootm.c Kernel subimage hash verification OK
2181 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2182 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002183 -106 common/cmd_bootm.c Kernel subimage has wrong type
2184 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002185 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2186 108 common/cmd_bootm.c Got kernel subimage data/size
2187 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2188 -109 common/cmd_bootm.c Can't get kernel subimage type
2189 -110 common/cmd_bootm.c Can't get kernel subimage comp
2190 -111 common/cmd_bootm.c Can't get kernel subimage os
2191 -112 common/cmd_bootm.c Can't get kernel subimage load address
2192 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2193
2194 120 common/image.c Start initial ramdisk verification
2195 -120 common/image.c Ramdisk FIT image has incorrect format
2196 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002197 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002198 -122 common/image.c Can't get configuration for ramdisk subimage
2199 123 common/image.c Ramdisk unit name specified
2200 -124 common/image.c Can't get ramdisk subimage node offset
2201 125 common/image.c Got ramdisk subimage node offset
2202 -125 common/image.c Ramdisk subimage hash verification failed
2203 126 common/image.c Ramdisk subimage hash verification OK
2204 -126 common/image.c Ramdisk subimage for unsupported architecture
2205 127 common/image.c Architecture check OK
2206 -127 common/image.c Can't get ramdisk subimage data/size
2207 128 common/image.c Got ramdisk subimage data/size
2208 129 common/image.c Can't get ramdisk load address
2209 -129 common/image.c Got ramdisk load address
2210
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002211 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002212 131 common/cmd_doc.c FIT image format OK
2213
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002214 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002215 141 common/cmd_ide.c FIT image format OK
2216
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002217 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002218 151 common/cmd_nand.c FIT image format OK
2219
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002220- Automatic software updates via TFTP server
2221 CONFIG_UPDATE_TFTP
2222 CONFIG_UPDATE_TFTP_CNT_MAX
2223 CONFIG_UPDATE_TFTP_MSEC_MAX
2224
2225 These options enable and control the auto-update feature;
2226 for a more detailed description refer to doc/README.update.
2227
2228- MTD Support (mtdparts command, UBI support)
2229 CONFIG_MTD_DEVICE
2230
2231 Adds the MTD device infrastructure from the Linux kernel.
2232 Needed for mtdparts command support.
2233
2234 CONFIG_MTD_PARTITIONS
2235
2236 Adds the MTD partitioning infrastructure from the Linux
2237 kernel. Needed for UBI support.
2238
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002239
wdenkc6097192002-11-03 00:24:07 +00002240Modem Support:
2241--------------
2242
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002243[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002244
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002245- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002246 CONFIG_MODEM_SUPPORT
2247
2248- RTS/CTS Flow control enable:
2249 CONFIG_HWFLOW
2250
2251- Modem debug support:
2252 CONFIG_MODEM_SUPPORT_DEBUG
2253
wdenk43d96162003-03-06 00:02:04 +00002254 Enables debugging stuff (char screen[1024], dbg())
2255 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002256
wdenka8c7c702003-12-06 19:49:23 +00002257- Interrupt support (PPC):
2258
wdenkd4ca31c2004-01-02 14:00:00 +00002259 There are common interrupt_init() and timer_interrupt()
2260 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002261 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002262 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002263 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002264 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002265 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002266 specific handling. If board has watchdog / status_led
2267 / other_activity_monitor it works automatically from
2268 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002269
wdenkc6097192002-11-03 00:24:07 +00002270- General:
2271
wdenk43d96162003-03-06 00:02:04 +00002272 In the target system modem support is enabled when a
2273 specific key (key combination) is pressed during
2274 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002275 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002276 board_init(). Currently key_pressed() is a dummy
2277 function, returning 1 and thus enabling modem
2278 initialization.
wdenkc6097192002-11-03 00:24:07 +00002279
wdenk43d96162003-03-06 00:02:04 +00002280 If there are no modem init strings in the
2281 environment, U-Boot proceed to autoboot; the
2282 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002283 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002284
2285 See also: doc/README.Modem
2286
2287
wdenkc6097192002-11-03 00:24:07 +00002288Configuration Settings:
2289-----------------------
2290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002291- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002292 undefine this when you're short of memory.
2293
Peter Tyser2fb26042009-01-27 18:03:12 -06002294- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2295 width of the commands listed in the 'help' command output.
2296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002297- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002298 prompt for user input.
2299
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002300- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002301
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002302- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002304- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002305
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002306- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002307 the application (usually a Linux kernel) when it is
2308 booted
2309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002310- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002311 List of legal baudrate settings for this board.
2312
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002313- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002314 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002315
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002316- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002317 If the board specific function
2318 extern int overwrite_console (void);
2319 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002320 serial port, else the settings in the environment are used.
2321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002322- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002323 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002325- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002326 Enable overwrite of previous console environment settings.
2327
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002328- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002329 Begin and End addresses of the area used by the
2330 simple memory test.
2331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002332- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002333 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002335- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002336 Scratch address used by the alternate memory test
2337 You only need to set this if address zero isn't writeable
2338
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002339- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2340 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002341 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002342 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002343 fixing up gd->ram_size the Linux kernel should gets passed
2344 the now "corrected" memory size and won't touch it either.
2345 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002346 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002347 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002348 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002349
2350 This option can be used as a workaround for the 440EPx/GRx
2351 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2352 be touched.
2353
2354 WARNING: Please make sure that this value is a multiple of
2355 the Linux page size (normally 4k). If this is not the case,
2356 then the end address of the Linux memory will be located at a
2357 non page size aligned address and this could cause major
2358 problems.
2359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002360- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002361 Default load address for network file downloads
2362
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002363- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002364 Enable temporary baudrate change while serial download
2365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002366- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002367 Physical start address of SDRAM. _Must_ be 0 here.
2368
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002369- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002370 Physical start address of Motherboard I/O (if using a
2371 Cogent motherboard)
2372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002373- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002374 Physical start address of Flash memory.
2375
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002376- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002377 Physical start address of boot monitor code (set by
2378 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002379 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002380 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002381
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002382- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002383 Size of memory reserved for monitor code, used to
2384 determine _at_compile_time_ (!) if the environment is
2385 embedded within the U-Boot image, or in a separate
2386 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002388- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002389 Size of DRAM reserved for malloc() use.
2390
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002391- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002392 Normally compressed uImages are limited to an
2393 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002394 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002395 to adjust this setting to your needs.
2396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002397- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002398 Maximum size of memory mapped by the startup code of
2399 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002400 the Linux kernel (bd_info, boot arguments, FDT blob if
2401 used) must be put below this limit, unless "bootm_low"
2402 enviroment variable is defined and non-zero. In such case
2403 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002404 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2405 variable "bootm_mapsize" will override the value of
2406 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2407 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002408
John Rigbyfca43cc2010-10-13 13:57:35 -06002409- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2410 Enable initrd_high functionality. If defined then the
2411 initrd_high feature is enabled and the bootm ramdisk subcommand
2412 is enabled.
2413
2414- CONFIG_SYS_BOOT_GET_CMDLINE:
2415 Enables allocating and saving kernel cmdline in space between
2416 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2417
2418- CONFIG_SYS_BOOT_GET_KBD:
2419 Enables allocating and saving a kernel copy of the bd_info in
2420 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2421
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002422- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002423 Max number of Flash memory banks
2424
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002425- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002426 Max number of sectors on a Flash chip
2427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002428- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002429 Timeout for Flash erase operations (in ms)
2430
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002431- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002432 Timeout for Flash write operations (in ms)
2433
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002434- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002435 Timeout for Flash set sector lock bit operation (in ms)
2436
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002437- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002438 Timeout for Flash clear lock bits operation (in ms)
2439
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002440- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002441 If defined, hardware flash sectors protection is used
2442 instead of U-Boot software protection.
2443
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002444- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002445
2446 Enable TFTP transfers directly to flash memory;
2447 without this option such a download has to be
2448 performed in two steps: (1) download to RAM, and (2)
2449 copy from RAM to flash.
2450
2451 The two-step approach is usually more reliable, since
2452 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002453 the flash, but in some situations (when system RAM is
2454 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002455 downloaded image) this option may be very useful.
2456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002457- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002458 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002459 common flash structure for storing flash geometry.
2460
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002461- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002462 This option also enables the building of the cfi_flash driver
2463 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002464
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002465- CONFIG_FLASH_CFI_MTD
2466 This option enables the building of the cfi_mtd driver
2467 in the drivers directory. The driver exports CFI flash
2468 to the MTD layer.
2469
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002470- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002471 Use buffered writes to flash.
2472
2473- CONFIG_FLASH_SPANSION_S29WS_N
2474 s29ws-n MirrorBit flash has non-standard addresses for buffered
2475 write commands.
2476
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002477- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002478 If this option is defined, the common CFI flash doesn't
2479 print it's warning upon not recognized FLASH banks. This
2480 is useful, if some of the configured banks are only
2481 optionally available.
2482
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002483- CONFIG_FLASH_SHOW_PROGRESS
2484 If defined (must be an integer), print out countdown
2485 digits and dots. Recommended value: 45 (9..1) for 80
2486 column displays, 15 (3..1) for 40 column displays.
2487
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002488- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002489 Defines the number of Ethernet receive buffers. On some
2490 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002491 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2492 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002493 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002494 Defaults to 4 if not defined.
2495
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002496- CONFIG_ENV_MAX_ENTRIES
2497
Wolfgang Denk071bc922010-10-27 22:48:30 +02002498 Maximum number of entries in the hash table that is used
2499 internally to store the environment settings. The default
2500 setting is supposed to be generous and should work in most
2501 cases. This setting can be used to tune behaviour; see
2502 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002503
wdenkc6097192002-11-03 00:24:07 +00002504The following definitions that deal with the placement and management
2505of environment data (variable area); in general, we support the
2506following configurations:
2507
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002508- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002509
2510 Define this if the environment is in flash memory.
2511
2512 a) The environment occupies one whole flash sector, which is
2513 "embedded" in the text segment with the U-Boot code. This
2514 happens usually with "bottom boot sector" or "top boot
2515 sector" type flash chips, which have several smaller
2516 sectors at the start or the end. For instance, such a
2517 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2518 such a case you would place the environment in one of the
2519 4 kB sectors - with U-Boot code before and after it. With
2520 "top boot sector" type flash chips, you would put the
2521 environment in one of the last sectors, leaving a gap
2522 between U-Boot and the environment.
2523
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002524 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002525
2526 Offset of environment data (variable area) to the
2527 beginning of flash memory; for instance, with bottom boot
2528 type flash chips the second sector can be used: the offset
2529 for this sector is given here.
2530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002531 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002532
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002533 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002534
2535 This is just another way to specify the start address of
2536 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002537 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002538
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002539 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002540
2541 Size of the sector containing the environment.
2542
2543
2544 b) Sometimes flash chips have few, equal sized, BIG sectors.
2545 In such a case you don't want to spend a whole sector for
2546 the environment.
2547
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002548 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002549
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002550 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002551 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002552 of this flash sector for the environment. This saves
2553 memory for the RAM copy of the environment.
2554
2555 It may also save flash memory if you decide to use this
2556 when your environment is "embedded" within U-Boot code,
2557 since then the remainder of the flash sector could be used
2558 for U-Boot code. It should be pointed out that this is
2559 STRONGLY DISCOURAGED from a robustness point of view:
2560 updating the environment in flash makes it always
2561 necessary to erase the WHOLE sector. If something goes
2562 wrong before the contents has been restored from a copy in
2563 RAM, your target system will be dead.
2564
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002565 - CONFIG_ENV_ADDR_REDUND
2566 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002567
wdenk43d96162003-03-06 00:02:04 +00002568 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002569 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002570 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002571 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002572
2573BE CAREFUL! Any changes to the flash layout, and some changes to the
2574source code will make it necessary to adapt <board>/u-boot.lds*
2575accordingly!
2576
2577
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002578- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002579
2580 Define this if you have some non-volatile memory device
2581 (NVRAM, battery buffered SRAM) which you want to use for the
2582 environment.
2583
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002584 - CONFIG_ENV_ADDR:
2585 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002586
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002587 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002588 want to use for environment. It is assumed that this memory
2589 can just be read and written to, without any special
2590 provision.
2591
2592BE CAREFUL! The first access to the environment happens quite early
2593in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002594console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002595U-Boot will hang.
2596
2597Please note that even with NVRAM we still use a copy of the
2598environment in RAM: we could work on NVRAM directly, but we want to
2599keep settings there always unmodified except somebody uses "saveenv"
2600to save the current settings.
2601
2602
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002603- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002604
2605 Use this if you have an EEPROM or similar serial access
2606 device and a driver for it.
2607
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002608 - CONFIG_ENV_OFFSET:
2609 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002610
2611 These two #defines specify the offset and size of the
2612 environment area within the total memory of your EEPROM.
2613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002614 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002615 If defined, specified the chip address of the EEPROM device.
2616 The default address is zero.
2617
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002618 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002619 If defined, the number of bits used to address bytes in a
2620 single page in the EEPROM device. A 64 byte page, for example
2621 would require six bits.
2622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002623 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002624 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002625 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002627 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002628 The length in bytes of the EEPROM memory array address. Note
2629 that this is NOT the chip address length!
2630
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002631 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002632 EEPROM chips that implement "address overflow" are ones
2633 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2634 address and the extra bits end up in the "chip address" bit
2635 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2636 byte chips.
2637
2638 Note that we consider the length of the address field to
2639 still be one byte because the extra address bits are hidden
2640 in the chip address.
2641
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002642 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002643 The size in bytes of the EEPROM device.
2644
Heiko Schocher548738b2010-01-07 08:55:40 +01002645 - CONFIG_ENV_EEPROM_IS_ON_I2C
2646 define this, if you have I2C and SPI activated, and your
2647 EEPROM, which holds the environment, is on the I2C bus.
2648
2649 - CONFIG_I2C_ENV_EEPROM_BUS
2650 if you have an Environment on an EEPROM reached over
2651 I2C muxes, you can define here, how to reach this
2652 EEPROM. For example:
2653
Wolfgang Denka9046b92010-06-13 17:48:15 +02002654 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002655
2656 EEPROM which holds the environment, is reached over
2657 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002658
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002659- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002660
wdenkd4ca31c2004-01-02 14:00:00 +00002661 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002662 want to use for the environment.
2663
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002664 - CONFIG_ENV_OFFSET:
2665 - CONFIG_ENV_ADDR:
2666 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002667
2668 These three #defines specify the offset and size of the
2669 environment area within the total memory of your DataFlash placed
2670 at the specified address.
2671
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002672- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002673
2674 Define this if you have a NAND device which you want to use
2675 for the environment.
2676
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002677 - CONFIG_ENV_OFFSET:
2678 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002679
2680 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002681 area within the first NAND device. CONFIG_ENV_OFFSET must be
2682 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002683
Scott Woodfdd813d2010-09-17 14:38:37 -05002684 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002685
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002686 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002687 size used to hold a redundant copy of the environment data, so
2688 that there is a valid backup copy in case there is a power failure
2689 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2690 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002691
Scott Woodfdd813d2010-09-17 14:38:37 -05002692 - CONFIG_ENV_RANGE (optional):
2693
2694 Specifies the length of the region in which the environment
2695 can be written. This should be a multiple of the NAND device's
2696 block size. Specifying a range with more erase blocks than
2697 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2698 the range to be avoided.
2699
2700 - CONFIG_ENV_OFFSET_OOB (optional):
2701
2702 Enables support for dynamically retrieving the offset of the
2703 environment from block zero's out-of-band data. The
2704 "nand env.oob" command can be used to record this offset.
2705 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2706 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002707
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002708- CONFIG_NAND_ENV_DST
2709
2710 Defines address in RAM to which the nand_spl code should copy the
2711 environment. If redundant environment is used, it will be copied to
2712 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002714- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002715
2716 Defines offset to the initial SPI buffer area in DPRAM. The
2717 area is used at an early stage (ROM part) if the environment
2718 is configured to reside in the SPI EEPROM: We need a 520 byte
2719 scratch DPRAM area. It is used between the two initialization
2720 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2721 to be a good choice since it makes it far enough from the
2722 start of the data area as well as from the stack pointer.
2723
Bruce Adlere881cb52007-11-02 13:15:42 -07002724Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002725has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002726created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002727until then to read environment variables.
2728
wdenk85ec0bc2003-03-31 16:34:49 +00002729The environment is protected by a CRC32 checksum. Before the monitor
2730is relocated into RAM, as a result of a bad CRC you will be working
2731with the compiled-in default environment - *silently*!!! [This is
2732necessary, because the first environment variable we need is the
2733"baudrate" setting for the console - if we have a bad CRC, we don't
2734have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002735
2736Note: once the monitor has been relocated, then it will complain if
2737the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002738use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002739
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002740- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002741 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002743 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002744 also needs to be defined.
2745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002746- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002747 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002748
Ron Madridf5675aa2009-02-18 14:30:44 -08002749- CONFIG_NS16550_MIN_FUNCTIONS:
2750 Define this if you desire to only have use of the NS16550_init
2751 and NS16550_putc functions for the serial driver located at
2752 drivers/serial/ns16550.c. This option is useful for saving
2753 space for already greatly restricted images, including but not
2754 limited to NAND_SPL configurations.
2755
wdenkc6097192002-11-03 00:24:07 +00002756Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002757---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002758
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002759- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002760 Cache Line Size of the CPU.
2761
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002762- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002763 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002764
wdenk42d1f032003-10-15 23:53:47 +00002765 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2766 and RPXsuper) to be able to adjust the position of
2767 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002768
wdenk7f6c2cb2002-11-10 22:06:23 +00002769- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002770 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002771
2772 the default drive number (default value 0)
2773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002774 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002775
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002776 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002777 (default value 1)
2778
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002779 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002780
wdenk43d96162003-03-06 00:02:04 +00002781 defines the offset of register from address. It
2782 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002783 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002784
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002785 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2786 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002787 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002789 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002790 fdc_hw_init() is called at the beginning of the FDC
2791 setup. fdc_hw_init() must be provided by the board
2792 source code. It is used to make hardware dependant
2793 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002794
Macpaul Lin0abddf82011-04-11 20:45:32 +00002795- CONFIG_IDE_AHB:
2796 Most IDE controllers were designed to be connected with PCI
2797 interface. Only few of them were designed for AHB interface.
2798 When software is doing ATA command and data transfer to
2799 IDE devices through IDE-AHB controller, some additional
2800 registers accessing to these kind of IDE-AHB controller
2801 is requierd.
2802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002804 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002805 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002807- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002808
wdenk7152b1d2003-09-05 23:19:14 +00002809 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002810 initial data and stack; please note that this must be
2811 writable memory that is working WITHOUT special
2812 initialization, i. e. you CANNOT use normal RAM which
2813 will become available only after programming the
2814 memory controller and running certain initialization
2815 sequences.
2816
2817 U-Boot uses the following memory types:
2818 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2819 - MPC824X: data cache
2820 - PPC4xx: data cache
2821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002822- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002823
2824 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002825 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2826 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002827 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002828 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002829 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2830 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2831 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002832
2833 Note:
2834 On the MPC824X (or other systems that use the data
2835 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002836 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002837 point to an otherwise UNUSED address space between
2838 the top of RAM and the start of the PCI space.
2839
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002840- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002842- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002844- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002845
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002846- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002847
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002848- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002849
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002850- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002851
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002852- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002853 SDRAM timing
2854
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002855- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002856 periodic timer for refresh
2857
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002858- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002859
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002860- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2861 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2862 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2863 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002864 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2865
2866- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002867 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2868 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002869 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2870
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002871- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2872 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002873 Machine Mode Register and Memory Periodic Timer
2874 Prescaler definitions (SDRAM timing)
2875
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002876- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002877 enable I2C microcode relocation patch (MPC8xx);
2878 define relocation offset in DPRAM [DSP2]
2879
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002880- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002881 enable SMC microcode relocation patch (MPC8xx);
2882 define relocation offset in DPRAM [SMC1]
2883
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002884- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002885 enable SPI microcode relocation patch (MPC8xx);
2886 define relocation offset in DPRAM [SCC4]
2887
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002888- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002889 Use OSCM clock mode on MBX8xx board. Be careful,
2890 wrong setting might damage your board. Read
2891 doc/README.MBX before setting this variable!
2892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002893- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002894 Offset of the bootmode word in DPRAM used by post
2895 (Power On Self Tests). This definition overrides
2896 #define'd default value in commproc.h resp.
2897 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002898
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002899- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2900 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2901 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2902 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2903 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2904 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2905 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2906 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002907 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002908
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002909- CONFIG_PCI_DISABLE_PCIE:
2910 Disable PCI-Express on systems where it is supported but not
2911 required.
2912
Kumar Galaa09b9b62010-12-30 12:09:53 -06002913- CONFIG_SYS_SRIO:
2914 Chip has SRIO or not
2915
2916- CONFIG_SRIO1:
2917 Board has SRIO 1 port available
2918
2919- CONFIG_SRIO2:
2920 Board has SRIO 2 port available
2921
2922- CONFIG_SYS_SRIOn_MEM_VIRT:
2923 Virtual Address of SRIO port 'n' memory region
2924
2925- CONFIG_SYS_SRIOn_MEM_PHYS:
2926 Physical Address of SRIO port 'n' memory region
2927
2928- CONFIG_SYS_SRIOn_MEM_SIZE:
2929 Size of SRIO port 'n' memory region
2930
Alex Watermaneced4622011-05-19 15:08:36 -04002931- CONFIG_SYS_NDFC_16
2932 Defined to tell the NDFC that the NAND chip is using a
2933 16 bit bus.
2934
2935- CONFIG_SYS_NDFC_EBC0_CFG
2936 Sets the EBC0_CFG register for the NDFC. If not defined
2937 a default value will be used.
2938
Ben Warrenbb99ad62006-09-07 16:50:54 -04002939- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002940 Get DDR timing information from an I2C EEPROM. Common
2941 with pluggable memory modules such as SODIMMs
2942
Ben Warrenbb99ad62006-09-07 16:50:54 -04002943 SPD_EEPROM_ADDRESS
2944 I2C address of the SPD EEPROM
2945
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002946- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002947 If SPD EEPROM is on an I2C bus other than the first
2948 one, specify here. Note that the value must resolve
2949 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002951- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002952 Only for 83xx systems. If specified, then DDR should
2953 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002954
wdenkc26e4542004-04-18 10:13:26 +00002955- CONFIG_ETHER_ON_FEC[12]
2956 Define to enable FEC[12] on a 8xx series processor.
2957
2958- CONFIG_FEC[12]_PHY
2959 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002960 to the given FEC; i. e.
2961 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002962 means that the PHY with address 4 is connected to FEC1
2963
2964 When set to -1, means to probe for first available.
2965
2966- CONFIG_FEC[12]_PHY_NORXERR
2967 The PHY does not have a RXERR line (RMII only).
2968 (so program the FEC to ignore it).
2969
2970- CONFIG_RMII
2971 Enable RMII mode for all FECs.
2972 Note that this is a global option, we can't
2973 have one FEC in standard MII mode and another in RMII mode.
2974
wdenk5cf91d62004-04-23 20:32:05 +00002975- CONFIG_CRC32_VERIFY
2976 Add a verify option to the crc32 command.
2977 The syntax is:
2978
2979 => crc32 -v <address> <count> <crc32>
2980
2981 Where address/count indicate a memory area
2982 and crc32 is the correct crc32 which the
2983 area should have.
2984
wdenk56523f12004-07-11 17:40:54 +00002985- CONFIG_LOOPW
2986 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002987 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002988
stroese7b466642004-12-16 18:46:55 +00002989- CONFIG_MX_CYCLIC
2990 Add the "mdc" and "mwc" memory commands. These are cyclic
2991 "md/mw" commands.
2992 Examples:
2993
wdenkefe2a4d2004-12-16 21:44:03 +00002994 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002995 This command will print 4 bytes (10,11,12,13) each 500 ms.
2996
wdenkefe2a4d2004-12-16 21:44:03 +00002997 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002998 This command will write 12345678 to address 100 all 10 ms.
2999
wdenkefe2a4d2004-12-16 21:44:03 +00003000 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003001 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003002
wdenk8aa1a2d2005-04-04 12:44:11 +00003003- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003004 [ARM only] If this variable is defined, then certain
3005 low level initializations (like setting up the memory
3006 controller) are omitted and/or U-Boot does not
3007 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003008
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003009 Normally this variable MUST NOT be defined. The only
3010 exception is when U-Boot is loaded (to RAM) by some
3011 other boot loader or by a debugger which performs
3012 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003013
Magnus Liljadf812382009-06-13 20:50:00 +02003014- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02003015 Modifies the behaviour of start.S when compiling a loader
3016 that is executed before the actual U-Boot. E.g. when
3017 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003018
Matthias Weisserd8834a12011-03-10 21:36:32 +00003019- CONFIG_USE_ARCH_MEMCPY
3020 CONFIG_USE_ARCH_MEMSET
3021 If these options are used a optimized version of memcpy/memset will
3022 be used if available. These functions may be faster under some
3023 conditions but may increase the binary size.
3024
wdenkc6097192002-11-03 00:24:07 +00003025Building the Software:
3026======================
3027
Wolfgang Denk218ca722008-03-26 10:40:12 +01003028Building U-Boot has been tested in several native build environments
3029and in many different cross environments. Of course we cannot support
3030all possibly existing versions of cross development tools in all
3031(potentially obsolete) versions. In case of tool chain problems we
3032recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3033which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003034
Wolfgang Denk218ca722008-03-26 10:40:12 +01003035If you are not using a native environment, it is assumed that you
3036have GNU cross compiling tools available in your path. In this case,
3037you must set the environment variable CROSS_COMPILE in your shell.
3038Note that no changes to the Makefile or any other source files are
3039necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003040
Wolfgang Denk218ca722008-03-26 10:40:12 +01003041 $ CROSS_COMPILE=ppc_4xx-
3042 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003043
Peter Tyser2f8d3962009-03-13 18:54:51 -05003044Note: If you wish to generate Windows versions of the utilities in
3045 the tools directory you can use the MinGW toolchain
3046 (http://www.mingw.org). Set your HOST tools to the MinGW
3047 toolchain and execute 'make tools'. For example:
3048
3049 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3050
3051 Binaries such as tools/mkimage.exe will be created which can
3052 be executed on computers running Windows.
3053
Wolfgang Denk218ca722008-03-26 10:40:12 +01003054U-Boot is intended to be simple to build. After installing the
3055sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003056is done by typing:
3057
3058 make NAME_config
3059
Wolfgang Denk218ca722008-03-26 10:40:12 +01003060where "NAME_config" is the name of one of the existing configu-
3061rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003062
wdenk2729af92004-05-03 20:45:30 +00003063Note: for some board special configuration names may exist; check if
3064 additional information is available from the board vendor; for
3065 instance, the TQM823L systems are available without (standard)
3066 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003067 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003068
wdenk2729af92004-05-03 20:45:30 +00003069 make TQM823L_config
3070 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072 make TQM823L_LCD_config
3073 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003074
wdenk2729af92004-05-03 20:45:30 +00003075 etc.
wdenkc6097192002-11-03 00:24:07 +00003076
wdenkc6097192002-11-03 00:24:07 +00003077
wdenk2729af92004-05-03 20:45:30 +00003078Finally, type "make all", and you should get some working U-Boot
3079images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003080
wdenk2729af92004-05-03 20:45:30 +00003081- "u-boot.bin" is a raw binary image
3082- "u-boot" is an image in ELF binary format
3083- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003084
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003085By default the build is performed locally and the objects are saved
3086in the source directory. One of the two methods can be used to change
3087this behavior and build U-Boot to some external directory:
3088
30891. Add O= to the make command line invocations:
3090
3091 make O=/tmp/build distclean
3092 make O=/tmp/build NAME_config
3093 make O=/tmp/build all
3094
30952. Set environment variable BUILD_DIR to point to the desired location:
3096
3097 export BUILD_DIR=/tmp/build
3098 make distclean
3099 make NAME_config
3100 make all
3101
3102Note that the command line "O=" setting overrides the BUILD_DIR environment
3103variable.
3104
wdenkc6097192002-11-03 00:24:07 +00003105
wdenk2729af92004-05-03 20:45:30 +00003106Please be aware that the Makefiles assume you are using GNU make, so
3107for instance on NetBSD you might need to use "gmake" instead of
3108native "make".
wdenkc6097192002-11-03 00:24:07 +00003109
wdenkc6097192002-11-03 00:24:07 +00003110
wdenk2729af92004-05-03 20:45:30 +00003111If the system board that you have is not listed, then you will need
3112to port U-Boot to your hardware platform. To do this, follow these
3113steps:
wdenkc6097192002-11-03 00:24:07 +00003114
wdenk2729af92004-05-03 20:45:30 +000031151. Add a new configuration option for your board to the toplevel
3116 "Makefile" and to the "MAKEALL" script, using the existing
3117 entries as examples. Note that here and at many other places
3118 boards and other names are listed in alphabetical sort order. Please
3119 keep this order.
31202. Create a new directory to hold your board specific code. Add any
3121 files you need. In your board directory, you will need at least
3122 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
31233. Create a new configuration file "include/configs/<board>.h" for
3124 your board
31253. If you're porting U-Boot to a new CPU, then also create a new
3126 directory to hold your CPU specific code. Add any files you need.
31274. Run "make <board>_config" with your new name.
31285. Type "make", and you should get a working "u-boot.srec" file
3129 to be installed on your target system.
31306. Debug and solve any problems that might arise.
3131 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003132
wdenkc6097192002-11-03 00:24:07 +00003133
wdenk2729af92004-05-03 20:45:30 +00003134Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3135==============================================================
wdenkc6097192002-11-03 00:24:07 +00003136
Wolfgang Denk218ca722008-03-26 10:40:12 +01003137If you have modified U-Boot sources (for instance added a new board
3138or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003139provide feedback to the other developers. The feedback normally takes
3140the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003141official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003142
Wolfgang Denk218ca722008-03-26 10:40:12 +01003143But before you submit such a patch, please verify that your modifi-
3144cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003145the supported boards compile WITHOUT ANY compiler warnings. To do so,
3146just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003147for ALL supported system. Be warned, this will take a while. You can
3148select which (cross) compiler to use by passing a `CROSS_COMPILE'
3149environment variable to the script, i. e. to use the ELDK cross tools
3150you can type
wdenkc6097192002-11-03 00:24:07 +00003151
wdenk2729af92004-05-03 20:45:30 +00003152 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003153
wdenk2729af92004-05-03 20:45:30 +00003154or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003155
wdenk2729af92004-05-03 20:45:30 +00003156 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003157
Wolfgang Denk218ca722008-03-26 10:40:12 +01003158When using the MAKEALL script, the default behaviour is to build
3159U-Boot in the source directory. This location can be changed by
3160setting the BUILD_DIR environment variable. Also, for each target
3161built, the MAKEALL script saves two log files (<target>.ERR and
3162<target>.MAKEALL) in the <source dir>/LOG directory. This default
3163location can be changed by setting the MAKEALL_LOGDIR environment
3164variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003165
3166 export BUILD_DIR=/tmp/build
3167 export MAKEALL_LOGDIR=/tmp/log
3168 CROSS_COMPILE=ppc_8xx- MAKEALL
3169
Wolfgang Denk218ca722008-03-26 10:40:12 +01003170With the above settings build objects are saved in the /tmp/build,
3171log files are saved in the /tmp/log and the source tree remains clean
3172during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003173
3174
wdenk2729af92004-05-03 20:45:30 +00003175See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003176
wdenkc6097192002-11-03 00:24:07 +00003177
wdenk2729af92004-05-03 20:45:30 +00003178Monitor Commands - Overview:
3179============================
wdenkc6097192002-11-03 00:24:07 +00003180
wdenk2729af92004-05-03 20:45:30 +00003181go - start application at address 'addr'
3182run - run commands in an environment variable
3183bootm - boot application image from memory
3184bootp - boot image via network using BootP/TFTP protocol
3185tftpboot- boot image via network using TFTP protocol
3186 and env variables "ipaddr" and "serverip"
3187 (and eventually "gatewayip")
3188rarpboot- boot image via network using RARP/TFTP protocol
3189diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3190loads - load S-Record file over serial line
3191loadb - load binary file over serial line (kermit mode)
3192md - memory display
3193mm - memory modify (auto-incrementing)
3194nm - memory modify (constant address)
3195mw - memory write (fill)
3196cp - memory copy
3197cmp - memory compare
3198crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003199i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003200sspi - SPI utility commands
3201base - print or set address offset
3202printenv- print environment variables
3203setenv - set environment variables
3204saveenv - save environment variables to persistent storage
3205protect - enable or disable FLASH write protection
3206erase - erase FLASH memory
3207flinfo - print FLASH memory information
3208bdinfo - print Board Info structure
3209iminfo - print header information for application image
3210coninfo - print console devices and informations
3211ide - IDE sub-system
3212loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003213loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003214mtest - simple RAM test
3215icache - enable or disable instruction cache
3216dcache - enable or disable data cache
3217reset - Perform RESET of the CPU
3218echo - echo args to console
3219version - print monitor version
3220help - print online help
3221? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003222
wdenkc6097192002-11-03 00:24:07 +00003223
wdenk2729af92004-05-03 20:45:30 +00003224Monitor Commands - Detailed Description:
3225========================================
wdenkc6097192002-11-03 00:24:07 +00003226
wdenk2729af92004-05-03 20:45:30 +00003227TODO.
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk2729af92004-05-03 20:45:30 +00003229For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003230
3231
wdenk2729af92004-05-03 20:45:30 +00003232Environment Variables:
3233======================
wdenkc6097192002-11-03 00:24:07 +00003234
wdenk2729af92004-05-03 20:45:30 +00003235U-Boot supports user configuration using Environment Variables which
3236can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk2729af92004-05-03 20:45:30 +00003238Environment Variables are set using "setenv", printed using
3239"printenv", and saved to Flash using "saveenv". Using "setenv"
3240without a value can be used to delete a variable from the
3241environment. As long as you don't save the environment you are
3242working with an in-memory copy. In case the Flash area containing the
3243environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003244
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003245Some configuration options can be set using Environment Variables.
3246
3247List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003248
wdenk2729af92004-05-03 20:45:30 +00003249 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003250
wdenk2729af92004-05-03 20:45:30 +00003251 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003252
wdenk2729af92004-05-03 20:45:30 +00003253 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003254
wdenk2729af92004-05-03 20:45:30 +00003255 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003256
wdenk2729af92004-05-03 20:45:30 +00003257 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003258
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003259 bootm_low - Memory range available for image processing in the bootm
3260 command can be restricted. This variable is given as
3261 a hexadecimal number and defines lowest address allowed
3262 for use by the bootm command. See also "bootm_size"
3263 environment variable. Address defined by "bootm_low" is
3264 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003265 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3266 bootm_mapsize.
3267
3268 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3269 This variable is given as a hexadecimal number and it
3270 defines the size of the memory region starting at base
3271 address bootm_low that is accessible by the Linux kernel
3272 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3273 as the default value if it is defined, and bootm_size is
3274 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003275
3276 bootm_size - Memory range available for image processing in the bootm
3277 command can be restricted. This variable is given as
3278 a hexadecimal number and defines the size of the region
3279 allowed for use by the bootm command. See also "bootm_low"
3280 environment variable.
3281
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003282 updatefile - Location of the software update file on a TFTP server, used
3283 by the automatic software update feature. Please refer to
3284 documentation in doc/README.update for more details.
3285
wdenk2729af92004-05-03 20:45:30 +00003286 autoload - if set to "no" (any string beginning with 'n'),
3287 "bootp" will just load perform a lookup of the
3288 configuration from the BOOTP server, but not try to
3289 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003290
wdenk2729af92004-05-03 20:45:30 +00003291 autostart - if set to "yes", an image loaded using the "bootp",
3292 "rarpboot", "tftpboot" or "diskboot" commands will
3293 be automatically started (by internally calling
3294 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003295
wdenk2729af92004-05-03 20:45:30 +00003296 If set to "no", a standalone image passed to the
3297 "bootm" command will be copied to the load address
3298 (and eventually uncompressed), but NOT be started.
3299 This can be used to load and uncompress arbitrary
3300 data.
wdenkc6097192002-11-03 00:24:07 +00003301
wdenk17ea1172004-06-06 21:51:03 +00003302 i2cfast - (PPC405GP|PPC405EP only)
3303 if set to 'y' configures Linux I2C driver for fast
3304 mode (400kHZ). This environment variable is used in
3305 initialization code. So, for changes to be effective
3306 it must be saved and board must be reset.
3307
wdenk2729af92004-05-03 20:45:30 +00003308 initrd_high - restrict positioning of initrd images:
3309 If this variable is not set, initrd images will be
3310 copied to the highest possible address in RAM; this
3311 is usually what you want since it allows for
3312 maximum initrd size. If for some reason you want to
3313 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003314 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003315 variable to a value of "no" or "off" or "0".
3316 Alternatively, you can set it to a maximum upper
3317 address to use (U-Boot will still check that it
3318 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003319
wdenk2729af92004-05-03 20:45:30 +00003320 For instance, when you have a system with 16 MB
3321 RAM, and want to reserve 4 MB from use by Linux,
3322 you can do this by adding "mem=12M" to the value of
3323 the "bootargs" variable. However, now you must make
3324 sure that the initrd image is placed in the first
3325 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003326
wdenk2729af92004-05-03 20:45:30 +00003327 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329 If you set initrd_high to 0xFFFFFFFF, this is an
3330 indication to U-Boot that all addresses are legal
3331 for the Linux kernel, including addresses in flash
3332 memory. In this case U-Boot will NOT COPY the
3333 ramdisk at all. This may be useful to reduce the
3334 boot time on your system, but requires that this
3335 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003336
wdenk2729af92004-05-03 20:45:30 +00003337 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003338
wdenk2729af92004-05-03 20:45:30 +00003339 loadaddr - Default load address for commands like "bootp",
3340 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003341
wdenk2729af92004-05-03 20:45:30 +00003342 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003343
wdenk2729af92004-05-03 20:45:30 +00003344 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003345
wdenk2729af92004-05-03 20:45:30 +00003346 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003347
wdenk2729af92004-05-03 20:45:30 +00003348 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003349
wdenk2729af92004-05-03 20:45:30 +00003350 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003351
wdenk2729af92004-05-03 20:45:30 +00003352 ethprime - When CONFIG_NET_MULTI is enabled controls which
3353 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003354
wdenk2729af92004-05-03 20:45:30 +00003355 ethact - When CONFIG_NET_MULTI is enabled controls which
3356 interface is currently active. For example you
3357 can do the following
wdenkc6097192002-11-03 00:24:07 +00003358
Heiko Schocher48690d82010-07-20 17:45:02 +02003359 => setenv ethact FEC
3360 => ping 192.168.0.1 # traffic sent on FEC
3361 => setenv ethact SCC
3362 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003363
Matthias Fuchse1692572008-01-17 07:45:05 +01003364 ethrotate - When set to "no" U-Boot does not go through all
3365 available network interfaces.
3366 It just stays at the currently selected interface.
3367
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003368 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003369 either succeed or fail without retrying.
3370 When set to "once" the network operation will
3371 fail when all the available network interfaces
3372 are tried once without success.
3373 Useful on scripts which control the retry operation
3374 themselves.
wdenkc6097192002-11-03 00:24:07 +00003375
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003376 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003377
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003378 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003379 UDP source port.
3380
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003381 tftpdstport - If this is set, the value is used for TFTP's UDP
3382 destination port instead of the Well Know Port 69.
3383
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003384 tftpblocksize - Block size to use for TFTP transfers; if not set,
3385 we use the TFTP server's default block size
3386
3387 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3388 seconds, minimum value is 1000 = 1 second). Defines
3389 when a packet is considered to be lost so it has to
3390 be retransmitted. The default is 5000 = 5 seconds.
3391 Lowering this value may make downloads succeed
3392 faster in networks with high packet loss rates or
3393 with unreliable TFTP servers.
3394
3395 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003396 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003397 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003398
wdenk2729af92004-05-03 20:45:30 +00003399The following environment variables may be used and automatically
3400updated by the network boot commands ("bootp" and "rarpboot"),
3401depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403 bootfile - see above
3404 dnsip - IP address of your Domain Name Server
3405 dnsip2 - IP address of your secondary Domain Name Server
3406 gatewayip - IP address of the Gateway (Router) to use
3407 hostname - Target hostname
3408 ipaddr - see above
3409 netmask - Subnet Mask
3410 rootpath - Pathname of the root filesystem on the NFS server
3411 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003412
wdenka3d991b2004-04-15 21:48:45 +00003413
wdenk2729af92004-05-03 20:45:30 +00003414There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003415
wdenk2729af92004-05-03 20:45:30 +00003416 serial# - contains hardware identification information such
3417 as type string and/or serial number
3418 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003419
wdenk2729af92004-05-03 20:45:30 +00003420These variables can be set only once (usually during manufacturing of
3421the board). U-Boot refuses to delete or overwrite these variables
3422once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003423
3424
wdenk2729af92004-05-03 20:45:30 +00003425Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003426
wdenk2729af92004-05-03 20:45:30 +00003427 ver - Contains the U-Boot version string as printed
3428 with the "version" command. This variable is
3429 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003430
wdenkc6097192002-11-03 00:24:07 +00003431
wdenk2729af92004-05-03 20:45:30 +00003432Please note that changes to some configuration parameters may take
3433only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003434
stroesec1551ea2003-04-04 15:53:41 +00003435
wdenk2729af92004-05-03 20:45:30 +00003436Command Line Parsing:
3437=====================
stroesec1551ea2003-04-04 15:53:41 +00003438
wdenk2729af92004-05-03 20:45:30 +00003439There are two different command line parsers available with U-Boot:
3440the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003441
wdenk2729af92004-05-03 20:45:30 +00003442Old, simple command line parser:
3443--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003444
wdenk2729af92004-05-03 20:45:30 +00003445- supports environment variables (through setenv / saveenv commands)
3446- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003447- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003448- special characters ('$', ';') can be escaped by prefixing with '\',
3449 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003450 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003451- You can also escape text by enclosing in single apostrophes, for example:
3452 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003453
wdenk2729af92004-05-03 20:45:30 +00003454Hush shell:
3455-----------
wdenkf07771c2003-05-28 08:06:31 +00003456
wdenk2729af92004-05-03 20:45:30 +00003457- similar to Bourne shell, with control structures like
3458 if...then...else...fi, for...do...done; while...do...done,
3459 until...do...done, ...
3460- supports environment ("global") variables (through setenv / saveenv
3461 commands) and local shell variables (through standard shell syntax
3462 "name=value"); only environment variables can be used with "run"
3463 command
wdenkf07771c2003-05-28 08:06:31 +00003464
wdenk2729af92004-05-03 20:45:30 +00003465General rules:
3466--------------
wdenkf07771c2003-05-28 08:06:31 +00003467
wdenk2729af92004-05-03 20:45:30 +00003468(1) If a command line (or an environment variable executed by a "run"
3469 command) contains several commands separated by semicolon, and
3470 one of these commands fails, then the remaining commands will be
3471 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003472
wdenk2729af92004-05-03 20:45:30 +00003473(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003474 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003475 command will cause "run" to terminate, i. e. the remaining
3476 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003477
wdenk2729af92004-05-03 20:45:30 +00003478Note for Redundant Ethernet Interfaces:
3479=======================================
wdenkf07771c2003-05-28 08:06:31 +00003480
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003481Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003482such configurations and is capable of automatic selection of a
3483"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003484
wdenk2729af92004-05-03 20:45:30 +00003485Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3486MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3487"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003488
wdenk2729af92004-05-03 20:45:30 +00003489If the network interface stores some valid MAC address (for instance
3490in SROM), this is used as default address if there is NO correspon-
3491ding setting in the environment; if the corresponding environment
3492variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003493
wdenk2729af92004-05-03 20:45:30 +00003494o If the SROM has a valid MAC address, and there is no address in the
3495 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003496
wdenk2729af92004-05-03 20:45:30 +00003497o If there is no valid address in the SROM, and a definition in the
3498 environment exists, then the value from the environment variable is
3499 used.
wdenkc6097192002-11-03 00:24:07 +00003500
wdenk2729af92004-05-03 20:45:30 +00003501o If both the SROM and the environment contain a MAC address, and
3502 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504o If both the SROM and the environment contain a MAC address, and the
3505 addresses differ, the value from the environment is used and a
3506 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk2729af92004-05-03 20:45:30 +00003508o If neither SROM nor the environment contain a MAC address, an error
3509 is raised.
wdenkc6097192002-11-03 00:24:07 +00003510
Ben Warrenecee9322010-04-26 11:11:46 -07003511If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3512will be programmed into hardware as part of the initialization process. This
3513may be skipped by setting the appropriate 'ethmacskip' environment variable.
3514The naming convention is as follows:
3515"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003516
wdenk2729af92004-05-03 20:45:30 +00003517Image Formats:
3518==============
wdenkc6097192002-11-03 00:24:07 +00003519
Marian Balakowicz3310c542008-03-12 12:13:13 +01003520U-Boot is capable of booting (and performing other auxiliary operations on)
3521images in two formats:
3522
3523New uImage format (FIT)
3524-----------------------
3525
3526Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3527to Flattened Device Tree). It allows the use of images with multiple
3528components (several kernels, ramdisks, etc.), with contents protected by
3529SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3530
3531
3532Old uImage format
3533-----------------
3534
3535Old image format is based on binary files which can be basically anything,
3536preceded by a special header; see the definitions in include/image.h for
3537details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk2729af92004-05-03 20:45:30 +00003539* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3540 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003541 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3542 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3543 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003544* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003545 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3546 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003547* Compression Type (uncompressed, gzip, bzip2)
3548* Load Address
3549* Entry Point
3550* Image Name
3551* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk2729af92004-05-03 20:45:30 +00003553The header is marked by a special Magic Number, and both the header
3554and the data portions of the image are secured against corruption by
3555CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003556
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk2729af92004-05-03 20:45:30 +00003558Linux Support:
3559==============
wdenkc6097192002-11-03 00:24:07 +00003560
wdenk2729af92004-05-03 20:45:30 +00003561Although U-Boot should support any OS or standalone application
3562easily, the main focus has always been on Linux during the design of
3563U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003564
wdenk2729af92004-05-03 20:45:30 +00003565U-Boot includes many features that so far have been part of some
3566special "boot loader" code within the Linux kernel. Also, any
3567"initrd" images to be used are no longer part of one big Linux image;
3568instead, kernel and "initrd" are separate images. This implementation
3569serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003570
wdenk2729af92004-05-03 20:45:30 +00003571- the same features can be used for other OS or standalone
3572 applications (for instance: using compressed images to reduce the
3573 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003574
wdenk2729af92004-05-03 20:45:30 +00003575- it becomes much easier to port new Linux kernel versions because
3576 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003577
wdenk2729af92004-05-03 20:45:30 +00003578- the same Linux kernel image can now be used with different "initrd"
3579 images; of course this also means that different kernel images can
3580 be run with the same "initrd". This makes testing easier (you don't
3581 have to build a new "zImage.initrd" Linux image when you just
3582 change a file in your "initrd"). Also, a field-upgrade of the
3583 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003584
wdenkc6097192002-11-03 00:24:07 +00003585
wdenk2729af92004-05-03 20:45:30 +00003586Linux HOWTO:
3587============
wdenkc6097192002-11-03 00:24:07 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589Porting Linux to U-Boot based systems:
3590---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk2729af92004-05-03 20:45:30 +00003592U-Boot cannot save you from doing all the necessary modifications to
3593configure the Linux device drivers for use with your target hardware
3594(no, we don't intend to provide a full virtual machine interface to
3595Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003596
Stefan Roesea47a12b2010-04-15 16:07:28 +02003597But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003598
wdenk2729af92004-05-03 20:45:30 +00003599Just make sure your machine specific header file (for instance
3600include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003601Information structure as we define in include/asm-<arch>/u-boot.h,
3602and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003603as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003604
wdenkc6097192002-11-03 00:24:07 +00003605
wdenk2729af92004-05-03 20:45:30 +00003606Configuring the Linux kernel:
3607-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003608
wdenk2729af92004-05-03 20:45:30 +00003609No specific requirements for U-Boot. Make sure you have some root
3610device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003611
wdenkc6097192002-11-03 00:24:07 +00003612
wdenk2729af92004-05-03 20:45:30 +00003613Building a Linux Image:
3614-----------------------
wdenkc6097192002-11-03 00:24:07 +00003615
wdenk2729af92004-05-03 20:45:30 +00003616With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3617not used. If you use recent kernel source, a new build target
3618"uImage" will exist which automatically builds an image usable by
3619U-Boot. Most older kernels also have support for a "pImage" target,
3620which was introduced for our predecessor project PPCBoot and uses a
3621100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003622
wdenk2729af92004-05-03 20:45:30 +00003623Example:
wdenkc6097192002-11-03 00:24:07 +00003624
wdenk2729af92004-05-03 20:45:30 +00003625 make TQM850L_config
3626 make oldconfig
3627 make dep
3628 make uImage
wdenkc6097192002-11-03 00:24:07 +00003629
wdenk2729af92004-05-03 20:45:30 +00003630The "uImage" build target uses a special tool (in 'tools/mkimage') to
3631encapsulate a compressed Linux kernel image with header information,
3632CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003633
wdenk2729af92004-05-03 20:45:30 +00003634* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003635
wdenk2729af92004-05-03 20:45:30 +00003636* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003637
wdenk2729af92004-05-03 20:45:30 +00003638 ${CROSS_COMPILE}-objcopy -O binary \
3639 -R .note -R .comment \
3640 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003641
wdenk2729af92004-05-03 20:45:30 +00003642* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003643
wdenk2729af92004-05-03 20:45:30 +00003644 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003645
wdenk2729af92004-05-03 20:45:30 +00003646* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003647
wdenk2729af92004-05-03 20:45:30 +00003648 mkimage -A ppc -O linux -T kernel -C gzip \
3649 -a 0 -e 0 -n "Linux Kernel Image" \
3650 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003651
wdenk24ee89b2002-11-03 17:56:27 +00003652
wdenk2729af92004-05-03 20:45:30 +00003653The "mkimage" tool can also be used to create ramdisk images for use
3654with U-Boot, either separated from the Linux kernel image, or
3655combined into one file. "mkimage" encapsulates the images with a 64
3656byte header containing information about target architecture,
3657operating system, image type, compression method, entry points, time
3658stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003659
wdenk2729af92004-05-03 20:45:30 +00003660"mkimage" can be called in two ways: to verify existing images and
3661print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003662
wdenk2729af92004-05-03 20:45:30 +00003663In the first form (with "-l" option) mkimage lists the information
3664contained in the header of an existing U-Boot image; this includes
3665checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667 tools/mkimage -l image
3668 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003669
wdenk2729af92004-05-03 20:45:30 +00003670The second form (with "-d" option) is used to build a U-Boot image
3671from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003672
wdenk2729af92004-05-03 20:45:30 +00003673 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3674 -n name -d data_file image
3675 -A ==> set architecture to 'arch'
3676 -O ==> set operating system to 'os'
3677 -T ==> set image type to 'type'
3678 -C ==> set compression type 'comp'
3679 -a ==> set load address to 'addr' (hex)
3680 -e ==> set entry point to 'ep' (hex)
3681 -n ==> set image name to 'name'
3682 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003683
wdenk69459792004-05-29 16:53:29 +00003684Right now, all Linux kernels for PowerPC systems use the same load
3685address (0x00000000), but the entry point address depends on the
3686kernel version:
wdenkc6097192002-11-03 00:24:07 +00003687
wdenk2729af92004-05-03 20:45:30 +00003688- 2.2.x kernels have the entry point at 0x0000000C,
3689- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003690
wdenk2729af92004-05-03 20:45:30 +00003691So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003692
wdenk2729af92004-05-03 20:45:30 +00003693 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3694 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003695 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003696 > examples/uImage.TQM850L
3697 Image Name: 2.4.4 kernel for TQM850L
3698 Created: Wed Jul 19 02:34:59 2000
3699 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3700 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3701 Load Address: 0x00000000
3702 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003703
wdenk2729af92004-05-03 20:45:30 +00003704To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003705
wdenk2729af92004-05-03 20:45:30 +00003706 -> tools/mkimage -l examples/uImage.TQM850L
3707 Image Name: 2.4.4 kernel for TQM850L
3708 Created: Wed Jul 19 02:34:59 2000
3709 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3710 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3711 Load Address: 0x00000000
3712 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003713
wdenk2729af92004-05-03 20:45:30 +00003714NOTE: for embedded systems where boot time is critical you can trade
3715speed for memory and install an UNCOMPRESSED image instead: this
3716needs more space in Flash, but boots much faster since it does not
3717need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003718
Stefan Roesea47a12b2010-04-15 16:07:28 +02003719 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003720 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3721 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003722 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003723 > examples/uImage.TQM850L-uncompressed
3724 Image Name: 2.4.4 kernel for TQM850L
3725 Created: Wed Jul 19 02:34:59 2000
3726 Image Type: PowerPC Linux Kernel Image (uncompressed)
3727 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3728 Load Address: 0x00000000
3729 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003730
wdenkc6097192002-11-03 00:24:07 +00003731
wdenk2729af92004-05-03 20:45:30 +00003732Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3733when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003734
wdenk2729af92004-05-03 20:45:30 +00003735 -> tools/mkimage -n 'Simple Ramdisk Image' \
3736 > -A ppc -O linux -T ramdisk -C gzip \
3737 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3738 Image Name: Simple Ramdisk Image
3739 Created: Wed Jan 12 14:01:50 2000
3740 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3741 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3742 Load Address: 0x00000000
3743 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003744
wdenkdb01a2e2004-04-15 23:14:49 +00003745
wdenk2729af92004-05-03 20:45:30 +00003746Installing a Linux Image:
3747-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003748
wdenk2729af92004-05-03 20:45:30 +00003749To downloading a U-Boot image over the serial (console) interface,
3750you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003751
wdenk2729af92004-05-03 20:45:30 +00003752 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003753
wdenk2729af92004-05-03 20:45:30 +00003754The 'objcopy' does not understand the information in the U-Boot
3755image header, so the resulting S-Record file will be relative to
3756address 0x00000000. To load it to a given address, you need to
3757specify the target address as 'offset' parameter with the 'loads'
3758command.
wdenkc6097192002-11-03 00:24:07 +00003759
wdenk2729af92004-05-03 20:45:30 +00003760Example: install the image to address 0x40100000 (which on the
3761TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003762
wdenk2729af92004-05-03 20:45:30 +00003763 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003764
wdenk2729af92004-05-03 20:45:30 +00003765 .......... done
3766 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003767
wdenk2729af92004-05-03 20:45:30 +00003768 => loads 40100000
3769 ## Ready for S-Record download ...
3770 ~>examples/image.srec
3771 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3772 ...
3773 15989 15990 15991 15992
3774 [file transfer complete]
3775 [connected]
3776 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003777
3778
wdenk2729af92004-05-03 20:45:30 +00003779You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003780this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003781corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003782
wdenk2729af92004-05-03 20:45:30 +00003783 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003784
wdenk2729af92004-05-03 20:45:30 +00003785 ## Checking Image at 40100000 ...
3786 Image Name: 2.2.13 for initrd on TQM850L
3787 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3788 Data Size: 335725 Bytes = 327 kB = 0 MB
3789 Load Address: 00000000
3790 Entry Point: 0000000c
3791 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003792
3793
wdenk2729af92004-05-03 20:45:30 +00003794Boot Linux:
3795-----------
wdenkc6097192002-11-03 00:24:07 +00003796
wdenk2729af92004-05-03 20:45:30 +00003797The "bootm" command is used to boot an application that is stored in
3798memory (RAM or Flash). In case of a Linux kernel image, the contents
3799of the "bootargs" environment variable is passed to the kernel as
3800parameters. You can check and modify this variable using the
3801"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003802
3803
wdenk2729af92004-05-03 20:45:30 +00003804 => printenv bootargs
3805 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003806
wdenk2729af92004-05-03 20:45:30 +00003807 => 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 +00003808
wdenk2729af92004-05-03 20:45:30 +00003809 => printenv bootargs
3810 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 +00003811
wdenk2729af92004-05-03 20:45:30 +00003812 => bootm 40020000
3813 ## Booting Linux kernel at 40020000 ...
3814 Image Name: 2.2.13 for NFS on TQM850L
3815 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3816 Data Size: 381681 Bytes = 372 kB = 0 MB
3817 Load Address: 00000000
3818 Entry Point: 0000000c
3819 Verifying Checksum ... OK
3820 Uncompressing Kernel Image ... OK
3821 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
3822 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3823 time_init: decrementer frequency = 187500000/60
3824 Calibrating delay loop... 49.77 BogoMIPS
3825 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3826 ...
wdenkc6097192002-11-03 00:24:07 +00003827
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003828If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003829the memory addresses of both the kernel and the initrd image (PPBCOOT
3830format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003831
wdenk2729af92004-05-03 20:45:30 +00003832 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003833
wdenk2729af92004-05-03 20:45:30 +00003834 ## Checking Image at 40100000 ...
3835 Image Name: 2.2.13 for initrd on TQM850L
3836 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3837 Data Size: 335725 Bytes = 327 kB = 0 MB
3838 Load Address: 00000000
3839 Entry Point: 0000000c
3840 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003841
wdenk2729af92004-05-03 20:45:30 +00003842 ## Checking Image at 40200000 ...
3843 Image Name: Simple Ramdisk Image
3844 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3845 Data Size: 566530 Bytes = 553 kB = 0 MB
3846 Load Address: 00000000
3847 Entry Point: 00000000
3848 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk2729af92004-05-03 20:45:30 +00003850 => bootm 40100000 40200000
3851 ## Booting Linux kernel at 40100000 ...
3852 Image Name: 2.2.13 for initrd on TQM850L
3853 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3854 Data Size: 335725 Bytes = 327 kB = 0 MB
3855 Load Address: 00000000
3856 Entry Point: 0000000c
3857 Verifying Checksum ... OK
3858 Uncompressing Kernel Image ... OK
3859 ## Loading RAMDisk Image at 40200000 ...
3860 Image Name: Simple Ramdisk Image
3861 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3862 Data Size: 566530 Bytes = 553 kB = 0 MB
3863 Load Address: 00000000
3864 Entry Point: 00000000
3865 Verifying Checksum ... OK
3866 Loading Ramdisk ... OK
3867 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
3868 Boot arguments: root=/dev/ram
3869 time_init: decrementer frequency = 187500000/60
3870 Calibrating delay loop... 49.77 BogoMIPS
3871 ...
3872 RAMDISK: Compressed image found at block 0
3873 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk2729af92004-05-03 20:45:30 +00003875 bash#
wdenkc6097192002-11-03 00:24:07 +00003876
Matthew McClintock02677682006-06-28 10:41:37 -05003877Boot Linux and pass a flat device tree:
3878-----------
3879
3880First, U-Boot must be compiled with the appropriate defines. See the section
3881titled "Linux Kernel Interface" above for a more in depth explanation. The
3882following is an example of how to start a kernel and pass an updated
3883flat device tree:
3884
3885=> print oftaddr
3886oftaddr=0x300000
3887=> print oft
3888oft=oftrees/mpc8540ads.dtb
3889=> tftp $oftaddr $oft
3890Speed: 1000, full duplex
3891Using TSEC0 device
3892TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3893Filename 'oftrees/mpc8540ads.dtb'.
3894Load address: 0x300000
3895Loading: #
3896done
3897Bytes transferred = 4106 (100a hex)
3898=> tftp $loadaddr $bootfile
3899Speed: 1000, full duplex
3900Using TSEC0 device
3901TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3902Filename 'uImage'.
3903Load address: 0x200000
3904Loading:############
3905done
3906Bytes transferred = 1029407 (fb51f hex)
3907=> print loadaddr
3908loadaddr=200000
3909=> print oftaddr
3910oftaddr=0x300000
3911=> bootm $loadaddr - $oftaddr
3912## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003913 Image Name: Linux-2.6.17-dirty
3914 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3915 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003916 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003917 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003918 Verifying Checksum ... OK
3919 Uncompressing Kernel Image ... OK
3920Booting using flat device tree at 0x300000
3921Using MPC85xx ADS machine description
3922Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3923[snip]
3924
3925
wdenk2729af92004-05-03 20:45:30 +00003926More About U-Boot Image Types:
3927------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003928
wdenk2729af92004-05-03 20:45:30 +00003929U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003930
wdenk2729af92004-05-03 20:45:30 +00003931 "Standalone Programs" are directly runnable in the environment
3932 provided by U-Boot; it is expected that (if they behave
3933 well) you can continue to work in U-Boot after return from
3934 the Standalone Program.
3935 "OS Kernel Images" are usually images of some Embedded OS which
3936 will take over control completely. Usually these programs
3937 will install their own set of exception handlers, device
3938 drivers, set up the MMU, etc. - this means, that you cannot
3939 expect to re-enter U-Boot except by resetting the CPU.
3940 "RAMDisk Images" are more or less just data blocks, and their
3941 parameters (address, size) are passed to an OS kernel that is
3942 being started.
3943 "Multi-File Images" contain several images, typically an OS
3944 (Linux) kernel image and one or more data images like
3945 RAMDisks. This construct is useful for instance when you want
3946 to boot over the network using BOOTP etc., where the boot
3947 server provides just a single image file, but you want to get
3948 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003949
wdenk2729af92004-05-03 20:45:30 +00003950 "Multi-File Images" start with a list of image sizes, each
3951 image size (in bytes) specified by an "uint32_t" in network
3952 byte order. This list is terminated by an "(uint32_t)0".
3953 Immediately after the terminating 0 follow the images, one by
3954 one, all aligned on "uint32_t" boundaries (size rounded up to
3955 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003956
wdenk2729af92004-05-03 20:45:30 +00003957 "Firmware Images" are binary images containing firmware (like
3958 U-Boot or FPGA images) which usually will be programmed to
3959 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003960
wdenk2729af92004-05-03 20:45:30 +00003961 "Script files" are command sequences that will be executed by
3962 U-Boot's command interpreter; this feature is especially
3963 useful when you configure U-Boot to use a real shell (hush)
3964 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003965
wdenkc6097192002-11-03 00:24:07 +00003966
wdenk2729af92004-05-03 20:45:30 +00003967Standalone HOWTO:
3968=================
wdenkc6097192002-11-03 00:24:07 +00003969
wdenk2729af92004-05-03 20:45:30 +00003970One of the features of U-Boot is that you can dynamically load and
3971run "standalone" applications, which can use some resources of
3972U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003973
wdenk2729af92004-05-03 20:45:30 +00003974Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk2729af92004-05-03 20:45:30 +00003976"Hello World" Demo:
3977-------------------
wdenkc6097192002-11-03 00:24:07 +00003978
wdenk2729af92004-05-03 20:45:30 +00003979'examples/hello_world.c' contains a small "Hello World" Demo
3980application; it is automatically compiled when you build U-Boot.
3981It's configured to run at address 0x00040004, so you can play with it
3982like that:
wdenkc6097192002-11-03 00:24:07 +00003983
wdenk2729af92004-05-03 20:45:30 +00003984 => loads
3985 ## Ready for S-Record download ...
3986 ~>examples/hello_world.srec
3987 1 2 3 4 5 6 7 8 9 10 11 ...
3988 [file transfer complete]
3989 [connected]
3990 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992 => go 40004 Hello World! This is a test.
3993 ## Starting application at 0x00040004 ...
3994 Hello World
3995 argc = 7
3996 argv[0] = "40004"
3997 argv[1] = "Hello"
3998 argv[2] = "World!"
3999 argv[3] = "This"
4000 argv[4] = "is"
4001 argv[5] = "a"
4002 argv[6] = "test."
4003 argv[7] = "<NULL>"
4004 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004005
wdenk2729af92004-05-03 20:45:30 +00004006 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk2729af92004-05-03 20:45:30 +00004008Another example, which demonstrates how to register a CPM interrupt
4009handler with the U-Boot code, can be found in 'examples/timer.c'.
4010Here, a CPM timer is set up to generate an interrupt every second.
4011The interrupt service routine is trivial, just printing a '.'
4012character, but this is just a demo program. The application can be
4013controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004014
wdenk2729af92004-05-03 20:45:30 +00004015 ? - print current values og the CPM Timer registers
4016 b - enable interrupts and start timer
4017 e - stop timer and disable interrupts
4018 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004019
wdenk2729af92004-05-03 20:45:30 +00004020 => loads
4021 ## Ready for S-Record download ...
4022 ~>examples/timer.srec
4023 1 2 3 4 5 6 7 8 9 10 11 ...
4024 [file transfer complete]
4025 [connected]
4026 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004027
wdenk2729af92004-05-03 20:45:30 +00004028 => go 40004
4029 ## Starting application at 0x00040004 ...
4030 TIMERS=0xfff00980
4031 Using timer 1
4032 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk2729af92004-05-03 20:45:30 +00004034Hit 'b':
4035 [q, b, e, ?] Set interval 1000000 us
4036 Enabling timer
4037Hit '?':
4038 [q, b, e, ?] ........
4039 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4040Hit '?':
4041 [q, b, e, ?] .
4042 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4043Hit '?':
4044 [q, b, e, ?] .
4045 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4046Hit '?':
4047 [q, b, e, ?] .
4048 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4049Hit 'e':
4050 [q, b, e, ?] ...Stopping timer
4051Hit 'q':
4052 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004053
4054
wdenk2729af92004-05-03 20:45:30 +00004055Minicom warning:
4056================
wdenk85ec0bc2003-03-31 16:34:49 +00004057
wdenk2729af92004-05-03 20:45:30 +00004058Over time, many people have reported problems when trying to use the
4059"minicom" terminal emulation program for serial download. I (wd)
4060consider minicom to be broken, and recommend not to use it. Under
4061Unix, I recommend to use C-Kermit for general purpose use (and
4062especially for kermit binary protocol download ("loadb" command), and
4063use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004064
wdenk2729af92004-05-03 20:45:30 +00004065Nevertheless, if you absolutely want to use it try adding this
4066configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004067
wdenk2729af92004-05-03 20:45:30 +00004068 Name Program Name U/D FullScr IO-Red. Multi
4069 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4070 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004071
4072
wdenk2729af92004-05-03 20:45:30 +00004073NetBSD Notes:
4074=============
wdenkc6097192002-11-03 00:24:07 +00004075
wdenk2729af92004-05-03 20:45:30 +00004076Starting at version 0.9.2, U-Boot supports NetBSD both as host
4077(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk2729af92004-05-03 20:45:30 +00004079Building requires a cross environment; it is known to work on
4080NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4081need gmake since the Makefiles are not compatible with BSD make).
4082Note that the cross-powerpc package does not install include files;
4083attempting to build U-Boot will fail because <machine/ansi.h> is
4084missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004085
wdenk2729af92004-05-03 20:45:30 +00004086 # cd /usr/pkg/cross/powerpc-netbsd/include
4087 # mkdir powerpc
4088 # ln -s powerpc machine
4089 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4090 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004091
wdenk2729af92004-05-03 20:45:30 +00004092Native builds *don't* work due to incompatibilities between native
4093and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095Booting assumes that (the first part of) the image booted is a
4096stage-2 loader which in turn loads and then invokes the kernel
4097proper. Loader sources will eventually appear in the NetBSD source
4098tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004099meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004100
4101
wdenk2729af92004-05-03 20:45:30 +00004102Implementation Internals:
4103=========================
wdenkc6097192002-11-03 00:24:07 +00004104
wdenk2729af92004-05-03 20:45:30 +00004105The following is not intended to be a complete description of every
4106implementation detail. However, it should help to understand the
4107inner workings of U-Boot and make it easier to port it to custom
4108hardware.
wdenkc6097192002-11-03 00:24:07 +00004109
4110
wdenk2729af92004-05-03 20:45:30 +00004111Initial Stack, Global Data:
4112---------------------------
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114The implementation of U-Boot is complicated by the fact that U-Boot
4115starts running out of ROM (flash memory), usually without access to
4116system RAM (because the memory controller is not initialized yet).
4117This means that we don't have writable Data or BSS segments, and BSS
4118is not initialized as zero. To be able to get a C environment working
4119at all, we have to allocate at least a minimal stack. Implementation
4120options for this are defined and restricted by the CPU used: Some CPU
4121models provide on-chip memory (like the IMMR area on MPC8xx and
4122MPC826x processors), on others (parts of) the data cache can be
4123locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004124
Wolfgang Denk218ca722008-03-26 10:40:12 +01004125 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004126 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4129 From: "Chris Hallinan" <clh@net1plus.com>
4130 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4131 ...
wdenk43d96162003-03-06 00:02:04 +00004132
wdenk2729af92004-05-03 20:45:30 +00004133 Correct me if I'm wrong, folks, but the way I understand it
4134 is this: Using DCACHE as initial RAM for Stack, etc, does not
4135 require any physical RAM backing up the cache. The cleverness
4136 is that the cache is being used as a temporary supply of
4137 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004138 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004139 can see how this works by studying the cache architecture and
4140 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004141
wdenk2729af92004-05-03 20:45:30 +00004142 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4143 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004144 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004145 option should work for you. Using CS 4 should be fine if your
4146 board designers haven't used it for something that would
4147 cause you grief during the initial boot! It is frequently not
4148 used.
wdenk43d96162003-03-06 00:02:04 +00004149
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004150 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004151 with your processor/board/system design. The default value
4152 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004153 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004154 than your SDRAM module. If you have a 64MB SDRAM module, set
4155 it above 400_0000. Just make sure your board has no resources
4156 that are supposed to respond to that address! That code in
4157 start.S has been around a while and should work as is when
4158 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004159
wdenk2729af92004-05-03 20:45:30 +00004160 -Chris Hallinan
4161 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004162
wdenk2729af92004-05-03 20:45:30 +00004163It is essential to remember this, since it has some impact on the C
4164code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166* Initialized global data (data segment) is read-only. Do not attempt
4167 to write it.
wdenkc6097192002-11-03 00:24:07 +00004168
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004169* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004170 as zero data - BSS segment) at all - this is undefined, initiali-
4171 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004172
wdenk2729af92004-05-03 20:45:30 +00004173* Stack space is very limited. Avoid big data buffers or things like
4174 that.
wdenkc6097192002-11-03 00:24:07 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176Having only the stack as writable memory limits means we cannot use
4177normal global data to share information beween the code. But it
4178turned out that the implementation of U-Boot can be greatly
4179simplified by making a global data structure (gd_t) available to all
4180functions. We could pass a pointer to this data as argument to _all_
4181functions, but this would bloat the code. Instead we use a feature of
4182the GCC compiler (Global Register Variables) to share the data: we
4183place a pointer (gd) to the global data into a register which we
4184reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004185
wdenk2729af92004-05-03 20:45:30 +00004186When choosing a register for such a purpose we are restricted by the
4187relevant (E)ABI specifications for the current architecture, and by
4188GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190For PowerPC, the following registers have specific use:
4191 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004192 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004193 R3-R4: parameter passing and return values
4194 R5-R10: parameter passing
4195 R13: small data area pointer
4196 R30: GOT pointer
4197 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004198
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004199 (U-Boot also uses R12 as internal GOT pointer. r12
4200 is a volatile register so r12 needs to be reset when
4201 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004202
Wolfgang Denke7670f62008-02-14 22:43:22 +01004203 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004204
wdenk2729af92004-05-03 20:45:30 +00004205 Note: on PPC, we could use a static initializer (since the
4206 address of the global data structure is known at compile time),
4207 but it turned out that reserving a register results in somewhat
4208 smaller code - although the code savings are not that big (on
4209 average for all boards 752 bytes for the whole U-Boot image,
4210 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004211
Robin Getzc4db3352009-08-17 15:23:02 +00004212On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004213 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4214
Robin Getzc4db3352009-08-17 15:23:02 +00004215 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004216
wdenk2729af92004-05-03 20:45:30 +00004217On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004218
wdenk2729af92004-05-03 20:45:30 +00004219 R0: function argument word/integer result
4220 R1-R3: function argument word
4221 R9: GOT pointer
4222 R10: stack limit (used only if stack checking if enabled)
4223 R11: argument (frame) pointer
4224 R12: temporary workspace
4225 R13: stack pointer
4226 R14: link register
4227 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004230
Thomas Chou0df01fd2010-05-21 11:08:03 +08004231On Nios II, the ABI is documented here:
4232 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4233
4234 ==> U-Boot will use gp to hold a pointer to the global data
4235
4236 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4237 to access small data sections, so gp is free.
4238
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004239NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4240or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004241
wdenk2729af92004-05-03 20:45:30 +00004242Memory Management:
4243------------------
wdenkc6097192002-11-03 00:24:07 +00004244
wdenk2729af92004-05-03 20:45:30 +00004245U-Boot runs in system state and uses physical addresses, i.e. the
4246MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004247
wdenk2729af92004-05-03 20:45:30 +00004248The available memory is mapped to fixed addresses using the memory
4249controller. In this process, a contiguous block is formed for each
4250memory type (Flash, SDRAM, SRAM), even when it consists of several
4251physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253U-Boot is installed in the first 128 kB of the first Flash bank (on
4254TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4255booting and sizing and initializing DRAM, the code relocates itself
4256to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004257memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004258configuration setting]. Below that, a structure with global Board
4259Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk2729af92004-05-03 20:45:30 +00004261Additionally, some exception handler code is copied to the low 8 kB
4262of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264So a typical memory configuration with 16 MB of DRAM could look like
4265this:
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267 0x0000 0000 Exception Vector code
4268 :
4269 0x0000 1FFF
4270 0x0000 2000 Free for Application Use
4271 :
4272 :
wdenkc6097192002-11-03 00:24:07 +00004273
wdenk2729af92004-05-03 20:45:30 +00004274 :
4275 :
4276 0x00FB FF20 Monitor Stack (Growing downward)
4277 0x00FB FFAC Board Info Data and permanent copy of global data
4278 0x00FC 0000 Malloc Arena
4279 :
4280 0x00FD FFFF
4281 0x00FE 0000 RAM Copy of Monitor Code
4282 ... eventually: LCD or video framebuffer
4283 ... eventually: pRAM (Protected RAM - unchanged by reset)
4284 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004285
4286
wdenk2729af92004-05-03 20:45:30 +00004287System Initialization:
4288----------------------
wdenkc6097192002-11-03 00:24:07 +00004289
wdenk2729af92004-05-03 20:45:30 +00004290In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004291(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004292configuration for CS0# this is a mirror of the onboard Flash memory.
4293To be able to re-map memory U-Boot then jumps to its link address.
4294To be able to implement the initialization code in C, a (small!)
4295initial stack is set up in the internal Dual Ported RAM (in case CPUs
4296which provide such a feature like MPC8xx or MPC8260), or in a locked
4297part of the data cache. After that, U-Boot initializes the CPU core,
4298the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004299
wdenk2729af92004-05-03 20:45:30 +00004300Next, all (potentially) available memory banks are mapped using a
4301preliminary mapping. For example, we put them on 512 MB boundaries
4302(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4303on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4304programmed for SDRAM access. Using the temporary configuration, a
4305simple memory test is run that determines the size of the SDRAM
4306banks.
wdenkc6097192002-11-03 00:24:07 +00004307
wdenk2729af92004-05-03 20:45:30 +00004308When there is more than one SDRAM bank, and the banks are of
4309different size, the largest is mapped first. For equal size, the first
4310bank (CS2#) is mapped first. The first mapping is always for address
43110x00000000, with any additional banks following immediately to create
4312contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004313
wdenk2729af92004-05-03 20:45:30 +00004314Then, the monitor installs itself at the upper end of the SDRAM area
4315and allocates memory for use by malloc() and for the global Board
4316Info data; also, the exception vector code is copied to the low RAM
4317pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004318
wdenk2729af92004-05-03 20:45:30 +00004319Only after this relocation will you have a "normal" C environment;
4320until that you are restricted in several ways, mostly because you are
4321running from ROM, and because the code will have to be relocated to a
4322new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004323
4324
wdenk2729af92004-05-03 20:45:30 +00004325U-Boot Porting Guide:
4326----------------------
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk2729af92004-05-03 20:45:30 +00004328[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4329list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004330
4331
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004332int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004333{
4334 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004335
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004336 signal(SIGALRM, no_more_time);
4337 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004338
wdenk2729af92004-05-03 20:45:30 +00004339 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004340 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004341 return 0;
4342 }
4343
wdenk2729af92004-05-03 20:45:30 +00004344 Download latest U-Boot source;
4345
Wolfgang Denk06682362008-12-30 22:56:11 +01004346 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004347
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004348 if (clueless)
4349 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004350
wdenk2729af92004-05-03 20:45:30 +00004351 while (learning) {
4352 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004353 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4354 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004355 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004356 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004357 }
wdenkc6097192002-11-03 00:24:07 +00004358
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004359 if (available_money > toLocalCurrency ($2500))
4360 Buy a BDI3000;
4361 else
wdenk2729af92004-05-03 20:45:30 +00004362 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004363
4364 if (a similar board exists) { /* hopefully... */
4365 cp -a board/<similar> board/<myboard>
4366 cp include/configs/<similar>.h include/configs/<myboard>.h
4367 } else {
4368 Create your own board support subdirectory;
4369 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004370 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004371 Edit new board/<myboard> files
4372 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004373
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004374 while (!accepted) {
4375 while (!running) {
4376 do {
4377 Add / modify source code;
4378 } until (compiles);
4379 Debug;
4380 if (clueless)
4381 email("Hi, I am having problems...");
4382 }
4383 Send patch file to the U-Boot email list;
4384 if (reasonable critiques)
4385 Incorporate improvements from email list code review;
4386 else
4387 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004388 }
wdenkc6097192002-11-03 00:24:07 +00004389
wdenk2729af92004-05-03 20:45:30 +00004390 return 0;
4391}
4392
4393void no_more_time (int sig)
4394{
4395 hire_a_guru();
4396}
wdenkc6097192002-11-03 00:24:07 +00004397
4398
wdenk2729af92004-05-03 20:45:30 +00004399Coding Standards:
4400-----------------
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk2729af92004-05-03 20:45:30 +00004402All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004403coding style; see the file "Documentation/CodingStyle" and the script
4404"scripts/Lindent" in your Linux kernel source directory. In sources
4405originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4406spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004407
Detlev Zundel2c051652006-09-01 15:39:02 +02004408Source files originating from a different project (for example the
4409MTD subsystem) are generally exempt from these guidelines and are not
4410reformated to ease subsequent migration to newer versions of those
4411sources.
4412
4413Please note that U-Boot is implemented in C (and to some small parts in
4414Assembler); no C++ is used, so please do not use C++ style comments (//)
4415in your code.
wdenk2729af92004-05-03 20:45:30 +00004416
4417Please also stick to the following formatting rules:
4418- remove any trailing white space
4419- use TAB characters for indentation, not spaces
4420- make sure NOT to use DOS '\r\n' line feeds
4421- do not add more than 2 empty lines to source files
4422- do not add trailing empty lines to source files
4423
4424Submissions which do not conform to the standards may be returned
4425with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004426
4427
wdenk2729af92004-05-03 20:45:30 +00004428Submitting Patches:
4429-------------------
wdenkc6097192002-11-03 00:24:07 +00004430
wdenk2729af92004-05-03 20:45:30 +00004431Since the number of patches for U-Boot is growing, we need to
4432establish some rules. Submissions which do not conform to these rules
4433may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004434
Magnus Lilja0d28f342008-08-06 19:32:33 +02004435Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004436
Wolfgang Denk06682362008-12-30 22:56:11 +01004437Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4438see http://lists.denx.de/mailman/listinfo/u-boot
4439
wdenk2729af92004-05-03 20:45:30 +00004440When you send a patch, please include the following information with
4441it:
wdenkc6097192002-11-03 00:24:07 +00004442
wdenk2729af92004-05-03 20:45:30 +00004443* For bug fixes: a description of the bug and how your patch fixes
4444 this bug. Please try to include a way of demonstrating that the
4445 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004446
wdenk2729af92004-05-03 20:45:30 +00004447* For new features: a description of the feature and your
4448 implementation.
wdenkc6097192002-11-03 00:24:07 +00004449
wdenk2729af92004-05-03 20:45:30 +00004450* A CHANGELOG entry as plaintext (separate from the patch)
4451
4452* For major contributions, your entry to the CREDITS file
4453
4454* When you add support for a new board, don't forget to add this
4455 board to the MAKEALL script, too.
4456
4457* If your patch adds new configuration options, don't forget to
4458 document these in the README file.
4459
Wolfgang Denk218ca722008-03-26 10:40:12 +01004460* The patch itself. If you are using git (which is *strongly*
4461 recommended) you can easily generate the patch using the
4462 "git-format-patch". If you then use "git-send-email" to send it to
4463 the U-Boot mailing list, you will avoid most of the common problems
4464 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004465
Wolfgang Denk218ca722008-03-26 10:40:12 +01004466 If you cannot use git, use "diff -purN OLD NEW". If your version of
4467 diff does not support these options, then get the latest version of
4468 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004469
Wolfgang Denk218ca722008-03-26 10:40:12 +01004470 The current directory when running this command shall be the parent
4471 directory of the U-Boot source tree (i. e. please make sure that
4472 your patch includes sufficient directory information for the
4473 affected files).
4474
4475 We prefer patches as plain text. MIME attachments are discouraged,
4476 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004477
4478* If one logical set of modifications affects or creates several
4479 files, all these changes shall be submitted in a SINGLE patch file.
4480
4481* Changesets that contain different, unrelated modifications shall be
4482 submitted as SEPARATE patches, one patch per changeset.
4483
4484
4485Notes:
4486
4487* Before sending the patch, run the MAKEALL script on your patched
4488 source tree and make sure that no errors or warnings are reported
4489 for any of the boards.
4490
4491* Keep your modifications to the necessary minimum: A patch
4492 containing several unrelated changes or arbitrary reformats will be
4493 returned with a request to re-formatting / split it.
4494
4495* If you modify existing code, make sure that your new code does not
4496 add to the memory footprint of the code ;-) Small is beautiful!
4497 When adding new features, these should compile conditionally only
4498 (using #ifdef), and the resulting code with the new feature
4499 disabled must not need more memory than the old code without your
4500 modification.
wdenk90dc6702005-05-03 14:12:25 +00004501
Wolfgang Denk06682362008-12-30 22:56:11 +01004502* Remember that there is a size limit of 100 kB per message on the
4503 u-boot mailing list. Bigger patches will be moderated. If they are
4504 reasonable and not too big, they will be acknowledged. But patches
4505 bigger than the size limit should be avoided.