blob: 7b27c992e3d821067596770f8b40ddcaa9d97f5c [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
Igor Grinberg7eb29392011-07-14 05:45:07 +0000445 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
446
447 This setting is mandatory for all boards that have only one
448 machine type and must be used to specify the machine type
449 number as it appears in the ARM machine registry
450 (see http://www.arm.linux.org.uk/developer/machines/).
451 Only boards that have multiple machine types supported
452 in a single configuration file and the machine type is
453 runtime discoverable, do not have to use this setting.
454
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100455- vxWorks boot parameters:
456
457 bootvx constructs a valid bootline using the following
458 environments variables: bootfile, ipaddr, serverip, hostname.
459 It loads the vxWorks image pointed bootfile.
460
461 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
462 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
463 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
464 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
465
466 CONFIG_SYS_VXWORKS_ADD_PARAMS
467
468 Add it at the end of the bootline. E.g "u=username pw=secret"
469
470 Note: If a "bootargs" environment is defined, it will overwride
471 the defaults discussed just above.
472
Aneesh V2c451f72011-06-16 23:30:47 +0000473- Cache Configuration:
474 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
475 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
476 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
477
Aneesh V93bc2192011-06-16 23:30:51 +0000478- Cache Configuration for ARM:
479 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
480 controller
481 CONFIG_SYS_PL310_BASE - Physical base address of PL310
482 controller register space
483
wdenk6705d812004-08-02 23:22:59 +0000484- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200485 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000486
487 Define this if you want support for Amba PrimeCell PL010 UARTs.
488
Andreas Engel48d01922008-09-08 14:30:53 +0200489 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000490
491 Define this if you want support for Amba PrimeCell PL011 UARTs.
492
493 CONFIG_PL011_CLOCK
494
495 If you have Amba PrimeCell PL011 UARTs, set this variable to
496 the clock speed of the UARTs.
497
498 CONFIG_PL01x_PORTS
499
500 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
501 define this to a list of base addresses for each (supported)
502 port. See e.g. include/configs/versatile.h
503
John Rigby910f1ae2011-04-19 10:42:39 +0000504 CONFIG_PL011_SERIAL_RLCR
505
506 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
507 have separate receive and transmit line control registers. Set
508 this variable to initialize the extra register.
509
510 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
511
512 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
513 boot loader that has already initialized the UART. Define this
514 variable to flush the UART at init time.
515
wdenk6705d812004-08-02 23:22:59 +0000516
wdenkc6097192002-11-03 00:24:07 +0000517- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000518 Depending on board, define exactly one serial port
519 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
520 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
521 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000522
523 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
524 port routines must be defined elsewhere
525 (i.e. serial_init(), serial_getc(), ...)
526
527 CONFIG_CFB_CONSOLE
528 Enables console device for a color framebuffer. Needs following
529 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
530 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
531 (default big endian)
532 VIDEO_HW_RECTFILL graphic chip supports
533 rectangle fill
534 (cf. smiLynxEM)
535 VIDEO_HW_BITBLT graphic chip supports
536 bit-blit (cf. smiLynxEM)
537 VIDEO_VISIBLE_COLS visible pixel columns
538 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000539 VIDEO_VISIBLE_ROWS visible pixel rows
540 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000541 VIDEO_DATA_FORMAT graphic data format
542 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000543 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000544 VIDEO_KBD_INIT_FCT keyboard int fct
545 (i.e. i8042_kbd_init())
546 VIDEO_TSTC_FCT test char fct
547 (i.e. i8042_tstc)
548 VIDEO_GETC_FCT get char fct
549 (i.e. i8042_getc)
550 CONFIG_CONSOLE_CURSOR cursor drawing on/off
551 (requires blink timer
552 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200553 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000554 CONFIG_CONSOLE_TIME display time/date info in
555 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500556 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000557 CONFIG_VIDEO_LOGO display Linux logo in
558 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000559 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
560 linux_logo.h for logo.
561 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000562 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200563 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000564 the logo
565
wdenk43d96162003-03-06 00:02:04 +0000566 When CONFIG_CFB_CONSOLE is defined, video console is
567 default i/o. Serial console can be forced with
568 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000569
wdenkd4ca31c2004-01-02 14:00:00 +0000570 When CONFIG_SILENT_CONSOLE is defined, all console
571 messages (by U-Boot and Linux!) can be silenced with
572 the "silent" environment variable. See
573 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000574
wdenkc6097192002-11-03 00:24:07 +0000575- Console Baudrate:
576 CONFIG_BAUDRATE - in bps
577 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200578 CONFIG_SYS_BAUDRATE_TABLE, see below.
579 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000580
Heiko Schocherc92fac92009-01-30 12:55:38 +0100581- Console Rx buffer length
582 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
583 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100584 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100585 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
586 must be defined, to setup the maximum idle timeout for
587 the SMC.
588
wdenkc6097192002-11-03 00:24:07 +0000589- Boot Delay: CONFIG_BOOTDELAY - in seconds
590 Delay before automatically booting the default image;
591 set to -1 to disable autoboot.
592
593 See doc/README.autoboot for these options that
594 work with CONFIG_BOOTDELAY. None are required.
595 CONFIG_BOOT_RETRY_TIME
596 CONFIG_BOOT_RETRY_MIN
597 CONFIG_AUTOBOOT_KEYED
598 CONFIG_AUTOBOOT_PROMPT
599 CONFIG_AUTOBOOT_DELAY_STR
600 CONFIG_AUTOBOOT_STOP_STR
601 CONFIG_AUTOBOOT_DELAY_STR2
602 CONFIG_AUTOBOOT_STOP_STR2
603 CONFIG_ZERO_BOOTDELAY_CHECK
604 CONFIG_RESET_TO_RETRY
605
606- Autoboot Command:
607 CONFIG_BOOTCOMMAND
608 Only needed when CONFIG_BOOTDELAY is enabled;
609 define a command string that is automatically executed
610 when no character is read on the console interface
611 within "Boot Delay" after reset.
612
613 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000614 This can be used to pass arguments to the bootm
615 command. The value of CONFIG_BOOTARGS goes into the
616 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000617
618 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000619 The value of these goes into the environment as
620 "ramboot" and "nfsboot" respectively, and can be used
621 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200622 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000623
624- Pre-Boot Commands:
625 CONFIG_PREBOOT
626
627 When this option is #defined, the existence of the
628 environment variable "preboot" will be checked
629 immediately before starting the CONFIG_BOOTDELAY
630 countdown and/or running the auto-boot command resp.
631 entering interactive mode.
632
633 This feature is especially useful when "preboot" is
634 automatically generated or modified. For an example
635 see the LWMON board specific code: here "preboot" is
636 modified when the user holds down a certain
637 combination of keys on the (special) keyboard when
638 booting the systems
639
640- Serial Download Echo Mode:
641 CONFIG_LOADS_ECHO
642 If defined to 1, all characters received during a
643 serial download (using the "loads" command) are
644 echoed back. This might be needed by some terminal
645 emulations (like "cu"), but may as well just take
646 time on others. This setting #define's the initial
647 value of the "loads_echo" environment variable.
648
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500649- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000650 CONFIG_KGDB_BAUDRATE
651 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200652 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000653
654- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500655 Monitor commands can be included or excluded
656 from the build by using the #include files
657 "config_cmd_all.h" and #undef'ing unwanted
658 commands, or using "config_cmd_default.h"
659 and augmenting with additional #define's
660 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000661
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500662 The default command configuration includes all commands
663 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000664
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500665 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500666 CONFIG_CMD_BDI bdinfo
667 CONFIG_CMD_BEDBUG * Include BedBug Debugger
668 CONFIG_CMD_BMP * BMP support
669 CONFIG_CMD_BSP * Board specific commands
670 CONFIG_CMD_BOOTD bootd
671 CONFIG_CMD_CACHE * icache, dcache
672 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500673 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500674 CONFIG_CMD_DATE * support for RTC, date/time...
675 CONFIG_CMD_DHCP * DHCP support
676 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600677 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
678 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
679 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
680 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500681 CONFIG_CMD_DTT * Digital Therm and Thermostat
682 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500683 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500684 CONFIG_CMD_EEPROM * EEPROM read/write support
685 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500686 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500687 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500688 CONFIG_CMD_FDC * Floppy Disk Support
689 CONFIG_CMD_FAT * FAT partition support
690 CONFIG_CMD_FDOS * Dos diskette Support
691 CONFIG_CMD_FLASH flinfo, erase, protect
692 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500693 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000694 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500695 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
696 CONFIG_CMD_I2C * I2C serial bus support
697 CONFIG_CMD_IDE * IDE harddisk support
698 CONFIG_CMD_IMI iminfo
699 CONFIG_CMD_IMLS List all found images
700 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500701 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500702 CONFIG_CMD_IRQ * irqinfo
703 CONFIG_CMD_ITEST Integer/string test of 2 values
704 CONFIG_CMD_JFFS2 * JFFS2 Support
705 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500706 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500707 CONFIG_CMD_LOADB loadb
708 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400709 CONFIG_CMD_MD5SUM print md5 message digest
710 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500711 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
712 loop, loopw, mtest
713 CONFIG_CMD_MISC Misc functions like sleep etc
714 CONFIG_CMD_MMC * MMC memory mapped support
715 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100716 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500717 CONFIG_CMD_NAND * NAND support
718 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600719 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
720 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500721 CONFIG_CMD_PCI * pciinfo
722 CONFIG_CMD_PCMCIA * PCMCIA support
723 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
724 host
725 CONFIG_CMD_PORTIO * Port I/O
726 CONFIG_CMD_REGINFO * Register dump
727 CONFIG_CMD_RUN run command in env variable
728 CONFIG_CMD_SAVES * save S record dump
729 CONFIG_CMD_SCSI * SCSI Support
730 CONFIG_CMD_SDRAM * print SDRAM configuration information
731 (requires CONFIG_CMD_I2C)
732 CONFIG_CMD_SETGETDCR Support for DCR Register access
733 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100734 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400735 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200736 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500737 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000738 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500739 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500740 CONFIG_CMD_CDP * Cisco Discover Protocol support
741 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000742
wdenkc6097192002-11-03 00:24:07 +0000743
744 EXAMPLE: If you want all functions except of network
745 support you can write:
746
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500747 #include "config_cmd_all.h"
748 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000749
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400750 Other Commands:
751 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000752
753 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000755 what you (and your U-Boot users) are doing. Data
756 cache cannot be enabled on systems like the 8xx or
757 8260 (where accesses to the IMMR region must be
758 uncached), and it cannot be disabled on all other
759 systems where we (mis-) use the data cache to hold an
760 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000761
762
763 XXX - this list needs to get updated!
764
765- Watchdog:
766 CONFIG_WATCHDOG
767 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000768 support for the SoC. There must be support in the SoC
769 specific code for a watchdog. For the 8xx and 8260
770 CPUs, the SIU Watchdog feature is enabled in the SYPCR
771 register. When supported for a specific SoC is
772 available, then no further board specific code should
773 be needed to use it.
774
775 CONFIG_HW_WATCHDOG
776 When using a watchdog circuitry external to the used
777 SoC, then define this variable and provide board
778 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000779
stroesec1551ea2003-04-04 15:53:41 +0000780- U-Boot Version:
781 CONFIG_VERSION_VARIABLE
782 If this variable is defined, an environment variable
783 named "ver" is created by U-Boot showing the U-Boot
784 version as printed by the "version" command.
785 This variable is readonly.
786
wdenkc6097192002-11-03 00:24:07 +0000787- Real-Time Clock:
788
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500789 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000790 has to be selected, too. Define exactly one of the
791 following options:
792
793 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
794 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200795 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000796 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000797 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000798 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000799 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000800 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100801 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000802 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200803 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200804 CONFIG_SYS_RV3029_TCR - enable trickle charger on
805 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000806
wdenkb37c7e52003-06-30 16:24:52 +0000807 Note that if the RTC uses I2C, then the I2C interface
808 must also be configured. See I2C Support, below.
809
Peter Tysere92739d2008-12-17 16:36:21 -0600810- GPIO Support:
811 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
812 CONFIG_PCA953X_INFO - enable pca953x info command
813
Chris Packham5dec49c2010-12-19 10:12:13 +0000814 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
815 chip-ngpio pairs that tell the PCA953X driver the number of
816 pins supported by a particular chip.
817
Peter Tysere92739d2008-12-17 16:36:21 -0600818 Note that if the GPIO device uses I2C, then the I2C interface
819 must also be configured. See I2C Support, below.
820
wdenkc6097192002-11-03 00:24:07 +0000821- Timestamp Support:
822
wdenk43d96162003-03-06 00:02:04 +0000823 When CONFIG_TIMESTAMP is selected, the timestamp
824 (date and time) of an image is printed by image
825 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500826 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000827
828- Partition Support:
829 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400830 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000831
Wolfgang Denk218ca722008-03-26 10:40:12 +0100832 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
833 CONFIG_CMD_SCSI) you must configure support for at
834 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000835
836- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000837 CONFIG_IDE_RESET_ROUTINE - this is defined in several
838 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000839
wdenk4d13cba2004-03-14 14:09:05 +0000840 CONFIG_IDE_RESET - is this is defined, IDE Reset will
841 be performed by calling the function
842 ide_set_reset(int reset)
843 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000844
845- ATAPI Support:
846 CONFIG_ATAPI
847
848 Set this to enable ATAPI support.
849
wdenkc40b2952004-03-13 23:29:43 +0000850- LBA48 Support
851 CONFIG_LBA48
852
853 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100854 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000855 Whithout these , LBA48 support uses 32bit variables and will 'only'
856 support disks up to 2.1TB.
857
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200858 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000859 When enabled, makes the IDE subsystem use 64bit sector addresses.
860 Default is 32bit.
861
wdenkc6097192002-11-03 00:24:07 +0000862- SCSI Support:
863 At the moment only there is only support for the
864 SYM53C8XX SCSI controller; define
865 CONFIG_SCSI_SYM53C8XX to enable it.
866
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200867 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
868 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
869 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000870 maximum numbers of LUNs, SCSI ID's and target
871 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200872 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000873
874- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000875 CONFIG_E1000
876 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000877
Andre Schwarzac3315c2008-03-06 16:45:44 +0100878 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200879 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100880
wdenkc6097192002-11-03 00:24:07 +0000881 CONFIG_EEPRO100
882 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200883 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000884 write routine for first time initialisation.
885
886 CONFIG_TULIP
887 Support for Digital 2114x chips.
888 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
889 modem chip initialisation (KS8761/QS6611).
890
891 CONFIG_NATSEMI
892 Support for National dp83815 chips.
893
894 CONFIG_NS8382X
895 Support for National dp8382[01] gigabit chips.
896
wdenk45219c42003-05-12 21:50:16 +0000897- NETWORK Support (other):
898
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100899 CONFIG_DRIVER_AT91EMAC
900 Support for AT91RM9200 EMAC.
901
902 CONFIG_RMII
903 Define this to use reduced MII inteface
904
905 CONFIG_DRIVER_AT91EMAC_QUIET
906 If this defined, the driver is quiet.
907 The driver doen't show link status messages.
908
wdenk45219c42003-05-12 21:50:16 +0000909 CONFIG_DRIVER_LAN91C96
910 Support for SMSC's LAN91C96 chips.
911
912 CONFIG_LAN91C96_BASE
913 Define this to hold the physical address
914 of the LAN91C96's I/O space
915
916 CONFIG_LAN91C96_USE_32_BIT
917 Define this to enable 32 bit addressing
918
wdenkf39748a2004-06-09 13:37:52 +0000919 CONFIG_DRIVER_SMC91111
920 Support for SMSC's LAN91C111 chip
921
922 CONFIG_SMC91111_BASE
923 Define this to hold the physical address
924 of the device (I/O space)
925
926 CONFIG_SMC_USE_32_BIT
927 Define this if data bus is 32 bits
928
929 CONFIG_SMC_USE_IOFUNCS
930 Define this to use i/o functions instead of macros
931 (some hardware wont work with macros)
932
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800933 CONFIG_FTGMAC100
934 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
935
936 CONFIG_FTGMAC100_EGIGA
937 Define this to use GE link update with gigabit PHY.
938 Define this if FTGMAC100 is connected to gigabit PHY.
939 If your system has 10/100 PHY only, it might not occur
940 wrong behavior. Because PHY usually return timeout or
941 useless data when polling gigabit status and gigabit
942 control registers. This behavior won't affect the
943 correctnessof 10/100 link speed update.
944
Mike Rapoportc2fff332009-11-11 10:03:03 +0200945 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200946 Support for SMSC's LAN911x and LAN921x chips
947
Mike Rapoportc2fff332009-11-11 10:03:03 +0200948 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200949 Define this to hold the physical address
950 of the device (I/O space)
951
Mike Rapoportc2fff332009-11-11 10:03:03 +0200952 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200953 Define this if data bus is 32 bits
954
Mike Rapoportc2fff332009-11-11 10:03:03 +0200955 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200956 Define this if data bus is 16 bits. If your processor
957 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200958 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200959
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900960 CONFIG_SH_ETHER
961 Support for Renesas on-chip Ethernet controller
962
963 CONFIG_SH_ETHER_USE_PORT
964 Define the number of ports to be used
965
966 CONFIG_SH_ETHER_PHY_ADDR
967 Define the ETH PHY's address
968
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900969 CONFIG_SH_ETHER_CACHE_WRITEBACK
970 If this option is set, the driver enables cache flush.
971
wdenkc6097192002-11-03 00:24:07 +0000972- USB Support:
973 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000974 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000975 CONFIG_USB_UHCI to enable it.
976 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000977 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000978 storage devices.
979 Note:
980 Supported are USB Keyboards and USB Floppy drives
981 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000982 MPC5200 USB requires additional defines:
983 CONFIG_USB_CLOCK
984 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500985 CONFIG_PSC3_USB
986 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000987 CONFIG_USB_CONFIG
988 for differential drivers: 0x00001000
989 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500990 for differential drivers on PSC3: 0x00000100
991 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200992 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200993 May be defined to allow interrupt polling
994 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000995
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200996- USB Device:
997 Define the below if you wish to use the USB console.
998 Once firmware is rebuilt from a serial console issue the
999 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001000 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001001 it has found a new device. The environment variable usbtty
1002 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001003 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001004 Common Device Class Abstract Control Model serial device.
1005 If you select usbtty = gserial you should be able to enumerate
1006 a Linux host by
1007 # modprobe usbserial vendor=0xVendorID product=0xProductID
1008 else if using cdc_acm, simply setting the environment
1009 variable usbtty to be cdc_acm should suffice. The following
1010 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001011
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001012 CONFIG_USB_DEVICE
1013 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001014
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001015 CONFIG_USB_TTY
1016 Define this to have a tty type of device available to
1017 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001019 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001020 Define this if you want stdin, stdout &/or stderr to
1021 be set to usbtty.
1022
1023 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001024 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001025 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001026 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001028 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001029 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001030 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001031
Wolfgang Denk386eda02006-06-14 18:14:56 +02001032 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001033 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001034 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001035 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1036 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1037 should pretend to be a Linux device to it's target host.
1038
1039 CONFIG_USBD_MANUFACTURER
1040 Define this string as the name of your company for
1041 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001042
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001043 CONFIG_USBD_PRODUCT_NAME
1044 Define this string as the name of your product
1045 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1046
1047 CONFIG_USBD_VENDORID
1048 Define this as your assigned Vendor ID from the USB
1049 Implementors Forum. This *must* be a genuine Vendor ID
1050 to avoid polluting the USB namespace.
1051 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001052
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001053 CONFIG_USBD_PRODUCTID
1054 Define this as the unique Product ID
1055 for your device
1056 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001057
1058
1059- MMC Support:
1060 The MMC controller on the Intel PXA is supported. To
1061 enable this define CONFIG_MMC. The MMC can be
1062 accessed from the boot prompt by mapping the device
1063 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001064 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1065 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001066
wdenk6705d812004-08-02 23:22:59 +00001067- Journaling Flash filesystem support:
1068 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1069 CONFIG_JFFS2_NAND_DEV
1070 Define these for a default partition on a NAND device
1071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001072 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1073 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001074 Define these for a default partition on a NOR device
1075
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001076 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001077 Define this to create an own partition. You have to provide a
1078 function struct part_info* jffs2_part_info(int part_num)
1079
1080 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001081 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001082 to disable the command chpart. This is the default when you
1083 have not defined a custom partition
1084
wdenkc6097192002-11-03 00:24:07 +00001085- Keyboard Support:
1086 CONFIG_ISA_KEYBOARD
1087
1088 Define this to enable standard (PC-Style) keyboard
1089 support
1090
1091 CONFIG_I8042_KBD
1092 Standard PC keyboard driver with US (is default) and
1093 GERMAN key layout (switch via environment 'keymap=de') support.
1094 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1095 for cfb_console. Supports cursor blinking.
1096
1097- Video support:
1098 CONFIG_VIDEO
1099
1100 Define this to enable video support (for output to
1101 video).
1102
1103 CONFIG_VIDEO_CT69000
1104
1105 Enable Chips & Technologies 69000 Video chip
1106
1107 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001108 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001109 video output is selected via environment 'videoout'
1110 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1111 assumed.
wdenkc6097192002-11-03 00:24:07 +00001112
wdenkb79a11c2004-03-25 15:14:43 +00001113 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001114 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001115 are possible:
1116 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001117 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001118
1119 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1120 -------------+---------------------------------------------
1121 8 bits | 0x301* 0x303 0x305 0x161 0x307
1122 15 bits | 0x310 0x313 0x316 0x162 0x319
1123 16 bits | 0x311 0x314 0x317 0x163 0x31A
1124 24 bits | 0x312 0x315 0x318 ? 0x31B
1125 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001126 (i.e. setenv videomode 317; saveenv; reset;)
1127
wdenkb79a11c2004-03-25 15:14:43 +00001128 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001129 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001130
1131
stroesec1551ea2003-04-04 15:53:41 +00001132 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001133 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001134 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1135 or CONFIG_VIDEO_SED13806_16BPP
1136
Timur Tabi7d3053f2011-02-15 17:09:19 -06001137 CONFIG_FSL_DIU_FB
1138 Enable the Freescale DIU video driver. Reference boards for
1139 SOCs that have a DIU should define this macro to enable DIU
1140 support, and should also define these other macros:
1141
1142 CONFIG_SYS_DIU_ADDR
1143 CONFIG_VIDEO
1144 CONFIG_CMD_BMP
1145 CONFIG_CFB_CONSOLE
1146 CONFIG_VIDEO_SW_CURSOR
1147 CONFIG_VGA_AS_SINGLE_DEVICE
1148 CONFIG_VIDEO_LOGO
1149 CONFIG_VIDEO_BMP_LOGO
1150
Timur Tabiba8e76b2011-04-11 14:18:22 -05001151 The DIU driver will look for the 'video-mode' environment
1152 variable, and if defined, enable the DIU as a console during
1153 boot. See the documentation file README.video for a
1154 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001155
wdenk682011f2003-06-03 23:54:09 +00001156- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001157 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001158
wdenk8bde7f72003-06-27 21:31:46 +00001159 Define this to enable a custom keyboard support.
1160 This simply calls drv_keyboard_init() which must be
1161 defined in your board-specific files.
1162 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001163
wdenkc6097192002-11-03 00:24:07 +00001164- LCD Support: CONFIG_LCD
1165
1166 Define this to enable LCD support (for output to LCD
1167 display); also select one of the supported displays
1168 by defining one of these:
1169
Stelian Pop39cf4802008-05-09 21:57:18 +02001170 CONFIG_ATMEL_LCD:
1171
1172 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1173
wdenkfd3103b2003-11-25 16:55:19 +00001174 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001175
wdenkfd3103b2003-11-25 16:55:19 +00001176 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001177
wdenkfd3103b2003-11-25 16:55:19 +00001178 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001179
wdenkfd3103b2003-11-25 16:55:19 +00001180 NEC NL6448BC20-08. 6.5", 640x480.
1181 Active, color, single scan.
1182
1183 CONFIG_NEC_NL6448BC33_54
1184
1185 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001186 Active, color, single scan.
1187
1188 CONFIG_SHARP_16x9
1189
1190 Sharp 320x240. Active, color, single scan.
1191 It isn't 16x9, and I am not sure what it is.
1192
1193 CONFIG_SHARP_LQ64D341
1194
1195 Sharp LQ64D341 display, 640x480.
1196 Active, color, single scan.
1197
1198 CONFIG_HLD1045
1199
1200 HLD1045 display, 640x480.
1201 Active, color, single scan.
1202
1203 CONFIG_OPTREX_BW
1204
1205 Optrex CBL50840-2 NF-FW 99 22 M5
1206 or
1207 Hitachi LMG6912RPFC-00T
1208 or
1209 Hitachi SP14Q002
1210
1211 320x240. Black & white.
1212
1213 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001214 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001215
wdenk7152b1d2003-09-05 23:19:14 +00001216- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001217
wdenk8bde7f72003-06-27 21:31:46 +00001218 If this option is set, the environment is checked for
1219 a variable "splashimage". If found, the usual display
1220 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001221 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001222 specified in "splashimage" is loaded instead. The
1223 console is redirected to the "nulldev", too. This
1224 allows for a "silent" boot where a splash screen is
1225 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001226
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001227 CONFIG_SPLASH_SCREEN_ALIGN
1228
1229 If this option is set the splash image can be freely positioned
1230 on the screen. Environment variable "splashpos" specifies the
1231 position as "x,y". If a positive number is given it is used as
1232 number of pixel from left/top. If a negative number is given it
1233 is used as number of pixel from right/bottom. You can also
1234 specify 'm' for centering the image.
1235
1236 Example:
1237 setenv splashpos m,m
1238 => image at center of screen
1239
1240 setenv splashpos 30,20
1241 => image at x = 30 and y = 20
1242
1243 setenv splashpos -10,m
1244 => vertically centered image
1245 at x = dspWidth - bmpWidth - 9
1246
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001247- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1248
1249 If this option is set, additionally to standard BMP
1250 images, gzipped BMP images can be displayed via the
1251 splashscreen support or the bmp command.
1252
Anatolij Gustschind5011762010-03-15 14:50:25 +01001253- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1254
1255 If this option is set, 8-bit RLE compressed BMP images
1256 can be displayed via the splashscreen support or the
1257 bmp command.
1258
wdenkc29fdfc2003-08-29 20:57:53 +00001259- Compression support:
1260 CONFIG_BZIP2
1261
1262 If this option is set, support for bzip2 compressed
1263 images is included. If not, only uncompressed and gzip
1264 compressed images are supported.
1265
wdenk42d1f032003-10-15 23:53:47 +00001266 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001267 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001268 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001269
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001270 CONFIG_LZMA
1271
1272 If this option is set, support for lzma compressed
1273 images is included.
1274
1275 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1276 requires an amount of dynamic memory that is given by the
1277 formula:
1278
1279 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1280
1281 Where lc and lp stand for, respectively, Literal context bits
1282 and Literal pos bits.
1283
1284 This value is upper-bounded by 14MB in the worst case. Anyway,
1285 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1286 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1287 a very small buffer.
1288
1289 Use the lzmainfo tool to determinate the lc and lp values and
1290 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001291 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001292
wdenk17ea1172004-06-06 21:51:03 +00001293- MII/PHY support:
1294 CONFIG_PHY_ADDR
1295
1296 The address of PHY on MII bus.
1297
1298 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1299
1300 The clock frequency of the MII bus
1301
1302 CONFIG_PHY_GIGE
1303
1304 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001305 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001306
1307 CONFIG_PHY_RESET_DELAY
1308
1309 Some PHY like Intel LXT971A need extra delay after
1310 reset before any MII register access is possible.
1311 For such PHY, set this option to the usec delay
1312 required. (minimum 300usec for LXT971A)
1313
1314 CONFIG_PHY_CMD_DELAY (ppc4xx)
1315
1316 Some PHY like Intel LXT971A need extra delay after
1317 command issued before MII status register can be read
1318
wdenkc6097192002-11-03 00:24:07 +00001319- Ethernet address:
1320 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001321 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001322 CONFIG_ETH2ADDR
1323 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001324 CONFIG_ETH4ADDR
1325 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001326
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001327 Define a default value for Ethernet address to use
1328 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001329 is not determined automatically.
1330
1331- IP address:
1332 CONFIG_IPADDR
1333
1334 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001335 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001336 determined through e.g. bootp.
1337
1338- Server IP address:
1339 CONFIG_SERVERIP
1340
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001341 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001342 server to contact when using the "tftboot" command.
1343
Robin Getz97cfe862009-07-21 12:15:28 -04001344 CONFIG_KEEP_SERVERADDR
1345
1346 Keeps the server's MAC address, in the env 'serveraddr'
1347 for passing to bootargs (like Linux's netconsole option)
1348
David Updegraff53a5c422007-06-11 10:41:07 -05001349- Multicast TFTP Mode:
1350 CONFIG_MCAST_TFTP
1351
1352 Defines whether you want to support multicast TFTP as per
1353 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001354 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001355 driver in use must provide a function: mcast() to join/leave a
1356 multicast group.
1357
wdenkc6097192002-11-03 00:24:07 +00001358- BOOTP Recovery Mode:
1359 CONFIG_BOOTP_RANDOM_DELAY
1360
1361 If you have many targets in a network that try to
1362 boot using BOOTP, you may want to avoid that all
1363 systems send out BOOTP requests at precisely the same
1364 moment (which would happen for instance at recovery
1365 from a power failure, when all systems will try to
1366 boot, thus flooding the BOOTP server. Defining
1367 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1368 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001369 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001370
1371 1st BOOTP request: delay 0 ... 1 sec
1372 2nd BOOTP request: delay 0 ... 2 sec
1373 3rd BOOTP request: delay 0 ... 4 sec
1374 4th and following
1375 BOOTP requests: delay 0 ... 8 sec
1376
stroesefe389a82003-08-28 14:17:32 +00001377- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001378 You can fine tune the DHCP functionality by defining
1379 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001380
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001381 CONFIG_BOOTP_SUBNETMASK
1382 CONFIG_BOOTP_GATEWAY
1383 CONFIG_BOOTP_HOSTNAME
1384 CONFIG_BOOTP_NISDOMAIN
1385 CONFIG_BOOTP_BOOTPATH
1386 CONFIG_BOOTP_BOOTFILESIZE
1387 CONFIG_BOOTP_DNS
1388 CONFIG_BOOTP_DNS2
1389 CONFIG_BOOTP_SEND_HOSTNAME
1390 CONFIG_BOOTP_NTPSERVER
1391 CONFIG_BOOTP_TIMEOFFSET
1392 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001393
Wilson Callan5d110f02007-07-28 10:56:13 -04001394 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1395 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001396
1397 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1398 serverip from a DHCP server, it is possible that more
1399 than one DNS serverip is offered to the client.
1400 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1401 serverip will be stored in the additional environment
1402 variable "dnsip2". The first DNS serverip is always
1403 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001404 is defined.
stroesefe389a82003-08-28 14:17:32 +00001405
1406 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1407 to do a dynamic update of a DNS server. To do this, they
1408 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001409 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001410 of the "hostname" environment variable is passed as
1411 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001412
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001413 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1414
1415 A 32bit value in microseconds for a delay between
1416 receiving a "DHCP Offer" and sending the "DHCP Request".
1417 This fixes a problem with certain DHCP servers that don't
1418 respond 100% of the time to a "DHCP request". E.g. On an
1419 AT91RM9200 processor running at 180MHz, this delay needed
1420 to be *at least* 15,000 usec before a Windows Server 2003
1421 DHCP server would reply 100% of the time. I recommend at
1422 least 50,000 usec to be safe. The alternative is to hope
1423 that one of the retries will be successful but note that
1424 the DHCP timeout and retry process takes a longer than
1425 this delay.
1426
wdenka3d991b2004-04-15 21:48:45 +00001427 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001428 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001429
1430 The device id used in CDP trigger frames.
1431
1432 CONFIG_CDP_DEVICE_ID_PREFIX
1433
1434 A two character string which is prefixed to the MAC address
1435 of the device.
1436
1437 CONFIG_CDP_PORT_ID
1438
1439 A printf format string which contains the ascii name of
1440 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001441 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001442
1443 CONFIG_CDP_CAPABILITIES
1444
1445 A 32bit integer which indicates the device capabilities;
1446 0x00000010 for a normal host which does not forwards.
1447
1448 CONFIG_CDP_VERSION
1449
1450 An ascii string containing the version of the software.
1451
1452 CONFIG_CDP_PLATFORM
1453
1454 An ascii string containing the name of the platform.
1455
1456 CONFIG_CDP_TRIGGER
1457
1458 A 32bit integer sent on the trigger.
1459
1460 CONFIG_CDP_POWER_CONSUMPTION
1461
1462 A 16bit integer containing the power consumption of the
1463 device in .1 of milliwatts.
1464
1465 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1466
1467 A byte containing the id of the VLAN.
1468
wdenkc6097192002-11-03 00:24:07 +00001469- Status LED: CONFIG_STATUS_LED
1470
1471 Several configurations allow to display the current
1472 status using a LED. For instance, the LED will blink
1473 fast while running U-Boot code, stop blinking as
1474 soon as a reply to a BOOTP request was received, and
1475 start blinking slow once the Linux kernel is running
1476 (supported by a status LED driver in the Linux
1477 kernel). Defining CONFIG_STATUS_LED enables this
1478 feature in U-Boot.
1479
1480- CAN Support: CONFIG_CAN_DRIVER
1481
1482 Defining CONFIG_CAN_DRIVER enables CAN driver support
1483 on those systems that support this (optional)
1484 feature, like the TQM8xxL modules.
1485
1486- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1487
wdenkb37c7e52003-06-30 16:24:52 +00001488 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001489 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001490 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001491
wdenk945af8d2003-07-16 21:53:01 +00001492 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001493 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001494 CONFIG_COMMANDS) and communicate with i2c based realtime
1495 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001496 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001497
Ben Warrenbb99ad62006-09-07 16:50:54 -04001498 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001499
wdenk945af8d2003-07-16 21:53:01 +00001500 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001501 bit-banging) driver instead of CPM or similar hardware
1502 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001503
wdenk945af8d2003-07-16 21:53:01 +00001504 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001505 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001506
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001507 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001508 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001509 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001510 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001511
Peter Tyser8d321b82010-04-12 22:28:21 -05001512 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001513 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001514 and so its address should therefore be cleared to 0 (See,
1515 eg, MPC823e User's Manual p.16-473). So, set
1516 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001517
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001518 CONFIG_SYS_I2C_INIT_MPC5XXX
1519
1520 When a board is reset during an i2c bus transfer
1521 chips might think that the current transfer is still
1522 in progress. Reset the slave devices by sending start
1523 commands until the slave device responds.
1524
wdenk945af8d2003-07-16 21:53:01 +00001525 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001526
1527 If you use the software i2c interface (CONFIG_SOFT_I2C)
1528 then the following macros need to be defined (examples are
1529 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001530
1531 I2C_INIT
1532
wdenkb37c7e52003-06-30 16:24:52 +00001533 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001534 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001535
wdenkba56f622004-02-06 23:19:44 +00001536 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001537
wdenkc6097192002-11-03 00:24:07 +00001538 I2C_PORT
1539
wdenk43d96162003-03-06 00:02:04 +00001540 (Only for MPC8260 CPU). The I/O port to use (the code
1541 assumes both bits are on the same port). Valid values
1542 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001543
1544 I2C_ACTIVE
1545
1546 The code necessary to make the I2C data line active
1547 (driven). If the data line is open collector, this
1548 define can be null.
1549
wdenkb37c7e52003-06-30 16:24:52 +00001550 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1551
wdenkc6097192002-11-03 00:24:07 +00001552 I2C_TRISTATE
1553
1554 The code necessary to make the I2C data line tri-stated
1555 (inactive). If the data line is open collector, this
1556 define can be null.
1557
wdenkb37c7e52003-06-30 16:24:52 +00001558 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1559
wdenkc6097192002-11-03 00:24:07 +00001560 I2C_READ
1561
1562 Code that returns TRUE if the I2C data line is high,
1563 FALSE if it is low.
1564
wdenkb37c7e52003-06-30 16:24:52 +00001565 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1566
wdenkc6097192002-11-03 00:24:07 +00001567 I2C_SDA(bit)
1568
1569 If <bit> is TRUE, sets the I2C data line high. If it
1570 is FALSE, it clears it (low).
1571
wdenkb37c7e52003-06-30 16:24:52 +00001572 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001573 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001574 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001575
wdenkc6097192002-11-03 00:24:07 +00001576 I2C_SCL(bit)
1577
1578 If <bit> is TRUE, sets the I2C clock line high. If it
1579 is FALSE, it clears it (low).
1580
wdenkb37c7e52003-06-30 16:24:52 +00001581 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001582 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001583 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001584
wdenkc6097192002-11-03 00:24:07 +00001585 I2C_DELAY
1586
1587 This delay is invoked four times per clock cycle so this
1588 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001589 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001590 like:
1591
wdenkb37c7e52003-06-30 16:24:52 +00001592 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001593
Mike Frysinger793b5722010-07-21 13:38:02 -04001594 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1595
1596 If your arch supports the generic GPIO framework (asm/gpio.h),
1597 then you may alternatively define the two GPIOs that are to be
1598 used as SCL / SDA. Any of the previous I2C_xxx macros will
1599 have GPIO-based defaults assigned to them as appropriate.
1600
1601 You should define these to the GPIO value as given directly to
1602 the generic GPIO functions.
1603
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001604 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001605
wdenk8bde7f72003-06-27 21:31:46 +00001606 When a board is reset during an i2c bus transfer
1607 chips might think that the current transfer is still
1608 in progress. On some boards it is possible to access
1609 the i2c SCLK line directly, either by using the
1610 processor pin as a GPIO or by having a second pin
1611 connected to the bus. If this option is defined a
1612 custom i2c_init_board() routine in boards/xxx/board.c
1613 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001614
Richard Retanubun26a33502010-04-12 15:08:17 -04001615 CONFIG_SYS_I2C_BOARD_LATE_INIT
1616
1617 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1618 defined a custom i2c_board_late_init() routine in
1619 boards/xxx/board.c is run AFTER the operations in i2c_init()
1620 is completed. This callpoint can be used to unreset i2c bus
1621 using CPU i2c controller register accesses for CPUs whose i2c
1622 controller provide such a method. It is called at the end of
1623 i2c_init() to allow i2c_init operations to setup the i2c bus
1624 controller on the CPU (e.g. setting bus speed & slave address).
1625
wdenk17ea1172004-06-06 21:51:03 +00001626 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1627
1628 This option enables configuration of bi_iic_fast[] flags
1629 in u-boot bd_info structure based on u-boot environment
1630 variable "i2cfast". (see also i2cfast)
1631
Ben Warrenbb99ad62006-09-07 16:50:54 -04001632 CONFIG_I2C_MULTI_BUS
1633
1634 This option allows the use of multiple I2C buses, each of which
1635 must have a controller. At any point in time, only one bus is
1636 active. To switch to a different bus, use the 'i2c dev' command.
1637 Note that bus numbering is zero-based.
1638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001639 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001640
1641 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001642 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1643 is set, specify a list of bus-device pairs. Otherwise, specify
1644 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001645
1646 e.g.
1647 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001648 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001649
1650 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1651
1652 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001653 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001654
1655 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001657 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001658
1659 If defined, then this indicates the I2C bus number for DDR SPD.
1660 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1661
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001662 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001663
1664 If defined, then this indicates the I2C bus number for the RTC.
1665 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1666
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001667 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001668
1669 If defined, then this indicates the I2C bus number for the DTT.
1670 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1671
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001672 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001673
1674 If defined, specifies the I2C address of the DTT device.
1675 If not defined, then U-Boot uses predefined value for
1676 specified DTT device.
1677
Timur Tabibe5e6182006-11-03 19:15:00 -06001678 CONFIG_FSL_I2C
1679
1680 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001681 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001682
Heiko Schocher67b23a32008-10-15 09:39:47 +02001683 CONFIG_I2C_MUX
1684
1685 Define this option if you have I2C devices reached over 1 .. n
1686 I2C Muxes like the pca9544a. This option addes a new I2C
1687 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1688 new I2C Bus to the existing I2C Busses. If you select the
1689 new Bus with "i2c dev", u-bbot sends first the commandos for
1690 the muxes to activate this new "bus".
1691
1692 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1693 feature!
1694
1695 Example:
1696 Adding a new I2C Bus reached over 2 pca9544a muxes
1697 The First mux with address 70 and channel 6
1698 The Second mux with address 71 and channel 4
1699
1700 => i2c bus pca9544a:70:6:pca9544a:71:4
1701
1702 Use the "i2c bus" command without parameter, to get a list
1703 of I2C Busses with muxes:
1704
1705 => i2c bus
1706 Busses reached over muxes:
1707 Bus ID: 2
1708 reached over Mux(es):
1709 pca9544a@70 ch: 4
1710 Bus ID: 3
1711 reached over Mux(es):
1712 pca9544a@70 ch: 6
1713 pca9544a@71 ch: 4
1714 =>
1715
1716 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1717 u-boot sends First the Commando to the mux@70 to enable
1718 channel 6, and then the Commando to the mux@71 to enable
1719 the channel 4.
1720
1721 After that, you can use the "normal" i2c commands as
1722 usual, to communicate with your I2C devices behind
1723 the 2 muxes.
1724
1725 This option is actually implemented for the bitbanging
1726 algorithm in common/soft_i2c.c and for the Hardware I2C
1727 Bus on the MPC8260. But it should be not so difficult
1728 to add this option to other architectures.
1729
Andrew Dyer2ac69852008-12-29 17:36:01 -06001730 CONFIG_SOFT_I2C_READ_REPEATED_START
1731
1732 defining this will force the i2c_read() function in
1733 the soft_i2c driver to perform an I2C repeated start
1734 between writing the address pointer and reading the
1735 data. If this define is omitted the default behaviour
1736 of doing a stop-start sequence will be used. Most I2C
1737 devices can use either method, but some require one or
1738 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001739
wdenkc6097192002-11-03 00:24:07 +00001740- SPI Support: CONFIG_SPI
1741
1742 Enables SPI driver (so far only tested with
1743 SPI EEPROM, also an instance works with Crystal A/D and
1744 D/As on the SACSng board)
1745
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001746 CONFIG_SH_SPI
1747
1748 Enables the driver for SPI controller on SuperH. Currently
1749 only SH7757 is supported.
1750
wdenkc6097192002-11-03 00:24:07 +00001751 CONFIG_SPI_X
1752
1753 Enables extended (16-bit) SPI EEPROM addressing.
1754 (symmetrical to CONFIG_I2C_X)
1755
1756 CONFIG_SOFT_SPI
1757
wdenk43d96162003-03-06 00:02:04 +00001758 Enables a software (bit-bang) SPI driver rather than
1759 using hardware support. This is a general purpose
1760 driver that only requires three general I/O port pins
1761 (two outputs, one input) to function. If this is
1762 defined, the board configuration must define several
1763 SPI configuration items (port pins to use, etc). For
1764 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001765
Ben Warren04a9e112008-01-16 22:37:35 -05001766 CONFIG_HARD_SPI
1767
1768 Enables a hardware SPI driver for general-purpose reads
1769 and writes. As with CONFIG_SOFT_SPI, the board configuration
1770 must define a list of chip-select function pointers.
1771 Currently supported on some MPC8xxx processors. For an
1772 example, see include/configs/mpc8349emds.h.
1773
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001774 CONFIG_MXC_SPI
1775
1776 Enables the driver for the SPI controllers on i.MX and MXC
1777 SoCs. Currently only i.MX31 is supported.
1778
Matthias Fuchs01335022007-12-27 17:12:34 +01001779- FPGA Support: CONFIG_FPGA
1780
1781 Enables FPGA subsystem.
1782
1783 CONFIG_FPGA_<vendor>
1784
1785 Enables support for specific chip vendors.
1786 (ALTERA, XILINX)
1787
1788 CONFIG_FPGA_<family>
1789
1790 Enables support for FPGA family.
1791 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1792
1793 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001794
wdenk43d96162003-03-06 00:02:04 +00001795 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001797 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001798
wdenk8bde7f72003-06-27 21:31:46 +00001799 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001801 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001802
wdenk43d96162003-03-06 00:02:04 +00001803 Enable checks on FPGA configuration interface busy
1804 status by the configuration function. This option
1805 will require a board or device specific function to
1806 be written.
wdenkc6097192002-11-03 00:24:07 +00001807
1808 CONFIG_FPGA_DELAY
1809
1810 If defined, a function that provides delays in the FPGA
1811 configuration driver.
1812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001813 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001814 Allow Control-C to interrupt FPGA configuration
1815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001816 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001817
wdenk43d96162003-03-06 00:02:04 +00001818 Check for configuration errors during FPGA bitfile
1819 loading. For example, abort during Virtex II
1820 configuration if the INIT_B line goes low (which
1821 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001822
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001823 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001824
wdenk43d96162003-03-06 00:02:04 +00001825 Maximum time to wait for the INIT_B line to deassert
1826 after PROB_B has been deasserted during a Virtex II
1827 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001828 ms.
wdenkc6097192002-11-03 00:24:07 +00001829
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001830 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001831
wdenk43d96162003-03-06 00:02:04 +00001832 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001833 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001834
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001835 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001836
wdenk43d96162003-03-06 00:02:04 +00001837 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001838 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001839
1840- Configuration Management:
1841 CONFIG_IDENT_STRING
1842
wdenk43d96162003-03-06 00:02:04 +00001843 If defined, this string will be added to the U-Boot
1844 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001845
1846- Vendor Parameter Protection:
1847
wdenk43d96162003-03-06 00:02:04 +00001848 U-Boot considers the values of the environment
1849 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001850 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001851 are set once by the board vendor / manufacturer, and
1852 protects these variables from casual modification by
1853 the user. Once set, these variables are read-only,
1854 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001855 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001856
1857 If CONFIG_ENV_OVERWRITE is #defined in your config
1858 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001859 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001860 these parameters.
1861
1862 Alternatively, if you #define _both_ CONFIG_ETHADDR
1863 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001864 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001865 which can be changed exactly ONCE by the user. [The
1866 serial# is unaffected by this, i. e. it remains
1867 read-only.]
1868
1869- Protected RAM:
1870 CONFIG_PRAM
1871
1872 Define this variable to enable the reservation of
1873 "protected RAM", i. e. RAM which is not overwritten
1874 by U-Boot. Define CONFIG_PRAM to hold the number of
1875 kB you want to reserve for pRAM. You can overwrite
1876 this default value by defining an environment
1877 variable "pram" to the number of kB you want to
1878 reserve. Note that the board info structure will
1879 still show the full amount of RAM. If pRAM is
1880 reserved, a new environment variable "mem" will
1881 automatically be defined to hold the amount of
1882 remaining RAM in a form that can be passed as boot
1883 argument to Linux, for instance like that:
1884
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001885 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001886 saveenv
1887
1888 This way you can tell Linux not to use this memory,
1889 either, which results in a memory region that will
1890 not be affected by reboots.
1891
1892 *WARNING* If your board configuration uses automatic
1893 detection of the RAM size, you must make sure that
1894 this memory test is non-destructive. So far, the
1895 following board configurations are known to be
1896 "pRAM-clean":
1897
1898 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1899 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001900 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001901
1902- Error Recovery:
1903 CONFIG_PANIC_HANG
1904
1905 Define this variable to stop the system in case of a
1906 fatal error, so that you have to reset it manually.
1907 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001908 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001909 automatically as fast as possible, but it may be
1910 useful during development since you can try to debug
1911 the conditions that lead to the situation.
1912
1913 CONFIG_NET_RETRY_COUNT
1914
wdenk43d96162003-03-06 00:02:04 +00001915 This variable defines the number of retries for
1916 network operations like ARP, RARP, TFTP, or BOOTP
1917 before giving up the operation. If not defined, a
1918 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001919
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001920 CONFIG_ARP_TIMEOUT
1921
1922 Timeout waiting for an ARP reply in milliseconds.
1923
wdenkc6097192002-11-03 00:24:07 +00001924- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001925 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001926
1927 Enable auto completion of commands using TAB.
1928
Wolfgang Denka9398e02006-11-27 15:32:42 +01001929 Note that this feature has NOT been implemented yet
1930 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001931
1932
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001933 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001934
1935 Define this variable to enable the "hush" shell (from
1936 Busybox) as command line interpreter, thus enabling
1937 powerful command line syntax like
1938 if...then...else...fi conditionals or `&&' and '||'
1939 constructs ("shell scripts").
1940
1941 If undefined, you get the old, much simpler behaviour
1942 with a somewhat smaller memory footprint.
1943
1944
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001945 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001946
1947 This defines the secondary prompt string, which is
1948 printed when the command interpreter needs more input
1949 to complete a command. Usually "> ".
1950
1951 Note:
1952
wdenk8bde7f72003-06-27 21:31:46 +00001953 In the current implementation, the local variables
1954 space and global environment variables space are
1955 separated. Local variables are those you define by
1956 simply typing `name=value'. To access a local
1957 variable later on, you have write `$name' or
1958 `${name}'; to execute the contents of a variable
1959 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001960
wdenk43d96162003-03-06 00:02:04 +00001961 Global environment variables are those you use
1962 setenv/printenv to work with. To run a command stored
1963 in such a variable, you need to use the run command,
1964 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001965
1966 To store commands and special characters in a
1967 variable, please use double quotation marks
1968 surrounding the whole text of the variable, instead
1969 of the backslashes before semicolons and special
1970 symbols.
1971
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001972- Commandline Editing and History:
1973 CONFIG_CMDLINE_EDITING
1974
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001975 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001976 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001977
wdenka8c7c702003-12-06 19:49:23 +00001978- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001979 CONFIG_EXTRA_ENV_SETTINGS
1980
wdenk43d96162003-03-06 00:02:04 +00001981 Define this to contain any number of null terminated
1982 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001983 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001984
wdenk43d96162003-03-06 00:02:04 +00001985 For example, place something like this in your
1986 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001987
1988 #define CONFIG_EXTRA_ENV_SETTINGS \
1989 "myvar1=value1\0" \
1990 "myvar2=value2\0"
1991
wdenk43d96162003-03-06 00:02:04 +00001992 Warning: This method is based on knowledge about the
1993 internal format how the environment is stored by the
1994 U-Boot code. This is NOT an official, exported
1995 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001996 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001997 You better know what you are doing here.
1998
wdenk43d96162003-03-06 00:02:04 +00001999 Note: overly (ab)use of the default environment is
2000 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002001 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002002 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002003
wdenka8c7c702003-12-06 19:49:23 +00002004- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002005 CONFIG_HAS_DATAFLASH
2006
wdenk8bde7f72003-06-27 21:31:46 +00002007 Defining this option enables DataFlash features and
2008 allows to read/write in Dataflash via the standard
2009 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002010
wdenk3f85ce22004-02-23 16:11:30 +00002011- SystemACE Support:
2012 CONFIG_SYSTEMACE
2013
2014 Adding this option adds support for Xilinx SystemACE
2015 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002016 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002017 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002018
2019 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002020 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002021
2022 When SystemACE support is added, the "ace" device type
2023 becomes available to the fat commands, i.e. fatls.
2024
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002025- TFTP Fixed UDP Port:
2026 CONFIG_TFTP_PORT
2027
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002028 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002029 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002030 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002031 number generator is used.
2032
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002033 Also, the environment variable tftpdstp is used to supply
2034 the TFTP UDP destination port value. If tftpdstp isn't
2035 defined, the normal port 69 is used.
2036
2037 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002038 blindly start the TFTP transfer using the pre-configured
2039 target IP address and UDP port. This has the effect of
2040 "punching through" the (Windows XP) firewall, allowing
2041 the remainder of the TFTP transfer to proceed normally.
2042 A better solution is to properly configure the firewall,
2043 but sometimes that is not allowed.
2044
wdenka8c7c702003-12-06 19:49:23 +00002045- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002046 CONFIG_SHOW_BOOT_PROGRESS
2047
wdenk43d96162003-03-06 00:02:04 +00002048 Defining this option allows to add some board-
2049 specific code (calling a user-provided function
2050 "show_boot_progress(int)") that enables you to show
2051 the system's boot progress on some display (for
2052 example, some LED's) on your board. At the moment,
2053 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002054
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002055- Standalone program support:
2056 CONFIG_STANDALONE_LOAD_ADDR
2057
2058 This option allows to define board specific values
2059 for the address where standalone program gets loaded,
2060 thus overwriting the architecutre dependent default
2061 settings.
2062
Minkyu Kangd32a1a42011-04-24 22:22:34 +00002063- Frame Buffer Address:
2064 CONFIG_FB_ADDR
2065
2066 Define CONFIG_FB_ADDR if you want to use specific address for
2067 frame buffer.
2068 Then system will reserve the frame buffer address to defined address
2069 instead of lcd_setmem (this function grab the memory for frame buffer
2070 by panel's size).
2071
2072 Please see board_init_f function.
2073
2074 If you want this config option then,
2075 please define it at your board config file
2076
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002077Legacy uImage format:
2078
wdenkc6097192002-11-03 00:24:07 +00002079 Arg Where When
2080 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002081 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002082 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002083 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002084 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002085 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002086 4 common/cmd_bootm.c Image data has correct checksum
2087 -4 common/cmd_bootm.c Image is for unsupported architecture
2088 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002089 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002090 6 common/cmd_bootm.c Image Type check OK
2091 -6 common/cmd_bootm.c gunzip uncompression error
2092 -7 common/cmd_bootm.c Unimplemented compression type
2093 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002094 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002095 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002096
2097 9 common/image.c Start initial ramdisk verification
2098 -10 common/image.c Ramdisk header has bad magic number
2099 -11 common/image.c Ramdisk header has bad checksum
2100 10 common/image.c Ramdisk header is OK
2101 -12 common/image.c Ramdisk data has bad checksum
2102 11 common/image.c Ramdisk data has correct checksum
2103 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002104 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002105 13 common/image.c Start multifile image verification
2106 14 common/image.c No initial ramdisk, no multifile, continue.
2107
Peter Tyserea0364f2010-04-12 22:28:04 -05002108 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002109
Stefan Roesea47a12b2010-04-15 16:07:28 +02002110 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002111 -31 post/post.c POST test failed, detected by post_output_backlog()
2112 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002113
Heiko Schocher566a4942007-06-22 19:11:54 +02002114 34 common/cmd_doc.c before loading a Image from a DOC device
2115 -35 common/cmd_doc.c Bad usage of "doc" command
2116 35 common/cmd_doc.c correct usage of "doc" command
2117 -36 common/cmd_doc.c No boot device
2118 36 common/cmd_doc.c correct boot device
2119 -37 common/cmd_doc.c Unknown Chip ID on boot device
2120 37 common/cmd_doc.c correct chip ID found, device available
2121 -38 common/cmd_doc.c Read Error on boot device
2122 38 common/cmd_doc.c reading Image header from DOC device OK
2123 -39 common/cmd_doc.c Image header has bad magic number
2124 39 common/cmd_doc.c Image header has correct magic number
2125 -40 common/cmd_doc.c Error reading Image from DOC device
2126 40 common/cmd_doc.c Image header has correct magic number
2127 41 common/cmd_ide.c before loading a Image from a IDE device
2128 -42 common/cmd_ide.c Bad usage of "ide" command
2129 42 common/cmd_ide.c correct usage of "ide" command
2130 -43 common/cmd_ide.c No boot device
2131 43 common/cmd_ide.c boot device found
2132 -44 common/cmd_ide.c Device not available
2133 44 common/cmd_ide.c Device available
2134 -45 common/cmd_ide.c wrong partition selected
2135 45 common/cmd_ide.c partition selected
2136 -46 common/cmd_ide.c Unknown partition table
2137 46 common/cmd_ide.c valid partition table found
2138 -47 common/cmd_ide.c Invalid partition type
2139 47 common/cmd_ide.c correct partition type
2140 -48 common/cmd_ide.c Error reading Image Header on boot device
2141 48 common/cmd_ide.c reading Image Header from IDE device OK
2142 -49 common/cmd_ide.c Image header has bad magic number
2143 49 common/cmd_ide.c Image header has correct magic number
2144 -50 common/cmd_ide.c Image header has bad checksum
2145 50 common/cmd_ide.c Image header has correct checksum
2146 -51 common/cmd_ide.c Error reading Image from IDE device
2147 51 common/cmd_ide.c reading Image from IDE device OK
2148 52 common/cmd_nand.c before loading a Image from a NAND device
2149 -53 common/cmd_nand.c Bad usage of "nand" command
2150 53 common/cmd_nand.c correct usage of "nand" command
2151 -54 common/cmd_nand.c No boot device
2152 54 common/cmd_nand.c boot device found
2153 -55 common/cmd_nand.c Unknown Chip ID on boot device
2154 55 common/cmd_nand.c correct chip ID found, device available
2155 -56 common/cmd_nand.c Error reading Image Header on boot device
2156 56 common/cmd_nand.c reading Image Header from NAND device OK
2157 -57 common/cmd_nand.c Image header has bad magic number
2158 57 common/cmd_nand.c Image header has correct magic number
2159 -58 common/cmd_nand.c Error reading Image from NAND device
2160 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002161
Heiko Schocher566a4942007-06-22 19:11:54 +02002162 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002163
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002164 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002165 -64 net/eth.c no Ethernet found.
2166 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002167
Heiko Schocher566a4942007-06-22 19:11:54 +02002168 -80 common/cmd_net.c usage wrong
2169 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002170 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002171 81 common/cmd_net.c NetLoop() back without error
2172 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2173 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002174 83 common/cmd_net.c running "source" command
2175 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002176 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002177
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002178FIT uImage format:
2179
2180 Arg Where When
2181 100 common/cmd_bootm.c Kernel FIT Image has correct format
2182 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2183 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2184 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2185 102 common/cmd_bootm.c Kernel unit name specified
2186 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002187 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002188 104 common/cmd_bootm.c Got kernel subimage node offset
2189 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2190 105 common/cmd_bootm.c Kernel subimage hash verification OK
2191 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2192 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002193 -106 common/cmd_bootm.c Kernel subimage has wrong type
2194 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002195 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2196 108 common/cmd_bootm.c Got kernel subimage data/size
2197 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2198 -109 common/cmd_bootm.c Can't get kernel subimage type
2199 -110 common/cmd_bootm.c Can't get kernel subimage comp
2200 -111 common/cmd_bootm.c Can't get kernel subimage os
2201 -112 common/cmd_bootm.c Can't get kernel subimage load address
2202 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2203
2204 120 common/image.c Start initial ramdisk verification
2205 -120 common/image.c Ramdisk FIT image has incorrect format
2206 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002207 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002208 -122 common/image.c Can't get configuration for ramdisk subimage
2209 123 common/image.c Ramdisk unit name specified
2210 -124 common/image.c Can't get ramdisk subimage node offset
2211 125 common/image.c Got ramdisk subimage node offset
2212 -125 common/image.c Ramdisk subimage hash verification failed
2213 126 common/image.c Ramdisk subimage hash verification OK
2214 -126 common/image.c Ramdisk subimage for unsupported architecture
2215 127 common/image.c Architecture check OK
2216 -127 common/image.c Can't get ramdisk subimage data/size
2217 128 common/image.c Got ramdisk subimage data/size
2218 129 common/image.c Can't get ramdisk load address
2219 -129 common/image.c Got ramdisk load address
2220
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002221 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002222 131 common/cmd_doc.c FIT image format OK
2223
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002224 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002225 141 common/cmd_ide.c FIT image format OK
2226
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002227 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002228 151 common/cmd_nand.c FIT image format OK
2229
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002230- Automatic software updates via TFTP server
2231 CONFIG_UPDATE_TFTP
2232 CONFIG_UPDATE_TFTP_CNT_MAX
2233 CONFIG_UPDATE_TFTP_MSEC_MAX
2234
2235 These options enable and control the auto-update feature;
2236 for a more detailed description refer to doc/README.update.
2237
2238- MTD Support (mtdparts command, UBI support)
2239 CONFIG_MTD_DEVICE
2240
2241 Adds the MTD device infrastructure from the Linux kernel.
2242 Needed for mtdparts command support.
2243
2244 CONFIG_MTD_PARTITIONS
2245
2246 Adds the MTD partitioning infrastructure from the Linux
2247 kernel. Needed for UBI support.
2248
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002249
wdenkc6097192002-11-03 00:24:07 +00002250Modem Support:
2251--------------
2252
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002253[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002254
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002255- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002256 CONFIG_MODEM_SUPPORT
2257
2258- RTS/CTS Flow control enable:
2259 CONFIG_HWFLOW
2260
2261- Modem debug support:
2262 CONFIG_MODEM_SUPPORT_DEBUG
2263
wdenk43d96162003-03-06 00:02:04 +00002264 Enables debugging stuff (char screen[1024], dbg())
2265 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002266
wdenka8c7c702003-12-06 19:49:23 +00002267- Interrupt support (PPC):
2268
wdenkd4ca31c2004-01-02 14:00:00 +00002269 There are common interrupt_init() and timer_interrupt()
2270 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002271 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002272 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002273 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002274 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002275 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002276 specific handling. If board has watchdog / status_led
2277 / other_activity_monitor it works automatically from
2278 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002279
wdenkc6097192002-11-03 00:24:07 +00002280- General:
2281
wdenk43d96162003-03-06 00:02:04 +00002282 In the target system modem support is enabled when a
2283 specific key (key combination) is pressed during
2284 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002285 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002286 board_init(). Currently key_pressed() is a dummy
2287 function, returning 1 and thus enabling modem
2288 initialization.
wdenkc6097192002-11-03 00:24:07 +00002289
wdenk43d96162003-03-06 00:02:04 +00002290 If there are no modem init strings in the
2291 environment, U-Boot proceed to autoboot; the
2292 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002293 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002294
2295 See also: doc/README.Modem
2296
2297
wdenkc6097192002-11-03 00:24:07 +00002298Configuration Settings:
2299-----------------------
2300
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002301- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002302 undefine this when you're short of memory.
2303
Peter Tyser2fb26042009-01-27 18:03:12 -06002304- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2305 width of the commands listed in the 'help' command output.
2306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002307- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002308 prompt for user input.
2309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002310- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002312- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002313
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002314- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002315
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002316- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002317 the application (usually a Linux kernel) when it is
2318 booted
2319
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002320- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002321 List of legal baudrate settings for this board.
2322
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002323- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002324 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002325
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002326- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002327 If the board specific function
2328 extern int overwrite_console (void);
2329 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002330 serial port, else the settings in the environment are used.
2331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002332- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002333 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002335- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002336 Enable overwrite of previous console environment settings.
2337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002338- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002339 Begin and End addresses of the area used by the
2340 simple memory test.
2341
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002342- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002343 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002345- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002346 Scratch address used by the alternate memory test
2347 You only need to set this if address zero isn't writeable
2348
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002349- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2350 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002351 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002352 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002353 fixing up gd->ram_size the Linux kernel should gets passed
2354 the now "corrected" memory size and won't touch it either.
2355 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002356 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002357 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002358 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002359
2360 This option can be used as a workaround for the 440EPx/GRx
2361 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2362 be touched.
2363
2364 WARNING: Please make sure that this value is a multiple of
2365 the Linux page size (normally 4k). If this is not the case,
2366 then the end address of the Linux memory will be located at a
2367 non page size aligned address and this could cause major
2368 problems.
2369
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002370- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002371 Default load address for network file downloads
2372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002373- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002374 Enable temporary baudrate change while serial download
2375
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002376- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002377 Physical start address of SDRAM. _Must_ be 0 here.
2378
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002379- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002380 Physical start address of Motherboard I/O (if using a
2381 Cogent motherboard)
2382
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002383- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002384 Physical start address of Flash memory.
2385
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002386- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002387 Physical start address of boot monitor code (set by
2388 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002389 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002390 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002392- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002393 Size of memory reserved for monitor code, used to
2394 determine _at_compile_time_ (!) if the environment is
2395 embedded within the U-Boot image, or in a separate
2396 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002398- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002399 Size of DRAM reserved for malloc() use.
2400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002401- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002402 Normally compressed uImages are limited to an
2403 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002404 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002405 to adjust this setting to your needs.
2406
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002407- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002408 Maximum size of memory mapped by the startup code of
2409 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002410 the Linux kernel (bd_info, boot arguments, FDT blob if
2411 used) must be put below this limit, unless "bootm_low"
2412 enviroment variable is defined and non-zero. In such case
2413 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002414 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2415 variable "bootm_mapsize" will override the value of
2416 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2417 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002418
John Rigbyfca43cc2010-10-13 13:57:35 -06002419- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2420 Enable initrd_high functionality. If defined then the
2421 initrd_high feature is enabled and the bootm ramdisk subcommand
2422 is enabled.
2423
2424- CONFIG_SYS_BOOT_GET_CMDLINE:
2425 Enables allocating and saving kernel cmdline in space between
2426 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2427
2428- CONFIG_SYS_BOOT_GET_KBD:
2429 Enables allocating and saving a kernel copy of the bd_info in
2430 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2431
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002432- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002433 Max number of Flash memory banks
2434
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002435- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002436 Max number of sectors on a Flash chip
2437
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002438- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002439 Timeout for Flash erase operations (in ms)
2440
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002441- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002442 Timeout for Flash write operations (in ms)
2443
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002444- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002445 Timeout for Flash set sector lock bit operation (in ms)
2446
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002447- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002448 Timeout for Flash clear lock bits operation (in ms)
2449
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002450- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002451 If defined, hardware flash sectors protection is used
2452 instead of U-Boot software protection.
2453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002454- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002455
2456 Enable TFTP transfers directly to flash memory;
2457 without this option such a download has to be
2458 performed in two steps: (1) download to RAM, and (2)
2459 copy from RAM to flash.
2460
2461 The two-step approach is usually more reliable, since
2462 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002463 the flash, but in some situations (when system RAM is
2464 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002465 downloaded image) this option may be very useful.
2466
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002467- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002468 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002469 common flash structure for storing flash geometry.
2470
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002471- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002472 This option also enables the building of the cfi_flash driver
2473 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002474
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002475- CONFIG_FLASH_CFI_MTD
2476 This option enables the building of the cfi_mtd driver
2477 in the drivers directory. The driver exports CFI flash
2478 to the MTD layer.
2479
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002480- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002481 Use buffered writes to flash.
2482
2483- CONFIG_FLASH_SPANSION_S29WS_N
2484 s29ws-n MirrorBit flash has non-standard addresses for buffered
2485 write commands.
2486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002487- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002488 If this option is defined, the common CFI flash doesn't
2489 print it's warning upon not recognized FLASH banks. This
2490 is useful, if some of the configured banks are only
2491 optionally available.
2492
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002493- CONFIG_FLASH_SHOW_PROGRESS
2494 If defined (must be an integer), print out countdown
2495 digits and dots. Recommended value: 45 (9..1) for 80
2496 column displays, 15 (3..1) for 40 column displays.
2497
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002498- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002499 Defines the number of Ethernet receive buffers. On some
2500 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002501 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2502 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002503 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002504 Defaults to 4 if not defined.
2505
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002506- CONFIG_ENV_MAX_ENTRIES
2507
Wolfgang Denk071bc922010-10-27 22:48:30 +02002508 Maximum number of entries in the hash table that is used
2509 internally to store the environment settings. The default
2510 setting is supposed to be generous and should work in most
2511 cases. This setting can be used to tune behaviour; see
2512 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002513
wdenkc6097192002-11-03 00:24:07 +00002514The following definitions that deal with the placement and management
2515of environment data (variable area); in general, we support the
2516following configurations:
2517
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002518- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002519
2520 Define this if the environment is in flash memory.
2521
2522 a) The environment occupies one whole flash sector, which is
2523 "embedded" in the text segment with the U-Boot code. This
2524 happens usually with "bottom boot sector" or "top boot
2525 sector" type flash chips, which have several smaller
2526 sectors at the start or the end. For instance, such a
2527 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2528 such a case you would place the environment in one of the
2529 4 kB sectors - with U-Boot code before and after it. With
2530 "top boot sector" type flash chips, you would put the
2531 environment in one of the last sectors, leaving a gap
2532 between U-Boot and the environment.
2533
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002534 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002535
2536 Offset of environment data (variable area) to the
2537 beginning of flash memory; for instance, with bottom boot
2538 type flash chips the second sector can be used: the offset
2539 for this sector is given here.
2540
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002541 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002542
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002543 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002544
2545 This is just another way to specify the start address of
2546 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002547 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002548
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002549 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002550
2551 Size of the sector containing the environment.
2552
2553
2554 b) Sometimes flash chips have few, equal sized, BIG sectors.
2555 In such a case you don't want to spend a whole sector for
2556 the environment.
2557
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002558 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002559
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002560 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002561 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002562 of this flash sector for the environment. This saves
2563 memory for the RAM copy of the environment.
2564
2565 It may also save flash memory if you decide to use this
2566 when your environment is "embedded" within U-Boot code,
2567 since then the remainder of the flash sector could be used
2568 for U-Boot code. It should be pointed out that this is
2569 STRONGLY DISCOURAGED from a robustness point of view:
2570 updating the environment in flash makes it always
2571 necessary to erase the WHOLE sector. If something goes
2572 wrong before the contents has been restored from a copy in
2573 RAM, your target system will be dead.
2574
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002575 - CONFIG_ENV_ADDR_REDUND
2576 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002577
wdenk43d96162003-03-06 00:02:04 +00002578 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002579 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002580 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002581 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002582
2583BE CAREFUL! Any changes to the flash layout, and some changes to the
2584source code will make it necessary to adapt <board>/u-boot.lds*
2585accordingly!
2586
2587
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002588- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002589
2590 Define this if you have some non-volatile memory device
2591 (NVRAM, battery buffered SRAM) which you want to use for the
2592 environment.
2593
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002594 - CONFIG_ENV_ADDR:
2595 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002596
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002597 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002598 want to use for environment. It is assumed that this memory
2599 can just be read and written to, without any special
2600 provision.
2601
2602BE CAREFUL! The first access to the environment happens quite early
2603in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002604console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002605U-Boot will hang.
2606
2607Please note that even with NVRAM we still use a copy of the
2608environment in RAM: we could work on NVRAM directly, but we want to
2609keep settings there always unmodified except somebody uses "saveenv"
2610to save the current settings.
2611
2612
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002613- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002614
2615 Use this if you have an EEPROM or similar serial access
2616 device and a driver for it.
2617
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002618 - CONFIG_ENV_OFFSET:
2619 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002620
2621 These two #defines specify the offset and size of the
2622 environment area within the total memory of your EEPROM.
2623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002624 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002625 If defined, specified the chip address of the EEPROM device.
2626 The default address is zero.
2627
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002628 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002629 If defined, the number of bits used to address bytes in a
2630 single page in the EEPROM device. A 64 byte page, for example
2631 would require six bits.
2632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002633 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002634 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002635 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002636
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002637 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002638 The length in bytes of the EEPROM memory array address. Note
2639 that this is NOT the chip address length!
2640
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002641 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002642 EEPROM chips that implement "address overflow" are ones
2643 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2644 address and the extra bits end up in the "chip address" bit
2645 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2646 byte chips.
2647
2648 Note that we consider the length of the address field to
2649 still be one byte because the extra address bits are hidden
2650 in the chip address.
2651
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002652 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002653 The size in bytes of the EEPROM device.
2654
Heiko Schocher548738b2010-01-07 08:55:40 +01002655 - CONFIG_ENV_EEPROM_IS_ON_I2C
2656 define this, if you have I2C and SPI activated, and your
2657 EEPROM, which holds the environment, is on the I2C bus.
2658
2659 - CONFIG_I2C_ENV_EEPROM_BUS
2660 if you have an Environment on an EEPROM reached over
2661 I2C muxes, you can define here, how to reach this
2662 EEPROM. For example:
2663
Wolfgang Denka9046b92010-06-13 17:48:15 +02002664 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002665
2666 EEPROM which holds the environment, is reached over
2667 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002668
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002669- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002670
wdenkd4ca31c2004-01-02 14:00:00 +00002671 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002672 want to use for the environment.
2673
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002674 - CONFIG_ENV_OFFSET:
2675 - CONFIG_ENV_ADDR:
2676 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002677
2678 These three #defines specify the offset and size of the
2679 environment area within the total memory of your DataFlash placed
2680 at the specified address.
2681
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002682- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002683
2684 Define this if you have a NAND device which you want to use
2685 for the environment.
2686
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002687 - CONFIG_ENV_OFFSET:
2688 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002689
2690 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002691 area within the first NAND device. CONFIG_ENV_OFFSET must be
2692 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002693
Scott Woodfdd813d2010-09-17 14:38:37 -05002694 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002695
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002696 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002697 size used to hold a redundant copy of the environment data, so
2698 that there is a valid backup copy in case there is a power failure
2699 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2700 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002701
Scott Woodfdd813d2010-09-17 14:38:37 -05002702 - CONFIG_ENV_RANGE (optional):
2703
2704 Specifies the length of the region in which the environment
2705 can be written. This should be a multiple of the NAND device's
2706 block size. Specifying a range with more erase blocks than
2707 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2708 the range to be avoided.
2709
2710 - CONFIG_ENV_OFFSET_OOB (optional):
2711
2712 Enables support for dynamically retrieving the offset of the
2713 environment from block zero's out-of-band data. The
2714 "nand env.oob" command can be used to record this offset.
2715 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2716 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002717
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002718- CONFIG_NAND_ENV_DST
2719
2720 Defines address in RAM to which the nand_spl code should copy the
2721 environment. If redundant environment is used, it will be copied to
2722 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2723
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002724- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002725
2726 Defines offset to the initial SPI buffer area in DPRAM. The
2727 area is used at an early stage (ROM part) if the environment
2728 is configured to reside in the SPI EEPROM: We need a 520 byte
2729 scratch DPRAM area. It is used between the two initialization
2730 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2731 to be a good choice since it makes it far enough from the
2732 start of the data area as well as from the stack pointer.
2733
Bruce Adlere881cb52007-11-02 13:15:42 -07002734Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002735has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002736created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002737until then to read environment variables.
2738
wdenk85ec0bc2003-03-31 16:34:49 +00002739The environment is protected by a CRC32 checksum. Before the monitor
2740is relocated into RAM, as a result of a bad CRC you will be working
2741with the compiled-in default environment - *silently*!!! [This is
2742necessary, because the first environment variable we need is the
2743"baudrate" setting for the console - if we have a bad CRC, we don't
2744have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002745
2746Note: once the monitor has been relocated, then it will complain if
2747the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002748use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002750- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002751 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002752
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002753 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002754 also needs to be defined.
2755
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002756- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002757 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002758
Ron Madridf5675aa2009-02-18 14:30:44 -08002759- CONFIG_NS16550_MIN_FUNCTIONS:
2760 Define this if you desire to only have use of the NS16550_init
2761 and NS16550_putc functions for the serial driver located at
2762 drivers/serial/ns16550.c. This option is useful for saving
2763 space for already greatly restricted images, including but not
2764 limited to NAND_SPL configurations.
2765
wdenkc6097192002-11-03 00:24:07 +00002766Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002767---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002769- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002770 Cache Line Size of the CPU.
2771
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002772- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002773 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002774
wdenk42d1f032003-10-15 23:53:47 +00002775 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2776 and RPXsuper) to be able to adjust the position of
2777 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002778
wdenk7f6c2cb2002-11-10 22:06:23 +00002779- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002780 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002781
2782 the default drive number (default value 0)
2783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002784 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002785
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002786 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002787 (default value 1)
2788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002789 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002790
wdenk43d96162003-03-06 00:02:04 +00002791 defines the offset of register from address. It
2792 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002793 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002794
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002795 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2796 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002797 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002798
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002799 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002800 fdc_hw_init() is called at the beginning of the FDC
2801 setup. fdc_hw_init() must be provided by the board
2802 source code. It is used to make hardware dependant
2803 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002804
Macpaul Lin0abddf82011-04-11 20:45:32 +00002805- CONFIG_IDE_AHB:
2806 Most IDE controllers were designed to be connected with PCI
2807 interface. Only few of them were designed for AHB interface.
2808 When software is doing ATA command and data transfer to
2809 IDE devices through IDE-AHB controller, some additional
2810 registers accessing to these kind of IDE-AHB controller
2811 is requierd.
2812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002813- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002814 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002815 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002816
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002817- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002818
wdenk7152b1d2003-09-05 23:19:14 +00002819 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002820 initial data and stack; please note that this must be
2821 writable memory that is working WITHOUT special
2822 initialization, i. e. you CANNOT use normal RAM which
2823 will become available only after programming the
2824 memory controller and running certain initialization
2825 sequences.
2826
2827 U-Boot uses the following memory types:
2828 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2829 - MPC824X: data cache
2830 - PPC4xx: data cache
2831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002832- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002833
2834 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002835 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2836 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002837 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002838 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002839 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2840 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2841 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002842
2843 Note:
2844 On the MPC824X (or other systems that use the data
2845 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002846 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002847 point to an otherwise UNUSED address space between
2848 the top of RAM and the start of the PCI space.
2849
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002850- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002851
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002852- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002853
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002854- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002855
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002856- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002857
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002858- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002859
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002860- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002862- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002863 SDRAM timing
2864
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002865- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002866 periodic timer for refresh
2867
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002868- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002870- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2871 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2872 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2873 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002874 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2875
2876- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002877 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2878 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002879 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002881- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2882 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002883 Machine Mode Register and Memory Periodic Timer
2884 Prescaler definitions (SDRAM timing)
2885
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002886- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002887 enable I2C microcode relocation patch (MPC8xx);
2888 define relocation offset in DPRAM [DSP2]
2889
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002890- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002891 enable SMC microcode relocation patch (MPC8xx);
2892 define relocation offset in DPRAM [SMC1]
2893
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002894- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002895 enable SPI microcode relocation patch (MPC8xx);
2896 define relocation offset in DPRAM [SCC4]
2897
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002898- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002899 Use OSCM clock mode on MBX8xx board. Be careful,
2900 wrong setting might damage your board. Read
2901 doc/README.MBX before setting this variable!
2902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002904 Offset of the bootmode word in DPRAM used by post
2905 (Power On Self Tests). This definition overrides
2906 #define'd default value in commproc.h resp.
2907 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002909- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2910 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2911 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2912 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2913 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2914 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2915 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2916 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002917 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002918
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002919- CONFIG_PCI_DISABLE_PCIE:
2920 Disable PCI-Express on systems where it is supported but not
2921 required.
2922
Kumar Galaa09b9b62010-12-30 12:09:53 -06002923- CONFIG_SYS_SRIO:
2924 Chip has SRIO or not
2925
2926- CONFIG_SRIO1:
2927 Board has SRIO 1 port available
2928
2929- CONFIG_SRIO2:
2930 Board has SRIO 2 port available
2931
2932- CONFIG_SYS_SRIOn_MEM_VIRT:
2933 Virtual Address of SRIO port 'n' memory region
2934
2935- CONFIG_SYS_SRIOn_MEM_PHYS:
2936 Physical Address of SRIO port 'n' memory region
2937
2938- CONFIG_SYS_SRIOn_MEM_SIZE:
2939 Size of SRIO port 'n' memory region
2940
Alex Watermaneced4622011-05-19 15:08:36 -04002941- CONFIG_SYS_NDFC_16
2942 Defined to tell the NDFC that the NAND chip is using a
2943 16 bit bus.
2944
2945- CONFIG_SYS_NDFC_EBC0_CFG
2946 Sets the EBC0_CFG register for the NDFC. If not defined
2947 a default value will be used.
2948
Ben Warrenbb99ad62006-09-07 16:50:54 -04002949- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002950 Get DDR timing information from an I2C EEPROM. Common
2951 with pluggable memory modules such as SODIMMs
2952
Ben Warrenbb99ad62006-09-07 16:50:54 -04002953 SPD_EEPROM_ADDRESS
2954 I2C address of the SPD EEPROM
2955
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002956- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002957 If SPD EEPROM is on an I2C bus other than the first
2958 one, specify here. Note that the value must resolve
2959 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002960
York Sun1b3e3c42011-06-07 09:42:16 +08002961- CONFIG_SYS_DDR_RAW_TIMING
2962 Get DDR timing information from other than SPD. Common with
2963 soldered DDR chips onboard without SPD. DDR raw timing
2964 parameters are extracted from datasheet and hard-coded into
2965 header files or board specific files.
2966
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002967- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002968 Only for 83xx systems. If specified, then DDR should
2969 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002970
wdenkc26e4542004-04-18 10:13:26 +00002971- CONFIG_ETHER_ON_FEC[12]
2972 Define to enable FEC[12] on a 8xx series processor.
2973
2974- CONFIG_FEC[12]_PHY
2975 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002976 to the given FEC; i. e.
2977 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002978 means that the PHY with address 4 is connected to FEC1
2979
2980 When set to -1, means to probe for first available.
2981
2982- CONFIG_FEC[12]_PHY_NORXERR
2983 The PHY does not have a RXERR line (RMII only).
2984 (so program the FEC to ignore it).
2985
2986- CONFIG_RMII
2987 Enable RMII mode for all FECs.
2988 Note that this is a global option, we can't
2989 have one FEC in standard MII mode and another in RMII mode.
2990
wdenk5cf91d62004-04-23 20:32:05 +00002991- CONFIG_CRC32_VERIFY
2992 Add a verify option to the crc32 command.
2993 The syntax is:
2994
2995 => crc32 -v <address> <count> <crc32>
2996
2997 Where address/count indicate a memory area
2998 and crc32 is the correct crc32 which the
2999 area should have.
3000
wdenk56523f12004-07-11 17:40:54 +00003001- CONFIG_LOOPW
3002 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003003 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003004
stroese7b466642004-12-16 18:46:55 +00003005- CONFIG_MX_CYCLIC
3006 Add the "mdc" and "mwc" memory commands. These are cyclic
3007 "md/mw" commands.
3008 Examples:
3009
wdenkefe2a4d2004-12-16 21:44:03 +00003010 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003011 This command will print 4 bytes (10,11,12,13) each 500 ms.
3012
wdenkefe2a4d2004-12-16 21:44:03 +00003013 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003014 This command will write 12345678 to address 100 all 10 ms.
3015
wdenkefe2a4d2004-12-16 21:44:03 +00003016 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003017 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003018
wdenk8aa1a2d2005-04-04 12:44:11 +00003019- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003020 [ARM only] If this variable is defined, then certain
3021 low level initializations (like setting up the memory
3022 controller) are omitted and/or U-Boot does not
3023 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003024
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003025 Normally this variable MUST NOT be defined. The only
3026 exception is when U-Boot is loaded (to RAM) by some
3027 other boot loader or by a debugger which performs
3028 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003029
Magnus Liljadf812382009-06-13 20:50:00 +02003030- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02003031 Modifies the behaviour of start.S when compiling a loader
3032 that is executed before the actual U-Boot. E.g. when
3033 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003034
Matthias Weisserd8834a12011-03-10 21:36:32 +00003035- CONFIG_USE_ARCH_MEMCPY
3036 CONFIG_USE_ARCH_MEMSET
3037 If these options are used a optimized version of memcpy/memset will
3038 be used if available. These functions may be faster under some
3039 conditions but may increase the binary size.
3040
wdenkc6097192002-11-03 00:24:07 +00003041Building the Software:
3042======================
3043
Wolfgang Denk218ca722008-03-26 10:40:12 +01003044Building U-Boot has been tested in several native build environments
3045and in many different cross environments. Of course we cannot support
3046all possibly existing versions of cross development tools in all
3047(potentially obsolete) versions. In case of tool chain problems we
3048recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3049which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003050
Wolfgang Denk218ca722008-03-26 10:40:12 +01003051If you are not using a native environment, it is assumed that you
3052have GNU cross compiling tools available in your path. In this case,
3053you must set the environment variable CROSS_COMPILE in your shell.
3054Note that no changes to the Makefile or any other source files are
3055necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003056
Wolfgang Denk218ca722008-03-26 10:40:12 +01003057 $ CROSS_COMPILE=ppc_4xx-
3058 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003059
Peter Tyser2f8d3962009-03-13 18:54:51 -05003060Note: If you wish to generate Windows versions of the utilities in
3061 the tools directory you can use the MinGW toolchain
3062 (http://www.mingw.org). Set your HOST tools to the MinGW
3063 toolchain and execute 'make tools'. For example:
3064
3065 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3066
3067 Binaries such as tools/mkimage.exe will be created which can
3068 be executed on computers running Windows.
3069
Wolfgang Denk218ca722008-03-26 10:40:12 +01003070U-Boot is intended to be simple to build. After installing the
3071sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003072is done by typing:
3073
3074 make NAME_config
3075
Wolfgang Denk218ca722008-03-26 10:40:12 +01003076where "NAME_config" is the name of one of the existing configu-
3077rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003078
wdenk2729af92004-05-03 20:45:30 +00003079Note: for some board special configuration names may exist; check if
3080 additional information is available from the board vendor; for
3081 instance, the TQM823L systems are available without (standard)
3082 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003083 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003084
wdenk2729af92004-05-03 20:45:30 +00003085 make TQM823L_config
3086 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003087
wdenk2729af92004-05-03 20:45:30 +00003088 make TQM823L_LCD_config
3089 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003090
wdenk2729af92004-05-03 20:45:30 +00003091 etc.
wdenkc6097192002-11-03 00:24:07 +00003092
wdenkc6097192002-11-03 00:24:07 +00003093
wdenk2729af92004-05-03 20:45:30 +00003094Finally, type "make all", and you should get some working U-Boot
3095images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003096
wdenk2729af92004-05-03 20:45:30 +00003097- "u-boot.bin" is a raw binary image
3098- "u-boot" is an image in ELF binary format
3099- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003100
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003101By default the build is performed locally and the objects are saved
3102in the source directory. One of the two methods can be used to change
3103this behavior and build U-Boot to some external directory:
3104
31051. Add O= to the make command line invocations:
3106
3107 make O=/tmp/build distclean
3108 make O=/tmp/build NAME_config
3109 make O=/tmp/build all
3110
31112. Set environment variable BUILD_DIR to point to the desired location:
3112
3113 export BUILD_DIR=/tmp/build
3114 make distclean
3115 make NAME_config
3116 make all
3117
3118Note that the command line "O=" setting overrides the BUILD_DIR environment
3119variable.
3120
wdenkc6097192002-11-03 00:24:07 +00003121
wdenk2729af92004-05-03 20:45:30 +00003122Please be aware that the Makefiles assume you are using GNU make, so
3123for instance on NetBSD you might need to use "gmake" instead of
3124native "make".
wdenkc6097192002-11-03 00:24:07 +00003125
wdenkc6097192002-11-03 00:24:07 +00003126
wdenk2729af92004-05-03 20:45:30 +00003127If the system board that you have is not listed, then you will need
3128to port U-Boot to your hardware platform. To do this, follow these
3129steps:
wdenkc6097192002-11-03 00:24:07 +00003130
wdenk2729af92004-05-03 20:45:30 +000031311. Add a new configuration option for your board to the toplevel
3132 "Makefile" and to the "MAKEALL" script, using the existing
3133 entries as examples. Note that here and at many other places
3134 boards and other names are listed in alphabetical sort order. Please
3135 keep this order.
31362. Create a new directory to hold your board specific code. Add any
3137 files you need. In your board directory, you will need at least
3138 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
31393. Create a new configuration file "include/configs/<board>.h" for
3140 your board
31413. If you're porting U-Boot to a new CPU, then also create a new
3142 directory to hold your CPU specific code. Add any files you need.
31434. Run "make <board>_config" with your new name.
31445. Type "make", and you should get a working "u-boot.srec" file
3145 to be installed on your target system.
31466. Debug and solve any problems that might arise.
3147 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003148
wdenkc6097192002-11-03 00:24:07 +00003149
wdenk2729af92004-05-03 20:45:30 +00003150Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3151==============================================================
wdenkc6097192002-11-03 00:24:07 +00003152
Wolfgang Denk218ca722008-03-26 10:40:12 +01003153If you have modified U-Boot sources (for instance added a new board
3154or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003155provide feedback to the other developers. The feedback normally takes
3156the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003157official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003158
Wolfgang Denk218ca722008-03-26 10:40:12 +01003159But before you submit such a patch, please verify that your modifi-
3160cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003161the supported boards compile WITHOUT ANY compiler warnings. To do so,
3162just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003163for ALL supported system. Be warned, this will take a while. You can
3164select which (cross) compiler to use by passing a `CROSS_COMPILE'
3165environment variable to the script, i. e. to use the ELDK cross tools
3166you can type
wdenkc6097192002-11-03 00:24:07 +00003167
wdenk2729af92004-05-03 20:45:30 +00003168 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003169
wdenk2729af92004-05-03 20:45:30 +00003170or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003171
wdenk2729af92004-05-03 20:45:30 +00003172 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003173
Wolfgang Denk218ca722008-03-26 10:40:12 +01003174When using the MAKEALL script, the default behaviour is to build
3175U-Boot in the source directory. This location can be changed by
3176setting the BUILD_DIR environment variable. Also, for each target
3177built, the MAKEALL script saves two log files (<target>.ERR and
3178<target>.MAKEALL) in the <source dir>/LOG directory. This default
3179location can be changed by setting the MAKEALL_LOGDIR environment
3180variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003181
3182 export BUILD_DIR=/tmp/build
3183 export MAKEALL_LOGDIR=/tmp/log
3184 CROSS_COMPILE=ppc_8xx- MAKEALL
3185
Wolfgang Denk218ca722008-03-26 10:40:12 +01003186With the above settings build objects are saved in the /tmp/build,
3187log files are saved in the /tmp/log and the source tree remains clean
3188during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003189
3190
wdenk2729af92004-05-03 20:45:30 +00003191See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003192
wdenkc6097192002-11-03 00:24:07 +00003193
wdenk2729af92004-05-03 20:45:30 +00003194Monitor Commands - Overview:
3195============================
wdenkc6097192002-11-03 00:24:07 +00003196
wdenk2729af92004-05-03 20:45:30 +00003197go - start application at address 'addr'
3198run - run commands in an environment variable
3199bootm - boot application image from memory
3200bootp - boot image via network using BootP/TFTP protocol
3201tftpboot- boot image via network using TFTP protocol
3202 and env variables "ipaddr" and "serverip"
3203 (and eventually "gatewayip")
3204rarpboot- boot image via network using RARP/TFTP protocol
3205diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3206loads - load S-Record file over serial line
3207loadb - load binary file over serial line (kermit mode)
3208md - memory display
3209mm - memory modify (auto-incrementing)
3210nm - memory modify (constant address)
3211mw - memory write (fill)
3212cp - memory copy
3213cmp - memory compare
3214crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003215i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003216sspi - SPI utility commands
3217base - print or set address offset
3218printenv- print environment variables
3219setenv - set environment variables
3220saveenv - save environment variables to persistent storage
3221protect - enable or disable FLASH write protection
3222erase - erase FLASH memory
3223flinfo - print FLASH memory information
3224bdinfo - print Board Info structure
3225iminfo - print header information for application image
3226coninfo - print console devices and informations
3227ide - IDE sub-system
3228loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003229loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003230mtest - simple RAM test
3231icache - enable or disable instruction cache
3232dcache - enable or disable data cache
3233reset - Perform RESET of the CPU
3234echo - echo args to console
3235version - print monitor version
3236help - print online help
3237? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003238
wdenkc6097192002-11-03 00:24:07 +00003239
wdenk2729af92004-05-03 20:45:30 +00003240Monitor Commands - Detailed Description:
3241========================================
wdenkc6097192002-11-03 00:24:07 +00003242
wdenk2729af92004-05-03 20:45:30 +00003243TODO.
wdenkc6097192002-11-03 00:24:07 +00003244
wdenk2729af92004-05-03 20:45:30 +00003245For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003246
3247
wdenk2729af92004-05-03 20:45:30 +00003248Environment Variables:
3249======================
wdenkc6097192002-11-03 00:24:07 +00003250
wdenk2729af92004-05-03 20:45:30 +00003251U-Boot supports user configuration using Environment Variables which
3252can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003253
wdenk2729af92004-05-03 20:45:30 +00003254Environment Variables are set using "setenv", printed using
3255"printenv", and saved to Flash using "saveenv". Using "setenv"
3256without a value can be used to delete a variable from the
3257environment. As long as you don't save the environment you are
3258working with an in-memory copy. In case the Flash area containing the
3259environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003260
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003261Some configuration options can be set using Environment Variables.
3262
3263List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003264
wdenk2729af92004-05-03 20:45:30 +00003265 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003266
wdenk2729af92004-05-03 20:45:30 +00003267 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003268
wdenk2729af92004-05-03 20:45:30 +00003269 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003270
wdenk2729af92004-05-03 20:45:30 +00003271 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003272
wdenk2729af92004-05-03 20:45:30 +00003273 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003274
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003275 bootm_low - Memory range available for image processing in the bootm
3276 command can be restricted. This variable is given as
3277 a hexadecimal number and defines lowest address allowed
3278 for use by the bootm command. See also "bootm_size"
3279 environment variable. Address defined by "bootm_low" is
3280 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003281 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3282 bootm_mapsize.
3283
3284 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3285 This variable is given as a hexadecimal number and it
3286 defines the size of the memory region starting at base
3287 address bootm_low that is accessible by the Linux kernel
3288 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3289 as the default value if it is defined, and bootm_size is
3290 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003291
3292 bootm_size - Memory range available for image processing in the bootm
3293 command can be restricted. This variable is given as
3294 a hexadecimal number and defines the size of the region
3295 allowed for use by the bootm command. See also "bootm_low"
3296 environment variable.
3297
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003298 updatefile - Location of the software update file on a TFTP server, used
3299 by the automatic software update feature. Please refer to
3300 documentation in doc/README.update for more details.
3301
wdenk2729af92004-05-03 20:45:30 +00003302 autoload - if set to "no" (any string beginning with 'n'),
3303 "bootp" will just load perform a lookup of the
3304 configuration from the BOOTP server, but not try to
3305 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307 autostart - if set to "yes", an image loaded using the "bootp",
3308 "rarpboot", "tftpboot" or "diskboot" commands will
3309 be automatically started (by internally calling
3310 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003311
wdenk2729af92004-05-03 20:45:30 +00003312 If set to "no", a standalone image passed to the
3313 "bootm" command will be copied to the load address
3314 (and eventually uncompressed), but NOT be started.
3315 This can be used to load and uncompress arbitrary
3316 data.
wdenkc6097192002-11-03 00:24:07 +00003317
wdenk17ea1172004-06-06 21:51:03 +00003318 i2cfast - (PPC405GP|PPC405EP only)
3319 if set to 'y' configures Linux I2C driver for fast
3320 mode (400kHZ). This environment variable is used in
3321 initialization code. So, for changes to be effective
3322 it must be saved and board must be reset.
3323
wdenk2729af92004-05-03 20:45:30 +00003324 initrd_high - restrict positioning of initrd images:
3325 If this variable is not set, initrd images will be
3326 copied to the highest possible address in RAM; this
3327 is usually what you want since it allows for
3328 maximum initrd size. If for some reason you want to
3329 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003330 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003331 variable to a value of "no" or "off" or "0".
3332 Alternatively, you can set it to a maximum upper
3333 address to use (U-Boot will still check that it
3334 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003335
wdenk2729af92004-05-03 20:45:30 +00003336 For instance, when you have a system with 16 MB
3337 RAM, and want to reserve 4 MB from use by Linux,
3338 you can do this by adding "mem=12M" to the value of
3339 the "bootargs" variable. However, now you must make
3340 sure that the initrd image is placed in the first
3341 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003342
wdenk2729af92004-05-03 20:45:30 +00003343 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003344
wdenk2729af92004-05-03 20:45:30 +00003345 If you set initrd_high to 0xFFFFFFFF, this is an
3346 indication to U-Boot that all addresses are legal
3347 for the Linux kernel, including addresses in flash
3348 memory. In this case U-Boot will NOT COPY the
3349 ramdisk at all. This may be useful to reduce the
3350 boot time on your system, but requires that this
3351 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003352
wdenk2729af92004-05-03 20:45:30 +00003353 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003354
wdenk2729af92004-05-03 20:45:30 +00003355 loadaddr - Default load address for commands like "bootp",
3356 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003357
wdenk2729af92004-05-03 20:45:30 +00003358 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003359
wdenk2729af92004-05-03 20:45:30 +00003360 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003361
wdenk2729af92004-05-03 20:45:30 +00003362 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003363
wdenk2729af92004-05-03 20:45:30 +00003364 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003365
wdenk2729af92004-05-03 20:45:30 +00003366 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003367
wdenk2729af92004-05-03 20:45:30 +00003368 ethprime - When CONFIG_NET_MULTI is enabled controls which
3369 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003370
wdenk2729af92004-05-03 20:45:30 +00003371 ethact - When CONFIG_NET_MULTI is enabled controls which
3372 interface is currently active. For example you
3373 can do the following
wdenkc6097192002-11-03 00:24:07 +00003374
Heiko Schocher48690d82010-07-20 17:45:02 +02003375 => setenv ethact FEC
3376 => ping 192.168.0.1 # traffic sent on FEC
3377 => setenv ethact SCC
3378 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003379
Matthias Fuchse1692572008-01-17 07:45:05 +01003380 ethrotate - When set to "no" U-Boot does not go through all
3381 available network interfaces.
3382 It just stays at the currently selected interface.
3383
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003384 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003385 either succeed or fail without retrying.
3386 When set to "once" the network operation will
3387 fail when all the available network interfaces
3388 are tried once without success.
3389 Useful on scripts which control the retry operation
3390 themselves.
wdenkc6097192002-11-03 00:24:07 +00003391
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003392 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003393
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003394 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003395 UDP source port.
3396
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003397 tftpdstport - If this is set, the value is used for TFTP's UDP
3398 destination port instead of the Well Know Port 69.
3399
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003400 tftpblocksize - Block size to use for TFTP transfers; if not set,
3401 we use the TFTP server's default block size
3402
3403 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3404 seconds, minimum value is 1000 = 1 second). Defines
3405 when a packet is considered to be lost so it has to
3406 be retransmitted. The default is 5000 = 5 seconds.
3407 Lowering this value may make downloads succeed
3408 faster in networks with high packet loss rates or
3409 with unreliable TFTP servers.
3410
3411 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003412 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003413 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003414
wdenk2729af92004-05-03 20:45:30 +00003415The following environment variables may be used and automatically
3416updated by the network boot commands ("bootp" and "rarpboot"),
3417depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003418
wdenk2729af92004-05-03 20:45:30 +00003419 bootfile - see above
3420 dnsip - IP address of your Domain Name Server
3421 dnsip2 - IP address of your secondary Domain Name Server
3422 gatewayip - IP address of the Gateway (Router) to use
3423 hostname - Target hostname
3424 ipaddr - see above
3425 netmask - Subnet Mask
3426 rootpath - Pathname of the root filesystem on the NFS server
3427 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003428
wdenka3d991b2004-04-15 21:48:45 +00003429
wdenk2729af92004-05-03 20:45:30 +00003430There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003431
wdenk2729af92004-05-03 20:45:30 +00003432 serial# - contains hardware identification information such
3433 as type string and/or serial number
3434 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003435
wdenk2729af92004-05-03 20:45:30 +00003436These variables can be set only once (usually during manufacturing of
3437the board). U-Boot refuses to delete or overwrite these variables
3438once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003439
3440
wdenk2729af92004-05-03 20:45:30 +00003441Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003442
wdenk2729af92004-05-03 20:45:30 +00003443 ver - Contains the U-Boot version string as printed
3444 with the "version" command. This variable is
3445 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003446
wdenkc6097192002-11-03 00:24:07 +00003447
wdenk2729af92004-05-03 20:45:30 +00003448Please note that changes to some configuration parameters may take
3449only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003450
stroesec1551ea2003-04-04 15:53:41 +00003451
wdenk2729af92004-05-03 20:45:30 +00003452Command Line Parsing:
3453=====================
stroesec1551ea2003-04-04 15:53:41 +00003454
wdenk2729af92004-05-03 20:45:30 +00003455There are two different command line parsers available with U-Boot:
3456the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003457
wdenk2729af92004-05-03 20:45:30 +00003458Old, simple command line parser:
3459--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003460
wdenk2729af92004-05-03 20:45:30 +00003461- supports environment variables (through setenv / saveenv commands)
3462- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003463- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003464- special characters ('$', ';') can be escaped by prefixing with '\',
3465 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003466 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003467- You can also escape text by enclosing in single apostrophes, for example:
3468 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003469
wdenk2729af92004-05-03 20:45:30 +00003470Hush shell:
3471-----------
wdenkf07771c2003-05-28 08:06:31 +00003472
wdenk2729af92004-05-03 20:45:30 +00003473- similar to Bourne shell, with control structures like
3474 if...then...else...fi, for...do...done; while...do...done,
3475 until...do...done, ...
3476- supports environment ("global") variables (through setenv / saveenv
3477 commands) and local shell variables (through standard shell syntax
3478 "name=value"); only environment variables can be used with "run"
3479 command
wdenkf07771c2003-05-28 08:06:31 +00003480
wdenk2729af92004-05-03 20:45:30 +00003481General rules:
3482--------------
wdenkf07771c2003-05-28 08:06:31 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484(1) If a command line (or an environment variable executed by a "run"
3485 command) contains several commands separated by semicolon, and
3486 one of these commands fails, then the remaining commands will be
3487 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003488
wdenk2729af92004-05-03 20:45:30 +00003489(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003490 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003491 command will cause "run" to terminate, i. e. the remaining
3492 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003493
wdenk2729af92004-05-03 20:45:30 +00003494Note for Redundant Ethernet Interfaces:
3495=======================================
wdenkf07771c2003-05-28 08:06:31 +00003496
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003497Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003498such configurations and is capable of automatic selection of a
3499"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003500
wdenk2729af92004-05-03 20:45:30 +00003501Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3502MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3503"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003504
wdenk2729af92004-05-03 20:45:30 +00003505If the network interface stores some valid MAC address (for instance
3506in SROM), this is used as default address if there is NO correspon-
3507ding setting in the environment; if the corresponding environment
3508variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510o If the SROM has a valid MAC address, and there is no address in the
3511 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003512
wdenk2729af92004-05-03 20:45:30 +00003513o If there is no valid address in the SROM, and a definition in the
3514 environment exists, then the value from the environment variable is
3515 used.
wdenkc6097192002-11-03 00:24:07 +00003516
wdenk2729af92004-05-03 20:45:30 +00003517o If both the SROM and the environment contain a MAC address, and
3518 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003519
wdenk2729af92004-05-03 20:45:30 +00003520o If both the SROM and the environment contain a MAC address, and the
3521 addresses differ, the value from the environment is used and a
3522 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003523
wdenk2729af92004-05-03 20:45:30 +00003524o If neither SROM nor the environment contain a MAC address, an error
3525 is raised.
wdenkc6097192002-11-03 00:24:07 +00003526
Ben Warrenecee9322010-04-26 11:11:46 -07003527If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3528will be programmed into hardware as part of the initialization process. This
3529may be skipped by setting the appropriate 'ethmacskip' environment variable.
3530The naming convention is as follows:
3531"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003532
wdenk2729af92004-05-03 20:45:30 +00003533Image Formats:
3534==============
wdenkc6097192002-11-03 00:24:07 +00003535
Marian Balakowicz3310c542008-03-12 12:13:13 +01003536U-Boot is capable of booting (and performing other auxiliary operations on)
3537images in two formats:
3538
3539New uImage format (FIT)
3540-----------------------
3541
3542Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3543to Flattened Device Tree). It allows the use of images with multiple
3544components (several kernels, ramdisks, etc.), with contents protected by
3545SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3546
3547
3548Old uImage format
3549-----------------
3550
3551Old image format is based on binary files which can be basically anything,
3552preceded by a special header; see the definitions in include/image.h for
3553details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003554
wdenk2729af92004-05-03 20:45:30 +00003555* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3556 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003557 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3558 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3559 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003560* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003561 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3562 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003563* Compression Type (uncompressed, gzip, bzip2)
3564* Load Address
3565* Entry Point
3566* Image Name
3567* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003568
wdenk2729af92004-05-03 20:45:30 +00003569The header is marked by a special Magic Number, and both the header
3570and the data portions of the image are secured against corruption by
3571CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003572
wdenkc6097192002-11-03 00:24:07 +00003573
wdenk2729af92004-05-03 20:45:30 +00003574Linux Support:
3575==============
wdenkc6097192002-11-03 00:24:07 +00003576
wdenk2729af92004-05-03 20:45:30 +00003577Although U-Boot should support any OS or standalone application
3578easily, the main focus has always been on Linux during the design of
3579U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003580
wdenk2729af92004-05-03 20:45:30 +00003581U-Boot includes many features that so far have been part of some
3582special "boot loader" code within the Linux kernel. Also, any
3583"initrd" images to be used are no longer part of one big Linux image;
3584instead, kernel and "initrd" are separate images. This implementation
3585serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk2729af92004-05-03 20:45:30 +00003587- the same features can be used for other OS or standalone
3588 applications (for instance: using compressed images to reduce the
3589 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591- it becomes much easier to port new Linux kernel versions because
3592 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003593
wdenk2729af92004-05-03 20:45:30 +00003594- the same Linux kernel image can now be used with different "initrd"
3595 images; of course this also means that different kernel images can
3596 be run with the same "initrd". This makes testing easier (you don't
3597 have to build a new "zImage.initrd" Linux image when you just
3598 change a file in your "initrd"). Also, a field-upgrade of the
3599 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003600
wdenkc6097192002-11-03 00:24:07 +00003601
wdenk2729af92004-05-03 20:45:30 +00003602Linux HOWTO:
3603============
wdenkc6097192002-11-03 00:24:07 +00003604
wdenk2729af92004-05-03 20:45:30 +00003605Porting Linux to U-Boot based systems:
3606---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003607
wdenk2729af92004-05-03 20:45:30 +00003608U-Boot cannot save you from doing all the necessary modifications to
3609configure the Linux device drivers for use with your target hardware
3610(no, we don't intend to provide a full virtual machine interface to
3611Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003612
Stefan Roesea47a12b2010-04-15 16:07:28 +02003613But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003614
wdenk2729af92004-05-03 20:45:30 +00003615Just make sure your machine specific header file (for instance
3616include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003617Information structure as we define in include/asm-<arch>/u-boot.h,
3618and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003619as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003620
wdenkc6097192002-11-03 00:24:07 +00003621
wdenk2729af92004-05-03 20:45:30 +00003622Configuring the Linux kernel:
3623-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003624
wdenk2729af92004-05-03 20:45:30 +00003625No specific requirements for U-Boot. Make sure you have some root
3626device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003627
wdenkc6097192002-11-03 00:24:07 +00003628
wdenk2729af92004-05-03 20:45:30 +00003629Building a Linux Image:
3630-----------------------
wdenkc6097192002-11-03 00:24:07 +00003631
wdenk2729af92004-05-03 20:45:30 +00003632With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3633not used. If you use recent kernel source, a new build target
3634"uImage" will exist which automatically builds an image usable by
3635U-Boot. Most older kernels also have support for a "pImage" target,
3636which was introduced for our predecessor project PPCBoot and uses a
3637100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003638
wdenk2729af92004-05-03 20:45:30 +00003639Example:
wdenkc6097192002-11-03 00:24:07 +00003640
wdenk2729af92004-05-03 20:45:30 +00003641 make TQM850L_config
3642 make oldconfig
3643 make dep
3644 make uImage
wdenkc6097192002-11-03 00:24:07 +00003645
wdenk2729af92004-05-03 20:45:30 +00003646The "uImage" build target uses a special tool (in 'tools/mkimage') to
3647encapsulate a compressed Linux kernel image with header information,
3648CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003649
wdenk2729af92004-05-03 20:45:30 +00003650* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003651
wdenk2729af92004-05-03 20:45:30 +00003652* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003653
wdenk2729af92004-05-03 20:45:30 +00003654 ${CROSS_COMPILE}-objcopy -O binary \
3655 -R .note -R .comment \
3656 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003657
wdenk2729af92004-05-03 20:45:30 +00003658* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003659
wdenk2729af92004-05-03 20:45:30 +00003660 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003663
wdenk2729af92004-05-03 20:45:30 +00003664 mkimage -A ppc -O linux -T kernel -C gzip \
3665 -a 0 -e 0 -n "Linux Kernel Image" \
3666 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003667
wdenk24ee89b2002-11-03 17:56:27 +00003668
wdenk2729af92004-05-03 20:45:30 +00003669The "mkimage" tool can also be used to create ramdisk images for use
3670with U-Boot, either separated from the Linux kernel image, or
3671combined into one file. "mkimage" encapsulates the images with a 64
3672byte header containing information about target architecture,
3673operating system, image type, compression method, entry points, time
3674stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003675
wdenk2729af92004-05-03 20:45:30 +00003676"mkimage" can be called in two ways: to verify existing images and
3677print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003678
wdenk2729af92004-05-03 20:45:30 +00003679In the first form (with "-l" option) mkimage lists the information
3680contained in the header of an existing U-Boot image; this includes
3681checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003682
wdenk2729af92004-05-03 20:45:30 +00003683 tools/mkimage -l image
3684 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003685
wdenk2729af92004-05-03 20:45:30 +00003686The second form (with "-d" option) is used to build a U-Boot image
3687from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003688
wdenk2729af92004-05-03 20:45:30 +00003689 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3690 -n name -d data_file image
3691 -A ==> set architecture to 'arch'
3692 -O ==> set operating system to 'os'
3693 -T ==> set image type to 'type'
3694 -C ==> set compression type 'comp'
3695 -a ==> set load address to 'addr' (hex)
3696 -e ==> set entry point to 'ep' (hex)
3697 -n ==> set image name to 'name'
3698 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003699
wdenk69459792004-05-29 16:53:29 +00003700Right now, all Linux kernels for PowerPC systems use the same load
3701address (0x00000000), but the entry point address depends on the
3702kernel version:
wdenkc6097192002-11-03 00:24:07 +00003703
wdenk2729af92004-05-03 20:45:30 +00003704- 2.2.x kernels have the entry point at 0x0000000C,
3705- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003706
wdenk2729af92004-05-03 20:45:30 +00003707So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003708
wdenk2729af92004-05-03 20:45:30 +00003709 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3710 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003711 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003712 > examples/uImage.TQM850L
3713 Image Name: 2.4.4 kernel for TQM850L
3714 Created: Wed Jul 19 02:34:59 2000
3715 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3716 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3717 Load Address: 0x00000000
3718 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003719
wdenk2729af92004-05-03 20:45:30 +00003720To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003721
wdenk2729af92004-05-03 20:45:30 +00003722 -> tools/mkimage -l examples/uImage.TQM850L
3723 Image Name: 2.4.4 kernel for TQM850L
3724 Created: Wed Jul 19 02:34:59 2000
3725 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3726 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3727 Load Address: 0x00000000
3728 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003729
wdenk2729af92004-05-03 20:45:30 +00003730NOTE: for embedded systems where boot time is critical you can trade
3731speed for memory and install an UNCOMPRESSED image instead: this
3732needs more space in Flash, but boots much faster since it does not
3733need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003734
Stefan Roesea47a12b2010-04-15 16:07:28 +02003735 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003736 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3737 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003738 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003739 > examples/uImage.TQM850L-uncompressed
3740 Image Name: 2.4.4 kernel for TQM850L
3741 Created: Wed Jul 19 02:34:59 2000
3742 Image Type: PowerPC Linux Kernel Image (uncompressed)
3743 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3744 Load Address: 0x00000000
3745 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003746
wdenkc6097192002-11-03 00:24:07 +00003747
wdenk2729af92004-05-03 20:45:30 +00003748Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3749when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003750
wdenk2729af92004-05-03 20:45:30 +00003751 -> tools/mkimage -n 'Simple Ramdisk Image' \
3752 > -A ppc -O linux -T ramdisk -C gzip \
3753 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3754 Image Name: Simple Ramdisk Image
3755 Created: Wed Jan 12 14:01:50 2000
3756 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3757 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3758 Load Address: 0x00000000
3759 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003760
wdenkdb01a2e2004-04-15 23:14:49 +00003761
wdenk2729af92004-05-03 20:45:30 +00003762Installing a Linux Image:
3763-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003764
wdenk2729af92004-05-03 20:45:30 +00003765To downloading a U-Boot image over the serial (console) interface,
3766you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003767
wdenk2729af92004-05-03 20:45:30 +00003768 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770The 'objcopy' does not understand the information in the U-Boot
3771image header, so the resulting S-Record file will be relative to
3772address 0x00000000. To load it to a given address, you need to
3773specify the target address as 'offset' parameter with the 'loads'
3774command.
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776Example: install the image to address 0x40100000 (which on the
3777TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003778
wdenk2729af92004-05-03 20:45:30 +00003779 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003780
wdenk2729af92004-05-03 20:45:30 +00003781 .......... done
3782 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003783
wdenk2729af92004-05-03 20:45:30 +00003784 => loads 40100000
3785 ## Ready for S-Record download ...
3786 ~>examples/image.srec
3787 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3788 ...
3789 15989 15990 15991 15992
3790 [file transfer complete]
3791 [connected]
3792 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003793
3794
wdenk2729af92004-05-03 20:45:30 +00003795You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003796this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003797corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003798
wdenk2729af92004-05-03 20:45:30 +00003799 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003800
wdenk2729af92004-05-03 20:45:30 +00003801 ## Checking Image at 40100000 ...
3802 Image Name: 2.2.13 for initrd on TQM850L
3803 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3804 Data Size: 335725 Bytes = 327 kB = 0 MB
3805 Load Address: 00000000
3806 Entry Point: 0000000c
3807 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003808
3809
wdenk2729af92004-05-03 20:45:30 +00003810Boot Linux:
3811-----------
wdenkc6097192002-11-03 00:24:07 +00003812
wdenk2729af92004-05-03 20:45:30 +00003813The "bootm" command is used to boot an application that is stored in
3814memory (RAM or Flash). In case of a Linux kernel image, the contents
3815of the "bootargs" environment variable is passed to the kernel as
3816parameters. You can check and modify this variable using the
3817"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003818
3819
wdenk2729af92004-05-03 20:45:30 +00003820 => printenv bootargs
3821 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk2729af92004-05-03 20:45:30 +00003823 => 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 +00003824
wdenk2729af92004-05-03 20:45:30 +00003825 => printenv bootargs
3826 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 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828 => bootm 40020000
3829 ## Booting Linux kernel at 40020000 ...
3830 Image Name: 2.2.13 for NFS on TQM850L
3831 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3832 Data Size: 381681 Bytes = 372 kB = 0 MB
3833 Load Address: 00000000
3834 Entry Point: 0000000c
3835 Verifying Checksum ... OK
3836 Uncompressing Kernel Image ... OK
3837 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
3838 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3839 time_init: decrementer frequency = 187500000/60
3840 Calibrating delay loop... 49.77 BogoMIPS
3841 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3842 ...
wdenkc6097192002-11-03 00:24:07 +00003843
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003844If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003845the memory addresses of both the kernel and the initrd image (PPBCOOT
3846format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk2729af92004-05-03 20:45:30 +00003850 ## Checking Image at 40100000 ...
3851 Image Name: 2.2.13 for initrd on TQM850L
3852 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3853 Data Size: 335725 Bytes = 327 kB = 0 MB
3854 Load Address: 00000000
3855 Entry Point: 0000000c
3856 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003857
wdenk2729af92004-05-03 20:45:30 +00003858 ## Checking Image at 40200000 ...
3859 Image Name: Simple Ramdisk Image
3860 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3861 Data Size: 566530 Bytes = 553 kB = 0 MB
3862 Load Address: 00000000
3863 Entry Point: 00000000
3864 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003865
wdenk2729af92004-05-03 20:45:30 +00003866 => bootm 40100000 40200000
3867 ## Booting Linux kernel at 40100000 ...
3868 Image Name: 2.2.13 for initrd on TQM850L
3869 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3870 Data Size: 335725 Bytes = 327 kB = 0 MB
3871 Load Address: 00000000
3872 Entry Point: 0000000c
3873 Verifying Checksum ... OK
3874 Uncompressing Kernel Image ... OK
3875 ## Loading RAMDisk Image at 40200000 ...
3876 Image Name: Simple Ramdisk Image
3877 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3878 Data Size: 566530 Bytes = 553 kB = 0 MB
3879 Load Address: 00000000
3880 Entry Point: 00000000
3881 Verifying Checksum ... OK
3882 Loading Ramdisk ... OK
3883 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
3884 Boot arguments: root=/dev/ram
3885 time_init: decrementer frequency = 187500000/60
3886 Calibrating delay loop... 49.77 BogoMIPS
3887 ...
3888 RAMDISK: Compressed image found at block 0
3889 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003890
wdenk2729af92004-05-03 20:45:30 +00003891 bash#
wdenkc6097192002-11-03 00:24:07 +00003892
Matthew McClintock02677682006-06-28 10:41:37 -05003893Boot Linux and pass a flat device tree:
3894-----------
3895
3896First, U-Boot must be compiled with the appropriate defines. See the section
3897titled "Linux Kernel Interface" above for a more in depth explanation. The
3898following is an example of how to start a kernel and pass an updated
3899flat device tree:
3900
3901=> print oftaddr
3902oftaddr=0x300000
3903=> print oft
3904oft=oftrees/mpc8540ads.dtb
3905=> tftp $oftaddr $oft
3906Speed: 1000, full duplex
3907Using TSEC0 device
3908TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3909Filename 'oftrees/mpc8540ads.dtb'.
3910Load address: 0x300000
3911Loading: #
3912done
3913Bytes transferred = 4106 (100a hex)
3914=> tftp $loadaddr $bootfile
3915Speed: 1000, full duplex
3916Using TSEC0 device
3917TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3918Filename 'uImage'.
3919Load address: 0x200000
3920Loading:############
3921done
3922Bytes transferred = 1029407 (fb51f hex)
3923=> print loadaddr
3924loadaddr=200000
3925=> print oftaddr
3926oftaddr=0x300000
3927=> bootm $loadaddr - $oftaddr
3928## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003929 Image Name: Linux-2.6.17-dirty
3930 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3931 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003932 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003933 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003934 Verifying Checksum ... OK
3935 Uncompressing Kernel Image ... OK
3936Booting using flat device tree at 0x300000
3937Using MPC85xx ADS machine description
3938Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3939[snip]
3940
3941
wdenk2729af92004-05-03 20:45:30 +00003942More About U-Boot Image Types:
3943------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003946
wdenk2729af92004-05-03 20:45:30 +00003947 "Standalone Programs" are directly runnable in the environment
3948 provided by U-Boot; it is expected that (if they behave
3949 well) you can continue to work in U-Boot after return from
3950 the Standalone Program.
3951 "OS Kernel Images" are usually images of some Embedded OS which
3952 will take over control completely. Usually these programs
3953 will install their own set of exception handlers, device
3954 drivers, set up the MMU, etc. - this means, that you cannot
3955 expect to re-enter U-Boot except by resetting the CPU.
3956 "RAMDisk Images" are more or less just data blocks, and their
3957 parameters (address, size) are passed to an OS kernel that is
3958 being started.
3959 "Multi-File Images" contain several images, typically an OS
3960 (Linux) kernel image and one or more data images like
3961 RAMDisks. This construct is useful for instance when you want
3962 to boot over the network using BOOTP etc., where the boot
3963 server provides just a single image file, but you want to get
3964 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003965
wdenk2729af92004-05-03 20:45:30 +00003966 "Multi-File Images" start with a list of image sizes, each
3967 image size (in bytes) specified by an "uint32_t" in network
3968 byte order. This list is terminated by an "(uint32_t)0".
3969 Immediately after the terminating 0 follow the images, one by
3970 one, all aligned on "uint32_t" boundaries (size rounded up to
3971 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973 "Firmware Images" are binary images containing firmware (like
3974 U-Boot or FPGA images) which usually will be programmed to
3975 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003976
wdenk2729af92004-05-03 20:45:30 +00003977 "Script files" are command sequences that will be executed by
3978 U-Boot's command interpreter; this feature is especially
3979 useful when you configure U-Boot to use a real shell (hush)
3980 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003981
wdenkc6097192002-11-03 00:24:07 +00003982
wdenk2729af92004-05-03 20:45:30 +00003983Standalone HOWTO:
3984=================
wdenkc6097192002-11-03 00:24:07 +00003985
wdenk2729af92004-05-03 20:45:30 +00003986One of the features of U-Boot is that you can dynamically load and
3987run "standalone" applications, which can use some resources of
3988U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003989
wdenk2729af92004-05-03 20:45:30 +00003990Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992"Hello World" Demo:
3993-------------------
wdenkc6097192002-11-03 00:24:07 +00003994
wdenk2729af92004-05-03 20:45:30 +00003995'examples/hello_world.c' contains a small "Hello World" Demo
3996application; it is automatically compiled when you build U-Boot.
3997It's configured to run at address 0x00040004, so you can play with it
3998like that:
wdenkc6097192002-11-03 00:24:07 +00003999
wdenk2729af92004-05-03 20:45:30 +00004000 => loads
4001 ## Ready for S-Record download ...
4002 ~>examples/hello_world.srec
4003 1 2 3 4 5 6 7 8 9 10 11 ...
4004 [file transfer complete]
4005 [connected]
4006 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk2729af92004-05-03 20:45:30 +00004008 => go 40004 Hello World! This is a test.
4009 ## Starting application at 0x00040004 ...
4010 Hello World
4011 argc = 7
4012 argv[0] = "40004"
4013 argv[1] = "Hello"
4014 argv[2] = "World!"
4015 argv[3] = "This"
4016 argv[4] = "is"
4017 argv[5] = "a"
4018 argv[6] = "test."
4019 argv[7] = "<NULL>"
4020 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk2729af92004-05-03 20:45:30 +00004024Another example, which demonstrates how to register a CPM interrupt
4025handler with the U-Boot code, can be found in 'examples/timer.c'.
4026Here, a CPM timer is set up to generate an interrupt every second.
4027The interrupt service routine is trivial, just printing a '.'
4028character, but this is just a demo program. The application can be
4029controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004030
wdenk2729af92004-05-03 20:45:30 +00004031 ? - print current values og the CPM Timer registers
4032 b - enable interrupts and start timer
4033 e - stop timer and disable interrupts
4034 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004035
wdenk2729af92004-05-03 20:45:30 +00004036 => loads
4037 ## Ready for S-Record download ...
4038 ~>examples/timer.srec
4039 1 2 3 4 5 6 7 8 9 10 11 ...
4040 [file transfer complete]
4041 [connected]
4042 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004043
wdenk2729af92004-05-03 20:45:30 +00004044 => go 40004
4045 ## Starting application at 0x00040004 ...
4046 TIMERS=0xfff00980
4047 Using timer 1
4048 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004049
wdenk2729af92004-05-03 20:45:30 +00004050Hit 'b':
4051 [q, b, e, ?] Set interval 1000000 us
4052 Enabling timer
4053Hit '?':
4054 [q, b, e, ?] ........
4055 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4056Hit '?':
4057 [q, b, e, ?] .
4058 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4059Hit '?':
4060 [q, b, e, ?] .
4061 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4062Hit '?':
4063 [q, b, e, ?] .
4064 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4065Hit 'e':
4066 [q, b, e, ?] ...Stopping timer
4067Hit 'q':
4068 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004069
4070
wdenk2729af92004-05-03 20:45:30 +00004071Minicom warning:
4072================
wdenk85ec0bc2003-03-31 16:34:49 +00004073
wdenk2729af92004-05-03 20:45:30 +00004074Over time, many people have reported problems when trying to use the
4075"minicom" terminal emulation program for serial download. I (wd)
4076consider minicom to be broken, and recommend not to use it. Under
4077Unix, I recommend to use C-Kermit for general purpose use (and
4078especially for kermit binary protocol download ("loadb" command), and
4079use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081Nevertheless, if you absolutely want to use it try adding this
4082configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004083
wdenk2729af92004-05-03 20:45:30 +00004084 Name Program Name U/D FullScr IO-Red. Multi
4085 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4086 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004087
4088
wdenk2729af92004-05-03 20:45:30 +00004089NetBSD Notes:
4090=============
wdenkc6097192002-11-03 00:24:07 +00004091
wdenk2729af92004-05-03 20:45:30 +00004092Starting at version 0.9.2, U-Boot supports NetBSD both as host
4093(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095Building requires a cross environment; it is known to work on
4096NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4097need gmake since the Makefiles are not compatible with BSD make).
4098Note that the cross-powerpc package does not install include files;
4099attempting to build U-Boot will fail because <machine/ansi.h> is
4100missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004101
wdenk2729af92004-05-03 20:45:30 +00004102 # cd /usr/pkg/cross/powerpc-netbsd/include
4103 # mkdir powerpc
4104 # ln -s powerpc machine
4105 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4106 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108Native builds *don't* work due to incompatibilities between native
4109and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004110
wdenk2729af92004-05-03 20:45:30 +00004111Booting assumes that (the first part of) the image booted is a
4112stage-2 loader which in turn loads and then invokes the kernel
4113proper. Loader sources will eventually appear in the NetBSD source
4114tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004115meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004116
4117
wdenk2729af92004-05-03 20:45:30 +00004118Implementation Internals:
4119=========================
wdenkc6097192002-11-03 00:24:07 +00004120
wdenk2729af92004-05-03 20:45:30 +00004121The following is not intended to be a complete description of every
4122implementation detail. However, it should help to understand the
4123inner workings of U-Boot and make it easier to port it to custom
4124hardware.
wdenkc6097192002-11-03 00:24:07 +00004125
4126
wdenk2729af92004-05-03 20:45:30 +00004127Initial Stack, Global Data:
4128---------------------------
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk2729af92004-05-03 20:45:30 +00004130The implementation of U-Boot is complicated by the fact that U-Boot
4131starts running out of ROM (flash memory), usually without access to
4132system RAM (because the memory controller is not initialized yet).
4133This means that we don't have writable Data or BSS segments, and BSS
4134is not initialized as zero. To be able to get a C environment working
4135at all, we have to allocate at least a minimal stack. Implementation
4136options for this are defined and restricted by the CPU used: Some CPU
4137models provide on-chip memory (like the IMMR area on MPC8xx and
4138MPC826x processors), on others (parts of) the data cache can be
4139locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004140
Wolfgang Denk218ca722008-03-26 10:40:12 +01004141 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004142 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004143
wdenk2729af92004-05-03 20:45:30 +00004144 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4145 From: "Chris Hallinan" <clh@net1plus.com>
4146 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4147 ...
wdenk43d96162003-03-06 00:02:04 +00004148
wdenk2729af92004-05-03 20:45:30 +00004149 Correct me if I'm wrong, folks, but the way I understand it
4150 is this: Using DCACHE as initial RAM for Stack, etc, does not
4151 require any physical RAM backing up the cache. The cleverness
4152 is that the cache is being used as a temporary supply of
4153 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004154 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004155 can see how this works by studying the cache architecture and
4156 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004157
wdenk2729af92004-05-03 20:45:30 +00004158 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4159 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004160 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004161 option should work for you. Using CS 4 should be fine if your
4162 board designers haven't used it for something that would
4163 cause you grief during the initial boot! It is frequently not
4164 used.
wdenk43d96162003-03-06 00:02:04 +00004165
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004166 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004167 with your processor/board/system design. The default value
4168 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004169 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004170 than your SDRAM module. If you have a 64MB SDRAM module, set
4171 it above 400_0000. Just make sure your board has no resources
4172 that are supposed to respond to that address! That code in
4173 start.S has been around a while and should work as is when
4174 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176 -Chris Hallinan
4177 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179It is essential to remember this, since it has some impact on the C
4180code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004181
wdenk2729af92004-05-03 20:45:30 +00004182* Initialized global data (data segment) is read-only. Do not attempt
4183 to write it.
wdenkc6097192002-11-03 00:24:07 +00004184
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004185* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004186 as zero data - BSS segment) at all - this is undefined, initiali-
4187 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004188
wdenk2729af92004-05-03 20:45:30 +00004189* Stack space is very limited. Avoid big data buffers or things like
4190 that.
wdenkc6097192002-11-03 00:24:07 +00004191
wdenk2729af92004-05-03 20:45:30 +00004192Having only the stack as writable memory limits means we cannot use
4193normal global data to share information beween the code. But it
4194turned out that the implementation of U-Boot can be greatly
4195simplified by making a global data structure (gd_t) available to all
4196functions. We could pass a pointer to this data as argument to _all_
4197functions, but this would bloat the code. Instead we use a feature of
4198the GCC compiler (Global Register Variables) to share the data: we
4199place a pointer (gd) to the global data into a register which we
4200reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004201
wdenk2729af92004-05-03 20:45:30 +00004202When choosing a register for such a purpose we are restricted by the
4203relevant (E)ABI specifications for the current architecture, and by
4204GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk2729af92004-05-03 20:45:30 +00004206For PowerPC, the following registers have specific use:
4207 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004208 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004209 R3-R4: parameter passing and return values
4210 R5-R10: parameter passing
4211 R13: small data area pointer
4212 R30: GOT pointer
4213 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004214
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004215 (U-Boot also uses R12 as internal GOT pointer. r12
4216 is a volatile register so r12 needs to be reset when
4217 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004218
Wolfgang Denke7670f62008-02-14 22:43:22 +01004219 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004220
wdenk2729af92004-05-03 20:45:30 +00004221 Note: on PPC, we could use a static initializer (since the
4222 address of the global data structure is known at compile time),
4223 but it turned out that reserving a register results in somewhat
4224 smaller code - although the code savings are not that big (on
4225 average for all boards 752 bytes for the whole U-Boot image,
4226 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004227
Robin Getzc4db3352009-08-17 15:23:02 +00004228On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004229 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4230
Robin Getzc4db3352009-08-17 15:23:02 +00004231 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004232
wdenk2729af92004-05-03 20:45:30 +00004233On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004234
wdenk2729af92004-05-03 20:45:30 +00004235 R0: function argument word/integer result
4236 R1-R3: function argument word
4237 R9: GOT pointer
4238 R10: stack limit (used only if stack checking if enabled)
4239 R11: argument (frame) pointer
4240 R12: temporary workspace
4241 R13: stack pointer
4242 R14: link register
4243 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004244
wdenk2729af92004-05-03 20:45:30 +00004245 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004246
Thomas Chou0df01fd2010-05-21 11:08:03 +08004247On Nios II, the ABI is documented here:
4248 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4249
4250 ==> U-Boot will use gp to hold a pointer to the global data
4251
4252 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4253 to access small data sections, so gp is free.
4254
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004255NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4256or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004257
wdenk2729af92004-05-03 20:45:30 +00004258Memory Management:
4259------------------
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk2729af92004-05-03 20:45:30 +00004261U-Boot runs in system state and uses physical addresses, i.e. the
4262MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264The available memory is mapped to fixed addresses using the memory
4265controller. In this process, a contiguous block is formed for each
4266memory type (Flash, SDRAM, SRAM), even when it consists of several
4267physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004268
wdenk2729af92004-05-03 20:45:30 +00004269U-Boot is installed in the first 128 kB of the first Flash bank (on
4270TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4271booting and sizing and initializing DRAM, the code relocates itself
4272to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004273memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004274configuration setting]. Below that, a structure with global Board
4275Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277Additionally, some exception handler code is copied to the low 8 kB
4278of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004279
wdenk2729af92004-05-03 20:45:30 +00004280So a typical memory configuration with 16 MB of DRAM could look like
4281this:
wdenkc6097192002-11-03 00:24:07 +00004282
wdenk2729af92004-05-03 20:45:30 +00004283 0x0000 0000 Exception Vector code
4284 :
4285 0x0000 1FFF
4286 0x0000 2000 Free for Application Use
4287 :
4288 :
wdenkc6097192002-11-03 00:24:07 +00004289
wdenk2729af92004-05-03 20:45:30 +00004290 :
4291 :
4292 0x00FB FF20 Monitor Stack (Growing downward)
4293 0x00FB FFAC Board Info Data and permanent copy of global data
4294 0x00FC 0000 Malloc Arena
4295 :
4296 0x00FD FFFF
4297 0x00FE 0000 RAM Copy of Monitor Code
4298 ... eventually: LCD or video framebuffer
4299 ... eventually: pRAM (Protected RAM - unchanged by reset)
4300 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004301
4302
wdenk2729af92004-05-03 20:45:30 +00004303System Initialization:
4304----------------------
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk2729af92004-05-03 20:45:30 +00004306In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004307(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004308configuration for CS0# this is a mirror of the onboard Flash memory.
4309To be able to re-map memory U-Boot then jumps to its link address.
4310To be able to implement the initialization code in C, a (small!)
4311initial stack is set up in the internal Dual Ported RAM (in case CPUs
4312which provide such a feature like MPC8xx or MPC8260), or in a locked
4313part of the data cache. After that, U-Boot initializes the CPU core,
4314the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004315
wdenk2729af92004-05-03 20:45:30 +00004316Next, all (potentially) available memory banks are mapped using a
4317preliminary mapping. For example, we put them on 512 MB boundaries
4318(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4319on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4320programmed for SDRAM access. Using the temporary configuration, a
4321simple memory test is run that determines the size of the SDRAM
4322banks.
wdenkc6097192002-11-03 00:24:07 +00004323
wdenk2729af92004-05-03 20:45:30 +00004324When there is more than one SDRAM bank, and the banks are of
4325different size, the largest is mapped first. For equal size, the first
4326bank (CS2#) is mapped first. The first mapping is always for address
43270x00000000, with any additional banks following immediately to create
4328contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004329
wdenk2729af92004-05-03 20:45:30 +00004330Then, the monitor installs itself at the upper end of the SDRAM area
4331and allocates memory for use by malloc() and for the global Board
4332Info data; also, the exception vector code is copied to the low RAM
4333pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004334
wdenk2729af92004-05-03 20:45:30 +00004335Only after this relocation will you have a "normal" C environment;
4336until that you are restricted in several ways, mostly because you are
4337running from ROM, and because the code will have to be relocated to a
4338new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004339
4340
wdenk2729af92004-05-03 20:45:30 +00004341U-Boot Porting Guide:
4342----------------------
wdenkc6097192002-11-03 00:24:07 +00004343
wdenk2729af92004-05-03 20:45:30 +00004344[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4345list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004346
4347
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004348int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004349{
4350 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004351
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004352 signal(SIGALRM, no_more_time);
4353 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk2729af92004-05-03 20:45:30 +00004355 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004356 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004357 return 0;
4358 }
4359
wdenk2729af92004-05-03 20:45:30 +00004360 Download latest U-Boot source;
4361
Wolfgang Denk06682362008-12-30 22:56:11 +01004362 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004363
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004364 if (clueless)
4365 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk2729af92004-05-03 20:45:30 +00004367 while (learning) {
4368 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004369 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4370 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004371 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004372 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004373 }
wdenkc6097192002-11-03 00:24:07 +00004374
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004375 if (available_money > toLocalCurrency ($2500))
4376 Buy a BDI3000;
4377 else
wdenk2729af92004-05-03 20:45:30 +00004378 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004379
4380 if (a similar board exists) { /* hopefully... */
4381 cp -a board/<similar> board/<myboard>
4382 cp include/configs/<similar>.h include/configs/<myboard>.h
4383 } else {
4384 Create your own board support subdirectory;
4385 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004386 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004387 Edit new board/<myboard> files
4388 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004389
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004390 while (!accepted) {
4391 while (!running) {
4392 do {
4393 Add / modify source code;
4394 } until (compiles);
4395 Debug;
4396 if (clueless)
4397 email("Hi, I am having problems...");
4398 }
4399 Send patch file to the U-Boot email list;
4400 if (reasonable critiques)
4401 Incorporate improvements from email list code review;
4402 else
4403 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004404 }
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406 return 0;
4407}
4408
4409void no_more_time (int sig)
4410{
4411 hire_a_guru();
4412}
wdenkc6097192002-11-03 00:24:07 +00004413
4414
wdenk2729af92004-05-03 20:45:30 +00004415Coding Standards:
4416-----------------
wdenkc6097192002-11-03 00:24:07 +00004417
wdenk2729af92004-05-03 20:45:30 +00004418All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004419coding style; see the file "Documentation/CodingStyle" and the script
4420"scripts/Lindent" in your Linux kernel source directory. In sources
4421originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4422spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004423
Detlev Zundel2c051652006-09-01 15:39:02 +02004424Source files originating from a different project (for example the
4425MTD subsystem) are generally exempt from these guidelines and are not
4426reformated to ease subsequent migration to newer versions of those
4427sources.
4428
4429Please note that U-Boot is implemented in C (and to some small parts in
4430Assembler); no C++ is used, so please do not use C++ style comments (//)
4431in your code.
wdenk2729af92004-05-03 20:45:30 +00004432
4433Please also stick to the following formatting rules:
4434- remove any trailing white space
4435- use TAB characters for indentation, not spaces
4436- make sure NOT to use DOS '\r\n' line feeds
4437- do not add more than 2 empty lines to source files
4438- do not add trailing empty lines to source files
4439
4440Submissions which do not conform to the standards may be returned
4441with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004442
4443
wdenk2729af92004-05-03 20:45:30 +00004444Submitting Patches:
4445-------------------
wdenkc6097192002-11-03 00:24:07 +00004446
wdenk2729af92004-05-03 20:45:30 +00004447Since the number of patches for U-Boot is growing, we need to
4448establish some rules. Submissions which do not conform to these rules
4449may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004450
Magnus Lilja0d28f342008-08-06 19:32:33 +02004451Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004452
Wolfgang Denk06682362008-12-30 22:56:11 +01004453Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4454see http://lists.denx.de/mailman/listinfo/u-boot
4455
wdenk2729af92004-05-03 20:45:30 +00004456When you send a patch, please include the following information with
4457it:
wdenkc6097192002-11-03 00:24:07 +00004458
wdenk2729af92004-05-03 20:45:30 +00004459* For bug fixes: a description of the bug and how your patch fixes
4460 this bug. Please try to include a way of demonstrating that the
4461 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004462
wdenk2729af92004-05-03 20:45:30 +00004463* For new features: a description of the feature and your
4464 implementation.
wdenkc6097192002-11-03 00:24:07 +00004465
wdenk2729af92004-05-03 20:45:30 +00004466* A CHANGELOG entry as plaintext (separate from the patch)
4467
4468* For major contributions, your entry to the CREDITS file
4469
4470* When you add support for a new board, don't forget to add this
4471 board to the MAKEALL script, too.
4472
4473* If your patch adds new configuration options, don't forget to
4474 document these in the README file.
4475
Wolfgang Denk218ca722008-03-26 10:40:12 +01004476* The patch itself. If you are using git (which is *strongly*
4477 recommended) you can easily generate the patch using the
4478 "git-format-patch". If you then use "git-send-email" to send it to
4479 the U-Boot mailing list, you will avoid most of the common problems
4480 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004481
Wolfgang Denk218ca722008-03-26 10:40:12 +01004482 If you cannot use git, use "diff -purN OLD NEW". If your version of
4483 diff does not support these options, then get the latest version of
4484 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004485
Wolfgang Denk218ca722008-03-26 10:40:12 +01004486 The current directory when running this command shall be the parent
4487 directory of the U-Boot source tree (i. e. please make sure that
4488 your patch includes sufficient directory information for the
4489 affected files).
4490
4491 We prefer patches as plain text. MIME attachments are discouraged,
4492 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004493
4494* If one logical set of modifications affects or creates several
4495 files, all these changes shall be submitted in a SINGLE patch file.
4496
4497* Changesets that contain different, unrelated modifications shall be
4498 submitted as SEPARATE patches, one patch per changeset.
4499
4500
4501Notes:
4502
4503* Before sending the patch, run the MAKEALL script on your patched
4504 source tree and make sure that no errors or warnings are reported
4505 for any of the boards.
4506
4507* Keep your modifications to the necessary minimum: A patch
4508 containing several unrelated changes or arbitrary reformats will be
4509 returned with a request to re-formatting / split it.
4510
4511* If you modify existing code, make sure that your new code does not
4512 add to the memory footprint of the code ;-) Small is beautiful!
4513 When adding new features, these should compile conditionally only
4514 (using #ifdef), and the resulting code with the new feature
4515 disabled must not need more memory than the old code without your
4516 modification.
wdenk90dc6702005-05-03 14:12:25 +00004517
Wolfgang Denk06682362008-12-30 22:56:11 +01004518* Remember that there is a size limit of 100 kB per message on the
4519 u-boot mailing list. Bigger patches will be moderated. If they are
4520 reasonable and not too big, they will be acknowledged. But patches
4521 bigger than the size limit should be avoided.