blob: 2754d1e8b899184df08e3cd588ca1ceca04f7575 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002# (C) Copyright 2000 - 2009
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Wolfgang Denka9046b92010-06-13 17:48:15 +0200150 /at91rm9200 Files specific to Atmel AT91RM9200 CPU
151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
183 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /nios2 Files generic to Altera NIOS2 architecture
185 /cpu CPU specific files
186 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200187 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /cpu CPU specific files
189 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
190 /mpc5xx Files specific to Freescale MPC5xx CPUs
191 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
192 /mpc8xx Files specific to Freescale MPC8xx CPUs
193 /mpc8220 Files specific to Freescale MPC8220 CPUs
194 /mpc824x Files specific to Freescale MPC824x CPUs
195 /mpc8260 Files specific to Freescale MPC8260 CPUs
196 /mpc85xx Files specific to Freescale MPC85xx CPUs
197 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
198 /lib Architecture specific library files
199 /sh Files generic to SH architecture
200 /cpu CPU specific files
201 /sh2 Files specific to sh2 CPUs
202 /sh3 Files specific to sh3 CPUs
203 /sh4 Files specific to sh4 CPUs
204 /lib Architecture specific library files
205 /sparc Files generic to SPARC architecture
206 /cpu CPU specific files
207 /leon2 Files specific to Gaisler LEON2 SPARC CPU
208 /leon3 Files specific to Gaisler LEON3 SPARC CPU
209 /lib Architecture specific library files
210/api Machine/arch independent API for external apps
211/board Board dependent files
212/common Misc architecture independent functions
213/disk Code for disk drive partition handling
214/doc Documentation (don't expect too much)
215/drivers Commonly used device drivers
216/examples Example code for standalone applications, etc.
217/fs Filesystem code (cramfs, ext2, jffs2, etc.)
218/include Header Files
219/lib Files generic to all architectures
220 /libfdt Library files to support flattened device trees
221 /lzma Library files to support LZMA decompression
222 /lzo Library files to support LZO decompression
223/net Networking code
224/post Power On Self Test
225/rtc Real Time Clock drivers
226/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000227
wdenkc6097192002-11-03 00:24:07 +0000228Software Configuration:
229=======================
230
231Configuration is usually done using C preprocessor defines; the
232rationale behind that is to avoid dead code whenever possible.
233
234There are two classes of configuration variables:
235
236* Configuration _OPTIONS_:
237 These are selectable by the user and have names beginning with
238 "CONFIG_".
239
240* Configuration _SETTINGS_:
241 These depend on the hardware etc. and should not be meddled with if
242 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200243 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000244
245Later we will add a configuration tool - probably similar to or even
246identical to what's used for the Linux kernel. Right now, we have to
247do the configuration by hand, which means creating some symbolic
248links and editing some configuration files. We use the TQM8xxL boards
249as an example here.
250
251
252Selection of Processor Architecture and Board Type:
253---------------------------------------------------
254
255For all supported boards there are ready-to-use default
256configurations available; just type "make <board_name>_config".
257
258Example: For a TQM823L module type:
259
260 cd u-boot
261 make TQM823L_config
262
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200263For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000264e.g. "make cogent_mpc8xx_config". And also configure the cogent
265directory according to the instructions in cogent/README.
266
267
268Configuration Options:
269----------------------
270
271Configuration depends on the combination of board and CPU type; all
272such information is kept in a configuration file
273"include/configs/<board_name>.h".
274
275Example: For a TQM823L module, all configuration settings are in
276"include/configs/TQM823L.h".
277
278
wdenk7f6c2cb2002-11-10 22:06:23 +0000279Many of the options are named exactly as the corresponding Linux
280kernel configuration options. The intention is to make it easier to
281build a config tool - later.
282
283
wdenkc6097192002-11-03 00:24:07 +0000284The following options need to be configured:
285
Kim Phillips26281142007-08-10 13:28:25 -0500286- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000287
Kim Phillips26281142007-08-10 13:28:25 -0500288- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200289
290- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100291 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000292
293- CPU Module Type: (if CONFIG_COGENT is defined)
294 Define exactly one of
295 CONFIG_CMA286_60_OLD
296--- FIXME --- not tested yet:
297 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298 CONFIG_CMA287_23, CONFIG_CMA287_50
299
300- Motherboard Type: (if CONFIG_COGENT is defined)
301 Define exactly one of
302 CONFIG_CMA101, CONFIG_CMA102
303
304- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305 Define one or more of
306 CONFIG_CMA302
307
308- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309 Define one or more of
310 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200311 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000312 a "rotator" |\-/|\-/
313
wdenk2535d602003-07-17 23:16:40 +0000314- Board flavour: (if CONFIG_MPC8260ADS is defined)
315 CONFIG_ADSTYPE
316 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200317 CONFIG_SYS_8260ADS - original MPC8260ADS
318 CONFIG_SYS_8266ADS - MPC8266ADS
319 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
320 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
wdenkc6097192002-11-03 00:24:07 +0000327- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000328 Define exactly one of
329 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200331- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
333 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000334 e.g. if there is no 32KHz
335 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
337 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000338
wdenk66ca92a2004-09-28 17:59:53 +0000339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_8xx_CPUCLK_MIN
341 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000343 See doc/README.MPC866
344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200345 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000346
wdenkba56f622004-02-06 23:19:44 +0000347 Define this to measure the actual CPU clock instead
348 of relying on the correctness of the configured
349 values. Mostly useful for board bringup to make sure
350 the PLL is locked at the intended frequency. Note
351 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200352 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000353
Heiko Schocher506f3912009-03-12 07:37:15 +0100354 CONFIG_SYS_DELAYED_ICACHE
355
356 Define this option if you want to enable the
357 ICache only when Code runs from RAM.
358
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
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100366- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200367 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100368
369 Defines the Monahans run mode to oscillator
370 ratio. Valid values are 8, 16, 24, 31. The core
371 frequency is this value multiplied by 13 MHz.
372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200373 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200374
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100375 Defines the Monahans turbo mode to oscillator
376 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200377 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100378 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200379
wdenk5da627a2003-10-09 20:09:04 +0000380- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000381 CONFIG_CLOCKS_IN_MHZ
382
383 U-Boot stores all clock information in Hz
384 internally. For binary compatibility with older Linux
385 kernels (which expect the clocks passed in the
386 bd_info data to be in MHz) the environment variable
387 "clocks_in_mhz" can be defined so that U-Boot
388 converts clock data to MHZ before passing it to the
389 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000390 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100391 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000392 default environment.
393
wdenk5da627a2003-10-09 20:09:04 +0000394 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
395
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200396 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000397 expect it to be in bytes, others in MB.
398 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
399
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400400 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200401
402 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400403 passed using flattened device trees (based on open firmware
404 concepts).
405
406 CONFIG_OF_LIBFDT
407 * New libfdt-based support
408 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500409 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400410
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200411 OF_CPU - The proper name of the cpus node (only required for
412 MPC512X and MPC5xxx based boards).
413 OF_SOC - The proper name of the soc node (only required for
414 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200415 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600416 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200417
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200418 boards with QUICC Engines require OF_QE to set UCC MAC
419 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500420
Kumar Gala4e253132006-01-11 13:54:17 -0600421 CONFIG_OF_BOARD_SETUP
422
423 Board code has addition modification that it wants to make
424 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000425
Matthew McClintock02677682006-06-28 10:41:37 -0500426 CONFIG_OF_BOOT_CPU
427
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200428 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500429 param header, the default value is zero if undefined.
430
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200431 CONFIG_OF_IDE_FIXUP
432
433 U-Boot can detect if an IDE device is present or not.
434 If not, and this new config option is activated, U-Boot
435 removes the ATA node from the DTS before booting Linux,
436 so the Linux IDE driver does not probe the device and
437 crash. This is needed for buggy hardware (uc101) where
438 no pull down resistor is connected to the signal IDE5V_DD7.
439
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100440- vxWorks boot parameters:
441
442 bootvx constructs a valid bootline using the following
443 environments variables: bootfile, ipaddr, serverip, hostname.
444 It loads the vxWorks image pointed bootfile.
445
446 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
447 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
448 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
449 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
450
451 CONFIG_SYS_VXWORKS_ADD_PARAMS
452
453 Add it at the end of the bootline. E.g "u=username pw=secret"
454
455 Note: If a "bootargs" environment is defined, it will overwride
456 the defaults discussed just above.
457
wdenk6705d812004-08-02 23:22:59 +0000458- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200459 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000460
461 Define this if you want support for Amba PrimeCell PL010 UARTs.
462
Andreas Engel48d01922008-09-08 14:30:53 +0200463 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000464
465 Define this if you want support for Amba PrimeCell PL011 UARTs.
466
467 CONFIG_PL011_CLOCK
468
469 If you have Amba PrimeCell PL011 UARTs, set this variable to
470 the clock speed of the UARTs.
471
472 CONFIG_PL01x_PORTS
473
474 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
475 define this to a list of base addresses for each (supported)
476 port. See e.g. include/configs/versatile.h
477
478
wdenkc6097192002-11-03 00:24:07 +0000479- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000480 Depending on board, define exactly one serial port
481 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
482 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
483 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000484
485 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
486 port routines must be defined elsewhere
487 (i.e. serial_init(), serial_getc(), ...)
488
489 CONFIG_CFB_CONSOLE
490 Enables console device for a color framebuffer. Needs following
491 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
492 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
493 (default big endian)
494 VIDEO_HW_RECTFILL graphic chip supports
495 rectangle fill
496 (cf. smiLynxEM)
497 VIDEO_HW_BITBLT graphic chip supports
498 bit-blit (cf. smiLynxEM)
499 VIDEO_VISIBLE_COLS visible pixel columns
500 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000501 VIDEO_VISIBLE_ROWS visible pixel rows
502 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000503 VIDEO_DATA_FORMAT graphic data format
504 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000505 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000506 VIDEO_KBD_INIT_FCT keyboard int fct
507 (i.e. i8042_kbd_init())
508 VIDEO_TSTC_FCT test char fct
509 (i.e. i8042_tstc)
510 VIDEO_GETC_FCT get char fct
511 (i.e. i8042_getc)
512 CONFIG_CONSOLE_CURSOR cursor drawing on/off
513 (requires blink timer
514 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200515 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000516 CONFIG_CONSOLE_TIME display time/date info in
517 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500518 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000519 CONFIG_VIDEO_LOGO display Linux logo in
520 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000521 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
522 linux_logo.h for logo.
523 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000524 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200525 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000526 the logo
527
wdenk43d96162003-03-06 00:02:04 +0000528 When CONFIG_CFB_CONSOLE is defined, video console is
529 default i/o. Serial console can be forced with
530 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000531
wdenkd4ca31c2004-01-02 14:00:00 +0000532 When CONFIG_SILENT_CONSOLE is defined, all console
533 messages (by U-Boot and Linux!) can be silenced with
534 the "silent" environment variable. See
535 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000536
wdenkc6097192002-11-03 00:24:07 +0000537- Console Baudrate:
538 CONFIG_BAUDRATE - in bps
539 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200540 CONFIG_SYS_BAUDRATE_TABLE, see below.
541 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000542
Heiko Schocherc92fac92009-01-30 12:55:38 +0100543- Console Rx buffer length
544 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
545 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100546 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100547 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
548 must be defined, to setup the maximum idle timeout for
549 the SMC.
550
wdenkc6097192002-11-03 00:24:07 +0000551- Boot Delay: CONFIG_BOOTDELAY - in seconds
552 Delay before automatically booting the default image;
553 set to -1 to disable autoboot.
554
555 See doc/README.autoboot for these options that
556 work with CONFIG_BOOTDELAY. None are required.
557 CONFIG_BOOT_RETRY_TIME
558 CONFIG_BOOT_RETRY_MIN
559 CONFIG_AUTOBOOT_KEYED
560 CONFIG_AUTOBOOT_PROMPT
561 CONFIG_AUTOBOOT_DELAY_STR
562 CONFIG_AUTOBOOT_STOP_STR
563 CONFIG_AUTOBOOT_DELAY_STR2
564 CONFIG_AUTOBOOT_STOP_STR2
565 CONFIG_ZERO_BOOTDELAY_CHECK
566 CONFIG_RESET_TO_RETRY
567
568- Autoboot Command:
569 CONFIG_BOOTCOMMAND
570 Only needed when CONFIG_BOOTDELAY is enabled;
571 define a command string that is automatically executed
572 when no character is read on the console interface
573 within "Boot Delay" after reset.
574
575 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000576 This can be used to pass arguments to the bootm
577 command. The value of CONFIG_BOOTARGS goes into the
578 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000579
580 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000581 The value of these goes into the environment as
582 "ramboot" and "nfsboot" respectively, and can be used
583 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200584 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000585
586- Pre-Boot Commands:
587 CONFIG_PREBOOT
588
589 When this option is #defined, the existence of the
590 environment variable "preboot" will be checked
591 immediately before starting the CONFIG_BOOTDELAY
592 countdown and/or running the auto-boot command resp.
593 entering interactive mode.
594
595 This feature is especially useful when "preboot" is
596 automatically generated or modified. For an example
597 see the LWMON board specific code: here "preboot" is
598 modified when the user holds down a certain
599 combination of keys on the (special) keyboard when
600 booting the systems
601
602- Serial Download Echo Mode:
603 CONFIG_LOADS_ECHO
604 If defined to 1, all characters received during a
605 serial download (using the "loads" command) are
606 echoed back. This might be needed by some terminal
607 emulations (like "cu"), but may as well just take
608 time on others. This setting #define's the initial
609 value of the "loads_echo" environment variable.
610
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500611- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000612 CONFIG_KGDB_BAUDRATE
613 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200614 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000615
616- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500617 Monitor commands can be included or excluded
618 from the build by using the #include files
619 "config_cmd_all.h" and #undef'ing unwanted
620 commands, or using "config_cmd_default.h"
621 and augmenting with additional #define's
622 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000623
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500624 The default command configuration includes all commands
625 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000626
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500627 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500628 CONFIG_CMD_BDI bdinfo
629 CONFIG_CMD_BEDBUG * Include BedBug Debugger
630 CONFIG_CMD_BMP * BMP support
631 CONFIG_CMD_BSP * Board specific commands
632 CONFIG_CMD_BOOTD bootd
633 CONFIG_CMD_CACHE * icache, dcache
634 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500635 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500636 CONFIG_CMD_DATE * support for RTC, date/time...
637 CONFIG_CMD_DHCP * DHCP support
638 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600639 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
640 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
641 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
642 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500643 CONFIG_CMD_DTT * Digital Therm and Thermostat
644 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500645 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500646 CONFIG_CMD_EEPROM * EEPROM read/write support
647 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500648 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500649 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500650 CONFIG_CMD_FDC * Floppy Disk Support
651 CONFIG_CMD_FAT * FAT partition support
652 CONFIG_CMD_FDOS * Dos diskette Support
653 CONFIG_CMD_FLASH flinfo, erase, protect
654 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500655 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000656 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500657 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
658 CONFIG_CMD_I2C * I2C serial bus support
659 CONFIG_CMD_IDE * IDE harddisk support
660 CONFIG_CMD_IMI iminfo
661 CONFIG_CMD_IMLS List all found images
662 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500663 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500664 CONFIG_CMD_IRQ * irqinfo
665 CONFIG_CMD_ITEST Integer/string test of 2 values
666 CONFIG_CMD_JFFS2 * JFFS2 Support
667 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500668 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500669 CONFIG_CMD_LOADB loadb
670 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400671 CONFIG_CMD_MD5SUM print md5 message digest
672 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500673 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
674 loop, loopw, mtest
675 CONFIG_CMD_MISC Misc functions like sleep etc
676 CONFIG_CMD_MMC * MMC memory mapped support
677 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100678 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500679 CONFIG_CMD_NAND * NAND support
680 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600681 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
682 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500683 CONFIG_CMD_PCI * pciinfo
684 CONFIG_CMD_PCMCIA * PCMCIA support
685 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
686 host
687 CONFIG_CMD_PORTIO * Port I/O
688 CONFIG_CMD_REGINFO * Register dump
689 CONFIG_CMD_RUN run command in env variable
690 CONFIG_CMD_SAVES * save S record dump
691 CONFIG_CMD_SCSI * SCSI Support
692 CONFIG_CMD_SDRAM * print SDRAM configuration information
693 (requires CONFIG_CMD_I2C)
694 CONFIG_CMD_SETGETDCR Support for DCR Register access
695 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100696 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400697 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200698 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500699 CONFIG_CMD_SPI * SPI serial bus support
700 CONFIG_CMD_USB * USB support
701 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500702 CONFIG_CMD_CDP * Cisco Discover Protocol support
703 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000704
wdenkc6097192002-11-03 00:24:07 +0000705
706 EXAMPLE: If you want all functions except of network
707 support you can write:
708
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500709 #include "config_cmd_all.h"
710 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000711
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400712 Other Commands:
713 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000714
715 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500716 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000717 what you (and your U-Boot users) are doing. Data
718 cache cannot be enabled on systems like the 8xx or
719 8260 (where accesses to the IMMR region must be
720 uncached), and it cannot be disabled on all other
721 systems where we (mis-) use the data cache to hold an
722 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000723
724
725 XXX - this list needs to get updated!
726
727- Watchdog:
728 CONFIG_WATCHDOG
729 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000730 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000731 code for a watchdog. For the 8xx and 8260 CPUs, the
732 SIU Watchdog feature is enabled in the SYPCR
733 register.
734
stroesec1551ea2003-04-04 15:53:41 +0000735- U-Boot Version:
736 CONFIG_VERSION_VARIABLE
737 If this variable is defined, an environment variable
738 named "ver" is created by U-Boot showing the U-Boot
739 version as printed by the "version" command.
740 This variable is readonly.
741
wdenkc6097192002-11-03 00:24:07 +0000742- Real-Time Clock:
743
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500744 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000745 has to be selected, too. Define exactly one of the
746 following options:
747
748 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
749 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200750 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000751 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000752 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000753 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000754 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000755 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100756 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000757 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200758 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200759 CONFIG_SYS_RV3029_TCR - enable trickle charger on
760 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000761
wdenkb37c7e52003-06-30 16:24:52 +0000762 Note that if the RTC uses I2C, then the I2C interface
763 must also be configured. See I2C Support, below.
764
Peter Tysere92739d2008-12-17 16:36:21 -0600765- GPIO Support:
766 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
767 CONFIG_PCA953X_INFO - enable pca953x info command
768
Chris Packham5dec49c2010-12-19 10:12:13 +0000769 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
770 chip-ngpio pairs that tell the PCA953X driver the number of
771 pins supported by a particular chip.
772
Peter Tysere92739d2008-12-17 16:36:21 -0600773 Note that if the GPIO device uses I2C, then the I2C interface
774 must also be configured. See I2C Support, below.
775
wdenkc6097192002-11-03 00:24:07 +0000776- Timestamp Support:
777
wdenk43d96162003-03-06 00:02:04 +0000778 When CONFIG_TIMESTAMP is selected, the timestamp
779 (date and time) of an image is printed by image
780 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500781 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000782
783- Partition Support:
784 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400785 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000786
Wolfgang Denk218ca722008-03-26 10:40:12 +0100787 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
788 CONFIG_CMD_SCSI) you must configure support for at
789 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000790
791- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000792 CONFIG_IDE_RESET_ROUTINE - this is defined in several
793 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000794
wdenk4d13cba2004-03-14 14:09:05 +0000795 CONFIG_IDE_RESET - is this is defined, IDE Reset will
796 be performed by calling the function
797 ide_set_reset(int reset)
798 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000799
800- ATAPI Support:
801 CONFIG_ATAPI
802
803 Set this to enable ATAPI support.
804
wdenkc40b2952004-03-13 23:29:43 +0000805- LBA48 Support
806 CONFIG_LBA48
807
808 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100809 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000810 Whithout these , LBA48 support uses 32bit variables and will 'only'
811 support disks up to 2.1TB.
812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200813 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000814 When enabled, makes the IDE subsystem use 64bit sector addresses.
815 Default is 32bit.
816
wdenkc6097192002-11-03 00:24:07 +0000817- SCSI Support:
818 At the moment only there is only support for the
819 SYM53C8XX SCSI controller; define
820 CONFIG_SCSI_SYM53C8XX to enable it.
821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200822 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
823 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
824 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000825 maximum numbers of LUNs, SCSI ID's and target
826 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200827 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000828
829- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000830 CONFIG_E1000
831 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000832
Andre Schwarzac3315c2008-03-06 16:45:44 +0100833 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200834 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100835
wdenkc6097192002-11-03 00:24:07 +0000836 CONFIG_EEPRO100
837 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200838 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000839 write routine for first time initialisation.
840
841 CONFIG_TULIP
842 Support for Digital 2114x chips.
843 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
844 modem chip initialisation (KS8761/QS6611).
845
846 CONFIG_NATSEMI
847 Support for National dp83815 chips.
848
849 CONFIG_NS8382X
850 Support for National dp8382[01] gigabit chips.
851
wdenk45219c42003-05-12 21:50:16 +0000852- NETWORK Support (other):
853
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100854 CONFIG_DRIVER_AT91EMAC
855 Support for AT91RM9200 EMAC.
856
857 CONFIG_RMII
858 Define this to use reduced MII inteface
859
860 CONFIG_DRIVER_AT91EMAC_QUIET
861 If this defined, the driver is quiet.
862 The driver doen't show link status messages.
863
wdenk45219c42003-05-12 21:50:16 +0000864 CONFIG_DRIVER_LAN91C96
865 Support for SMSC's LAN91C96 chips.
866
867 CONFIG_LAN91C96_BASE
868 Define this to hold the physical address
869 of the LAN91C96's I/O space
870
871 CONFIG_LAN91C96_USE_32_BIT
872 Define this to enable 32 bit addressing
873
wdenkf39748a2004-06-09 13:37:52 +0000874 CONFIG_DRIVER_SMC91111
875 Support for SMSC's LAN91C111 chip
876
877 CONFIG_SMC91111_BASE
878 Define this to hold the physical address
879 of the device (I/O space)
880
881 CONFIG_SMC_USE_32_BIT
882 Define this if data bus is 32 bits
883
884 CONFIG_SMC_USE_IOFUNCS
885 Define this to use i/o functions instead of macros
886 (some hardware wont work with macros)
887
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800888 CONFIG_FTGMAC100
889 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
890
891 CONFIG_FTGMAC100_EGIGA
892 Define this to use GE link update with gigabit PHY.
893 Define this if FTGMAC100 is connected to gigabit PHY.
894 If your system has 10/100 PHY only, it might not occur
895 wrong behavior. Because PHY usually return timeout or
896 useless data when polling gigabit status and gigabit
897 control registers. This behavior won't affect the
898 correctnessof 10/100 link speed update.
899
Mike Rapoportc2fff332009-11-11 10:03:03 +0200900 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200901 Support for SMSC's LAN911x and LAN921x chips
902
Mike Rapoportc2fff332009-11-11 10:03:03 +0200903 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200904 Define this to hold the physical address
905 of the device (I/O space)
906
Mike Rapoportc2fff332009-11-11 10:03:03 +0200907 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200908 Define this if data bus is 32 bits
909
Mike Rapoportc2fff332009-11-11 10:03:03 +0200910 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200911 Define this if data bus is 16 bits. If your processor
912 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200913 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200914
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900915 CONFIG_SH_ETHER
916 Support for Renesas on-chip Ethernet controller
917
918 CONFIG_SH_ETHER_USE_PORT
919 Define the number of ports to be used
920
921 CONFIG_SH_ETHER_PHY_ADDR
922 Define the ETH PHY's address
923
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900924 CONFIG_SH_ETHER_CACHE_WRITEBACK
925 If this option is set, the driver enables cache flush.
926
wdenkc6097192002-11-03 00:24:07 +0000927- USB Support:
928 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000929 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000930 CONFIG_USB_UHCI to enable it.
931 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000932 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000933 storage devices.
934 Note:
935 Supported are USB Keyboards and USB Floppy drives
936 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000937 MPC5200 USB requires additional defines:
938 CONFIG_USB_CLOCK
939 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500940 CONFIG_PSC3_USB
941 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000942 CONFIG_USB_CONFIG
943 for differential drivers: 0x00001000
944 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500945 for differential drivers on PSC3: 0x00000100
946 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200947 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200948 May be defined to allow interrupt polling
949 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000950
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200951- USB Device:
952 Define the below if you wish to use the USB console.
953 Once firmware is rebuilt from a serial console issue the
954 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200955 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200956 it has found a new device. The environment variable usbtty
957 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200958 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200959 Common Device Class Abstract Control Model serial device.
960 If you select usbtty = gserial you should be able to enumerate
961 a Linux host by
962 # modprobe usbserial vendor=0xVendorID product=0xProductID
963 else if using cdc_acm, simply setting the environment
964 variable usbtty to be cdc_acm should suffice. The following
965 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200966
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200967 CONFIG_USB_DEVICE
968 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000969
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200970 CONFIG_USB_TTY
971 Define this to have a tty type of device available to
972 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200973
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200974 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200975 Define this if you want stdin, stdout &/or stderr to
976 be set to usbtty.
977
978 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200979 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200980 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200981 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200982
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200983 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200984 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200985 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200986
Wolfgang Denk386eda02006-06-14 18:14:56 +0200987 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200988 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200989 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200990 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
991 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
992 should pretend to be a Linux device to it's target host.
993
994 CONFIG_USBD_MANUFACTURER
995 Define this string as the name of your company for
996 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200997
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200998 CONFIG_USBD_PRODUCT_NAME
999 Define this string as the name of your product
1000 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1001
1002 CONFIG_USBD_VENDORID
1003 Define this as your assigned Vendor ID from the USB
1004 Implementors Forum. This *must* be a genuine Vendor ID
1005 to avoid polluting the USB namespace.
1006 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001007
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001008 CONFIG_USBD_PRODUCTID
1009 Define this as the unique Product ID
1010 for your device
1011 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001012
1013
1014- MMC Support:
1015 The MMC controller on the Intel PXA is supported. To
1016 enable this define CONFIG_MMC. The MMC can be
1017 accessed from the boot prompt by mapping the device
1018 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001019 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1020 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001021
wdenk6705d812004-08-02 23:22:59 +00001022- Journaling Flash filesystem support:
1023 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1024 CONFIG_JFFS2_NAND_DEV
1025 Define these for a default partition on a NAND device
1026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001027 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1028 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001029 Define these for a default partition on a NOR device
1030
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001031 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001032 Define this to create an own partition. You have to provide a
1033 function struct part_info* jffs2_part_info(int part_num)
1034
1035 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001036 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001037 to disable the command chpart. This is the default when you
1038 have not defined a custom partition
1039
wdenkc6097192002-11-03 00:24:07 +00001040- Keyboard Support:
1041 CONFIG_ISA_KEYBOARD
1042
1043 Define this to enable standard (PC-Style) keyboard
1044 support
1045
1046 CONFIG_I8042_KBD
1047 Standard PC keyboard driver with US (is default) and
1048 GERMAN key layout (switch via environment 'keymap=de') support.
1049 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1050 for cfb_console. Supports cursor blinking.
1051
1052- Video support:
1053 CONFIG_VIDEO
1054
1055 Define this to enable video support (for output to
1056 video).
1057
1058 CONFIG_VIDEO_CT69000
1059
1060 Enable Chips & Technologies 69000 Video chip
1061
1062 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001063 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001064 video output is selected via environment 'videoout'
1065 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1066 assumed.
wdenkc6097192002-11-03 00:24:07 +00001067
wdenkb79a11c2004-03-25 15:14:43 +00001068 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001069 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001070 are possible:
1071 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001072 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001073
1074 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1075 -------------+---------------------------------------------
1076 8 bits | 0x301* 0x303 0x305 0x161 0x307
1077 15 bits | 0x310 0x313 0x316 0x162 0x319
1078 16 bits | 0x311 0x314 0x317 0x163 0x31A
1079 24 bits | 0x312 0x315 0x318 ? 0x31B
1080 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001081 (i.e. setenv videomode 317; saveenv; reset;)
1082
wdenkb79a11c2004-03-25 15:14:43 +00001083 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001084 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001085
1086
stroesec1551ea2003-04-04 15:53:41 +00001087 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001088 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001089 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1090 or CONFIG_VIDEO_SED13806_16BPP
1091
Timur Tabi7d3053f2011-02-15 17:09:19 -06001092 CONFIG_FSL_DIU_FB
1093 Enable the Freescale DIU video driver. Reference boards for
1094 SOCs that have a DIU should define this macro to enable DIU
1095 support, and should also define these other macros:
1096
1097 CONFIG_SYS_DIU_ADDR
1098 CONFIG_VIDEO
1099 CONFIG_CMD_BMP
1100 CONFIG_CFB_CONSOLE
1101 CONFIG_VIDEO_SW_CURSOR
1102 CONFIG_VGA_AS_SINGLE_DEVICE
1103 CONFIG_VIDEO_LOGO
1104 CONFIG_VIDEO_BMP_LOGO
1105
1106 The DIU driver will look for the 'monitor' environment variable,
1107 and if defined, enable the DIU as a console during boot. This
1108 variable should be set to one of these values:
1109
1110 '0' Output video to the DVI connector
1111 '1' Output video to the LVDS connector
1112 '2' Output video to the Dual-Link LVDS connector
1113
wdenk682011f2003-06-03 23:54:09 +00001114- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001115 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001116
wdenk8bde7f72003-06-27 21:31:46 +00001117 Define this to enable a custom keyboard support.
1118 This simply calls drv_keyboard_init() which must be
1119 defined in your board-specific files.
1120 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001121
wdenkc6097192002-11-03 00:24:07 +00001122- LCD Support: CONFIG_LCD
1123
1124 Define this to enable LCD support (for output to LCD
1125 display); also select one of the supported displays
1126 by defining one of these:
1127
Stelian Pop39cf4802008-05-09 21:57:18 +02001128 CONFIG_ATMEL_LCD:
1129
1130 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1131
wdenkfd3103b2003-11-25 16:55:19 +00001132 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001133
wdenkfd3103b2003-11-25 16:55:19 +00001134 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001135
wdenkfd3103b2003-11-25 16:55:19 +00001136 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001137
wdenkfd3103b2003-11-25 16:55:19 +00001138 NEC NL6448BC20-08. 6.5", 640x480.
1139 Active, color, single scan.
1140
1141 CONFIG_NEC_NL6448BC33_54
1142
1143 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001144 Active, color, single scan.
1145
1146 CONFIG_SHARP_16x9
1147
1148 Sharp 320x240. Active, color, single scan.
1149 It isn't 16x9, and I am not sure what it is.
1150
1151 CONFIG_SHARP_LQ64D341
1152
1153 Sharp LQ64D341 display, 640x480.
1154 Active, color, single scan.
1155
1156 CONFIG_HLD1045
1157
1158 HLD1045 display, 640x480.
1159 Active, color, single scan.
1160
1161 CONFIG_OPTREX_BW
1162
1163 Optrex CBL50840-2 NF-FW 99 22 M5
1164 or
1165 Hitachi LMG6912RPFC-00T
1166 or
1167 Hitachi SP14Q002
1168
1169 320x240. Black & white.
1170
1171 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001172 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001173
wdenk7152b1d2003-09-05 23:19:14 +00001174- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001175
wdenk8bde7f72003-06-27 21:31:46 +00001176 If this option is set, the environment is checked for
1177 a variable "splashimage". If found, the usual display
1178 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001179 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001180 specified in "splashimage" is loaded instead. The
1181 console is redirected to the "nulldev", too. This
1182 allows for a "silent" boot where a splash screen is
1183 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001184
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001185 CONFIG_SPLASH_SCREEN_ALIGN
1186
1187 If this option is set the splash image can be freely positioned
1188 on the screen. Environment variable "splashpos" specifies the
1189 position as "x,y". If a positive number is given it is used as
1190 number of pixel from left/top. If a negative number is given it
1191 is used as number of pixel from right/bottom. You can also
1192 specify 'm' for centering the image.
1193
1194 Example:
1195 setenv splashpos m,m
1196 => image at center of screen
1197
1198 setenv splashpos 30,20
1199 => image at x = 30 and y = 20
1200
1201 setenv splashpos -10,m
1202 => vertically centered image
1203 at x = dspWidth - bmpWidth - 9
1204
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001205- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1206
1207 If this option is set, additionally to standard BMP
1208 images, gzipped BMP images can be displayed via the
1209 splashscreen support or the bmp command.
1210
Anatolij Gustschind5011762010-03-15 14:50:25 +01001211- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1212
1213 If this option is set, 8-bit RLE compressed BMP images
1214 can be displayed via the splashscreen support or the
1215 bmp command.
1216
wdenkc29fdfc2003-08-29 20:57:53 +00001217- Compression support:
1218 CONFIG_BZIP2
1219
1220 If this option is set, support for bzip2 compressed
1221 images is included. If not, only uncompressed and gzip
1222 compressed images are supported.
1223
wdenk42d1f032003-10-15 23:53:47 +00001224 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001225 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001226 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001227
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001228 CONFIG_LZMA
1229
1230 If this option is set, support for lzma compressed
1231 images is included.
1232
1233 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1234 requires an amount of dynamic memory that is given by the
1235 formula:
1236
1237 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1238
1239 Where lc and lp stand for, respectively, Literal context bits
1240 and Literal pos bits.
1241
1242 This value is upper-bounded by 14MB in the worst case. Anyway,
1243 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1244 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1245 a very small buffer.
1246
1247 Use the lzmainfo tool to determinate the lc and lp values and
1248 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001249 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001250
wdenk17ea1172004-06-06 21:51:03 +00001251- MII/PHY support:
1252 CONFIG_PHY_ADDR
1253
1254 The address of PHY on MII bus.
1255
1256 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1257
1258 The clock frequency of the MII bus
1259
1260 CONFIG_PHY_GIGE
1261
1262 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001263 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001264
1265 CONFIG_PHY_RESET_DELAY
1266
1267 Some PHY like Intel LXT971A need extra delay after
1268 reset before any MII register access is possible.
1269 For such PHY, set this option to the usec delay
1270 required. (minimum 300usec for LXT971A)
1271
1272 CONFIG_PHY_CMD_DELAY (ppc4xx)
1273
1274 Some PHY like Intel LXT971A need extra delay after
1275 command issued before MII status register can be read
1276
wdenkc6097192002-11-03 00:24:07 +00001277- Ethernet address:
1278 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001279 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001280 CONFIG_ETH2ADDR
1281 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001282 CONFIG_ETH4ADDR
1283 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001284
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001285 Define a default value for Ethernet address to use
1286 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001287 is not determined automatically.
1288
1289- IP address:
1290 CONFIG_IPADDR
1291
1292 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001293 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001294 determined through e.g. bootp.
1295
1296- Server IP address:
1297 CONFIG_SERVERIP
1298
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001299 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001300 server to contact when using the "tftboot" command.
1301
Robin Getz97cfe862009-07-21 12:15:28 -04001302 CONFIG_KEEP_SERVERADDR
1303
1304 Keeps the server's MAC address, in the env 'serveraddr'
1305 for passing to bootargs (like Linux's netconsole option)
1306
David Updegraff53a5c422007-06-11 10:41:07 -05001307- Multicast TFTP Mode:
1308 CONFIG_MCAST_TFTP
1309
1310 Defines whether you want to support multicast TFTP as per
1311 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001312 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001313 driver in use must provide a function: mcast() to join/leave a
1314 multicast group.
1315
1316 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001317- BOOTP Recovery Mode:
1318 CONFIG_BOOTP_RANDOM_DELAY
1319
1320 If you have many targets in a network that try to
1321 boot using BOOTP, you may want to avoid that all
1322 systems send out BOOTP requests at precisely the same
1323 moment (which would happen for instance at recovery
1324 from a power failure, when all systems will try to
1325 boot, thus flooding the BOOTP server. Defining
1326 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1327 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001328 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001329
1330 1st BOOTP request: delay 0 ... 1 sec
1331 2nd BOOTP request: delay 0 ... 2 sec
1332 3rd BOOTP request: delay 0 ... 4 sec
1333 4th and following
1334 BOOTP requests: delay 0 ... 8 sec
1335
stroesefe389a82003-08-28 14:17:32 +00001336- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001337 You can fine tune the DHCP functionality by defining
1338 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001339
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001340 CONFIG_BOOTP_SUBNETMASK
1341 CONFIG_BOOTP_GATEWAY
1342 CONFIG_BOOTP_HOSTNAME
1343 CONFIG_BOOTP_NISDOMAIN
1344 CONFIG_BOOTP_BOOTPATH
1345 CONFIG_BOOTP_BOOTFILESIZE
1346 CONFIG_BOOTP_DNS
1347 CONFIG_BOOTP_DNS2
1348 CONFIG_BOOTP_SEND_HOSTNAME
1349 CONFIG_BOOTP_NTPSERVER
1350 CONFIG_BOOTP_TIMEOFFSET
1351 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001352
Wilson Callan5d110f02007-07-28 10:56:13 -04001353 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1354 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001355
1356 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1357 serverip from a DHCP server, it is possible that more
1358 than one DNS serverip is offered to the client.
1359 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1360 serverip will be stored in the additional environment
1361 variable "dnsip2". The first DNS serverip is always
1362 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001363 is defined.
stroesefe389a82003-08-28 14:17:32 +00001364
1365 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1366 to do a dynamic update of a DNS server. To do this, they
1367 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001368 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001369 of the "hostname" environment variable is passed as
1370 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001371
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001372 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1373
1374 A 32bit value in microseconds for a delay between
1375 receiving a "DHCP Offer" and sending the "DHCP Request".
1376 This fixes a problem with certain DHCP servers that don't
1377 respond 100% of the time to a "DHCP request". E.g. On an
1378 AT91RM9200 processor running at 180MHz, this delay needed
1379 to be *at least* 15,000 usec before a Windows Server 2003
1380 DHCP server would reply 100% of the time. I recommend at
1381 least 50,000 usec to be safe. The alternative is to hope
1382 that one of the retries will be successful but note that
1383 the DHCP timeout and retry process takes a longer than
1384 this delay.
1385
wdenka3d991b2004-04-15 21:48:45 +00001386 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001387 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001388
1389 The device id used in CDP trigger frames.
1390
1391 CONFIG_CDP_DEVICE_ID_PREFIX
1392
1393 A two character string which is prefixed to the MAC address
1394 of the device.
1395
1396 CONFIG_CDP_PORT_ID
1397
1398 A printf format string which contains the ascii name of
1399 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001400 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001401
1402 CONFIG_CDP_CAPABILITIES
1403
1404 A 32bit integer which indicates the device capabilities;
1405 0x00000010 for a normal host which does not forwards.
1406
1407 CONFIG_CDP_VERSION
1408
1409 An ascii string containing the version of the software.
1410
1411 CONFIG_CDP_PLATFORM
1412
1413 An ascii string containing the name of the platform.
1414
1415 CONFIG_CDP_TRIGGER
1416
1417 A 32bit integer sent on the trigger.
1418
1419 CONFIG_CDP_POWER_CONSUMPTION
1420
1421 A 16bit integer containing the power consumption of the
1422 device in .1 of milliwatts.
1423
1424 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1425
1426 A byte containing the id of the VLAN.
1427
wdenkc6097192002-11-03 00:24:07 +00001428- Status LED: CONFIG_STATUS_LED
1429
1430 Several configurations allow to display the current
1431 status using a LED. For instance, the LED will blink
1432 fast while running U-Boot code, stop blinking as
1433 soon as a reply to a BOOTP request was received, and
1434 start blinking slow once the Linux kernel is running
1435 (supported by a status LED driver in the Linux
1436 kernel). Defining CONFIG_STATUS_LED enables this
1437 feature in U-Boot.
1438
1439- CAN Support: CONFIG_CAN_DRIVER
1440
1441 Defining CONFIG_CAN_DRIVER enables CAN driver support
1442 on those systems that support this (optional)
1443 feature, like the TQM8xxL modules.
1444
1445- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1446
wdenkb37c7e52003-06-30 16:24:52 +00001447 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001448 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001449 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001450
wdenk945af8d2003-07-16 21:53:01 +00001451 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001452 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001453 CONFIG_COMMANDS) and communicate with i2c based realtime
1454 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001455 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001456
Ben Warrenbb99ad62006-09-07 16:50:54 -04001457 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001458
wdenk945af8d2003-07-16 21:53:01 +00001459 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001460 bit-banging) driver instead of CPM or similar hardware
1461 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001462
wdenk945af8d2003-07-16 21:53:01 +00001463 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001464 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001466 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001467 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001468 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001469 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001470
Peter Tyser8d321b82010-04-12 22:28:21 -05001471 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001472 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001473 and so its address should therefore be cleared to 0 (See,
1474 eg, MPC823e User's Manual p.16-473). So, set
1475 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001476
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001477 CONFIG_SYS_I2C_INIT_MPC5XXX
1478
1479 When a board is reset during an i2c bus transfer
1480 chips might think that the current transfer is still
1481 in progress. Reset the slave devices by sending start
1482 commands until the slave device responds.
1483
wdenk945af8d2003-07-16 21:53:01 +00001484 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001485
1486 If you use the software i2c interface (CONFIG_SOFT_I2C)
1487 then the following macros need to be defined (examples are
1488 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001489
1490 I2C_INIT
1491
wdenkb37c7e52003-06-30 16:24:52 +00001492 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001493 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001494
wdenkba56f622004-02-06 23:19:44 +00001495 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001496
wdenkc6097192002-11-03 00:24:07 +00001497 I2C_PORT
1498
wdenk43d96162003-03-06 00:02:04 +00001499 (Only for MPC8260 CPU). The I/O port to use (the code
1500 assumes both bits are on the same port). Valid values
1501 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001502
1503 I2C_ACTIVE
1504
1505 The code necessary to make the I2C data line active
1506 (driven). If the data line is open collector, this
1507 define can be null.
1508
wdenkb37c7e52003-06-30 16:24:52 +00001509 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1510
wdenkc6097192002-11-03 00:24:07 +00001511 I2C_TRISTATE
1512
1513 The code necessary to make the I2C data line tri-stated
1514 (inactive). If the data line is open collector, this
1515 define can be null.
1516
wdenkb37c7e52003-06-30 16:24:52 +00001517 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1518
wdenkc6097192002-11-03 00:24:07 +00001519 I2C_READ
1520
1521 Code that returns TRUE if the I2C data line is high,
1522 FALSE if it is low.
1523
wdenkb37c7e52003-06-30 16:24:52 +00001524 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1525
wdenkc6097192002-11-03 00:24:07 +00001526 I2C_SDA(bit)
1527
1528 If <bit> is TRUE, sets the I2C data line high. If it
1529 is FALSE, it clears it (low).
1530
wdenkb37c7e52003-06-30 16:24:52 +00001531 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001532 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001533 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001534
wdenkc6097192002-11-03 00:24:07 +00001535 I2C_SCL(bit)
1536
1537 If <bit> is TRUE, sets the I2C clock line high. If it
1538 is FALSE, it clears it (low).
1539
wdenkb37c7e52003-06-30 16:24:52 +00001540 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001541 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001542 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001543
wdenkc6097192002-11-03 00:24:07 +00001544 I2C_DELAY
1545
1546 This delay is invoked four times per clock cycle so this
1547 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001548 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001549 like:
1550
wdenkb37c7e52003-06-30 16:24:52 +00001551 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001552
Mike Frysinger793b5722010-07-21 13:38:02 -04001553 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1554
1555 If your arch supports the generic GPIO framework (asm/gpio.h),
1556 then you may alternatively define the two GPIOs that are to be
1557 used as SCL / SDA. Any of the previous I2C_xxx macros will
1558 have GPIO-based defaults assigned to them as appropriate.
1559
1560 You should define these to the GPIO value as given directly to
1561 the generic GPIO functions.
1562
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001563 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001564
wdenk8bde7f72003-06-27 21:31:46 +00001565 When a board is reset during an i2c bus transfer
1566 chips might think that the current transfer is still
1567 in progress. On some boards it is possible to access
1568 the i2c SCLK line directly, either by using the
1569 processor pin as a GPIO or by having a second pin
1570 connected to the bus. If this option is defined a
1571 custom i2c_init_board() routine in boards/xxx/board.c
1572 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001573
Richard Retanubun26a33502010-04-12 15:08:17 -04001574 CONFIG_SYS_I2C_BOARD_LATE_INIT
1575
1576 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1577 defined a custom i2c_board_late_init() routine in
1578 boards/xxx/board.c is run AFTER the operations in i2c_init()
1579 is completed. This callpoint can be used to unreset i2c bus
1580 using CPU i2c controller register accesses for CPUs whose i2c
1581 controller provide such a method. It is called at the end of
1582 i2c_init() to allow i2c_init operations to setup the i2c bus
1583 controller on the CPU (e.g. setting bus speed & slave address).
1584
wdenk17ea1172004-06-06 21:51:03 +00001585 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1586
1587 This option enables configuration of bi_iic_fast[] flags
1588 in u-boot bd_info structure based on u-boot environment
1589 variable "i2cfast". (see also i2cfast)
1590
Ben Warrenbb99ad62006-09-07 16:50:54 -04001591 CONFIG_I2C_MULTI_BUS
1592
1593 This option allows the use of multiple I2C buses, each of which
1594 must have a controller. At any point in time, only one bus is
1595 active. To switch to a different bus, use the 'i2c dev' command.
1596 Note that bus numbering is zero-based.
1597
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001598 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001599
1600 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001601 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1602 is set, specify a list of bus-device pairs. Otherwise, specify
1603 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001604
1605 e.g.
1606 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001607 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001608
1609 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1610
1611 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001612 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001613
1614 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001616 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001617
1618 If defined, then this indicates the I2C bus number for DDR SPD.
1619 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001621 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001622
1623 If defined, then this indicates the I2C bus number for the RTC.
1624 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1625
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001626 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001627
1628 If defined, then this indicates the I2C bus number for the DTT.
1629 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1630
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001631 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001632
1633 If defined, specifies the I2C address of the DTT device.
1634 If not defined, then U-Boot uses predefined value for
1635 specified DTT device.
1636
Timur Tabibe5e6182006-11-03 19:15:00 -06001637 CONFIG_FSL_I2C
1638
1639 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001640 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001641
Heiko Schocher67b23a32008-10-15 09:39:47 +02001642 CONFIG_I2C_MUX
1643
1644 Define this option if you have I2C devices reached over 1 .. n
1645 I2C Muxes like the pca9544a. This option addes a new I2C
1646 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1647 new I2C Bus to the existing I2C Busses. If you select the
1648 new Bus with "i2c dev", u-bbot sends first the commandos for
1649 the muxes to activate this new "bus".
1650
1651 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1652 feature!
1653
1654 Example:
1655 Adding a new I2C Bus reached over 2 pca9544a muxes
1656 The First mux with address 70 and channel 6
1657 The Second mux with address 71 and channel 4
1658
1659 => i2c bus pca9544a:70:6:pca9544a:71:4
1660
1661 Use the "i2c bus" command without parameter, to get a list
1662 of I2C Busses with muxes:
1663
1664 => i2c bus
1665 Busses reached over muxes:
1666 Bus ID: 2
1667 reached over Mux(es):
1668 pca9544a@70 ch: 4
1669 Bus ID: 3
1670 reached over Mux(es):
1671 pca9544a@70 ch: 6
1672 pca9544a@71 ch: 4
1673 =>
1674
1675 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1676 u-boot sends First the Commando to the mux@70 to enable
1677 channel 6, and then the Commando to the mux@71 to enable
1678 the channel 4.
1679
1680 After that, you can use the "normal" i2c commands as
1681 usual, to communicate with your I2C devices behind
1682 the 2 muxes.
1683
1684 This option is actually implemented for the bitbanging
1685 algorithm in common/soft_i2c.c and for the Hardware I2C
1686 Bus on the MPC8260. But it should be not so difficult
1687 to add this option to other architectures.
1688
Andrew Dyer2ac69852008-12-29 17:36:01 -06001689 CONFIG_SOFT_I2C_READ_REPEATED_START
1690
1691 defining this will force the i2c_read() function in
1692 the soft_i2c driver to perform an I2C repeated start
1693 between writing the address pointer and reading the
1694 data. If this define is omitted the default behaviour
1695 of doing a stop-start sequence will be used. Most I2C
1696 devices can use either method, but some require one or
1697 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001698
wdenkc6097192002-11-03 00:24:07 +00001699- SPI Support: CONFIG_SPI
1700
1701 Enables SPI driver (so far only tested with
1702 SPI EEPROM, also an instance works with Crystal A/D and
1703 D/As on the SACSng board)
1704
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001705 CONFIG_SH_SPI
1706
1707 Enables the driver for SPI controller on SuperH. Currently
1708 only SH7757 is supported.
1709
wdenkc6097192002-11-03 00:24:07 +00001710 CONFIG_SPI_X
1711
1712 Enables extended (16-bit) SPI EEPROM addressing.
1713 (symmetrical to CONFIG_I2C_X)
1714
1715 CONFIG_SOFT_SPI
1716
wdenk43d96162003-03-06 00:02:04 +00001717 Enables a software (bit-bang) SPI driver rather than
1718 using hardware support. This is a general purpose
1719 driver that only requires three general I/O port pins
1720 (two outputs, one input) to function. If this is
1721 defined, the board configuration must define several
1722 SPI configuration items (port pins to use, etc). For
1723 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001724
Ben Warren04a9e112008-01-16 22:37:35 -05001725 CONFIG_HARD_SPI
1726
1727 Enables a hardware SPI driver for general-purpose reads
1728 and writes. As with CONFIG_SOFT_SPI, the board configuration
1729 must define a list of chip-select function pointers.
1730 Currently supported on some MPC8xxx processors. For an
1731 example, see include/configs/mpc8349emds.h.
1732
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001733 CONFIG_MXC_SPI
1734
1735 Enables the driver for the SPI controllers on i.MX and MXC
1736 SoCs. Currently only i.MX31 is supported.
1737
Matthias Fuchs01335022007-12-27 17:12:34 +01001738- FPGA Support: CONFIG_FPGA
1739
1740 Enables FPGA subsystem.
1741
1742 CONFIG_FPGA_<vendor>
1743
1744 Enables support for specific chip vendors.
1745 (ALTERA, XILINX)
1746
1747 CONFIG_FPGA_<family>
1748
1749 Enables support for FPGA family.
1750 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1751
1752 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001753
wdenk43d96162003-03-06 00:02:04 +00001754 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001755
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001756 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001757
wdenk8bde7f72003-06-27 21:31:46 +00001758 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001759
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001760 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001761
wdenk43d96162003-03-06 00:02:04 +00001762 Enable checks on FPGA configuration interface busy
1763 status by the configuration function. This option
1764 will require a board or device specific function to
1765 be written.
wdenkc6097192002-11-03 00:24:07 +00001766
1767 CONFIG_FPGA_DELAY
1768
1769 If defined, a function that provides delays in the FPGA
1770 configuration driver.
1771
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001772 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001773 Allow Control-C to interrupt FPGA configuration
1774
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001775 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001776
wdenk43d96162003-03-06 00:02:04 +00001777 Check for configuration errors during FPGA bitfile
1778 loading. For example, abort during Virtex II
1779 configuration if the INIT_B line goes low (which
1780 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001782 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001783
wdenk43d96162003-03-06 00:02:04 +00001784 Maximum time to wait for the INIT_B line to deassert
1785 after PROB_B has been deasserted during a Virtex II
1786 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001787 ms.
wdenkc6097192002-11-03 00:24:07 +00001788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001789 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001790
wdenk43d96162003-03-06 00:02:04 +00001791 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001792 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001793
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001794 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001795
wdenk43d96162003-03-06 00:02:04 +00001796 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001797 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001798
1799- Configuration Management:
1800 CONFIG_IDENT_STRING
1801
wdenk43d96162003-03-06 00:02:04 +00001802 If defined, this string will be added to the U-Boot
1803 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001804
1805- Vendor Parameter Protection:
1806
wdenk43d96162003-03-06 00:02:04 +00001807 U-Boot considers the values of the environment
1808 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001809 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001810 are set once by the board vendor / manufacturer, and
1811 protects these variables from casual modification by
1812 the user. Once set, these variables are read-only,
1813 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001814 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001815
1816 If CONFIG_ENV_OVERWRITE is #defined in your config
1817 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001818 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001819 these parameters.
1820
1821 Alternatively, if you #define _both_ CONFIG_ETHADDR
1822 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001823 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001824 which can be changed exactly ONCE by the user. [The
1825 serial# is unaffected by this, i. e. it remains
1826 read-only.]
1827
1828- Protected RAM:
1829 CONFIG_PRAM
1830
1831 Define this variable to enable the reservation of
1832 "protected RAM", i. e. RAM which is not overwritten
1833 by U-Boot. Define CONFIG_PRAM to hold the number of
1834 kB you want to reserve for pRAM. You can overwrite
1835 this default value by defining an environment
1836 variable "pram" to the number of kB you want to
1837 reserve. Note that the board info structure will
1838 still show the full amount of RAM. If pRAM is
1839 reserved, a new environment variable "mem" will
1840 automatically be defined to hold the amount of
1841 remaining RAM in a form that can be passed as boot
1842 argument to Linux, for instance like that:
1843
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001844 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001845 saveenv
1846
1847 This way you can tell Linux not to use this memory,
1848 either, which results in a memory region that will
1849 not be affected by reboots.
1850
1851 *WARNING* If your board configuration uses automatic
1852 detection of the RAM size, you must make sure that
1853 this memory test is non-destructive. So far, the
1854 following board configurations are known to be
1855 "pRAM-clean":
1856
1857 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1858 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001859 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001860
1861- Error Recovery:
1862 CONFIG_PANIC_HANG
1863
1864 Define this variable to stop the system in case of a
1865 fatal error, so that you have to reset it manually.
1866 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001867 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001868 automatically as fast as possible, but it may be
1869 useful during development since you can try to debug
1870 the conditions that lead to the situation.
1871
1872 CONFIG_NET_RETRY_COUNT
1873
wdenk43d96162003-03-06 00:02:04 +00001874 This variable defines the number of retries for
1875 network operations like ARP, RARP, TFTP, or BOOTP
1876 before giving up the operation. If not defined, a
1877 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001878
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001879 CONFIG_ARP_TIMEOUT
1880
1881 Timeout waiting for an ARP reply in milliseconds.
1882
wdenkc6097192002-11-03 00:24:07 +00001883- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001884 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001885
1886 Enable auto completion of commands using TAB.
1887
Wolfgang Denka9398e02006-11-27 15:32:42 +01001888 Note that this feature has NOT been implemented yet
1889 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001890
1891
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001892 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001893
1894 Define this variable to enable the "hush" shell (from
1895 Busybox) as command line interpreter, thus enabling
1896 powerful command line syntax like
1897 if...then...else...fi conditionals or `&&' and '||'
1898 constructs ("shell scripts").
1899
1900 If undefined, you get the old, much simpler behaviour
1901 with a somewhat smaller memory footprint.
1902
1903
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001904 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001905
1906 This defines the secondary prompt string, which is
1907 printed when the command interpreter needs more input
1908 to complete a command. Usually "> ".
1909
1910 Note:
1911
wdenk8bde7f72003-06-27 21:31:46 +00001912 In the current implementation, the local variables
1913 space and global environment variables space are
1914 separated. Local variables are those you define by
1915 simply typing `name=value'. To access a local
1916 variable later on, you have write `$name' or
1917 `${name}'; to execute the contents of a variable
1918 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001919
wdenk43d96162003-03-06 00:02:04 +00001920 Global environment variables are those you use
1921 setenv/printenv to work with. To run a command stored
1922 in such a variable, you need to use the run command,
1923 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001924
1925 To store commands and special characters in a
1926 variable, please use double quotation marks
1927 surrounding the whole text of the variable, instead
1928 of the backslashes before semicolons and special
1929 symbols.
1930
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001931- Commandline Editing and History:
1932 CONFIG_CMDLINE_EDITING
1933
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001934 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001935 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001936
wdenka8c7c702003-12-06 19:49:23 +00001937- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001938 CONFIG_EXTRA_ENV_SETTINGS
1939
wdenk43d96162003-03-06 00:02:04 +00001940 Define this to contain any number of null terminated
1941 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001942 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001943
wdenk43d96162003-03-06 00:02:04 +00001944 For example, place something like this in your
1945 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001946
1947 #define CONFIG_EXTRA_ENV_SETTINGS \
1948 "myvar1=value1\0" \
1949 "myvar2=value2\0"
1950
wdenk43d96162003-03-06 00:02:04 +00001951 Warning: This method is based on knowledge about the
1952 internal format how the environment is stored by the
1953 U-Boot code. This is NOT an official, exported
1954 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001955 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001956 You better know what you are doing here.
1957
wdenk43d96162003-03-06 00:02:04 +00001958 Note: overly (ab)use of the default environment is
1959 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001960 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001961 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001962
wdenka8c7c702003-12-06 19:49:23 +00001963- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001964 CONFIG_HAS_DATAFLASH
1965
wdenk8bde7f72003-06-27 21:31:46 +00001966 Defining this option enables DataFlash features and
1967 allows to read/write in Dataflash via the standard
1968 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001969
wdenk3f85ce22004-02-23 16:11:30 +00001970- SystemACE Support:
1971 CONFIG_SYSTEMACE
1972
1973 Adding this option adds support for Xilinx SystemACE
1974 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001975 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001976 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001977
1978 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001979 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001980
1981 When SystemACE support is added, the "ace" device type
1982 becomes available to the fat commands, i.e. fatls.
1983
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001984- TFTP Fixed UDP Port:
1985 CONFIG_TFTP_PORT
1986
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001987 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001988 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001989 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001990 number generator is used.
1991
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001992 Also, the environment variable tftpdstp is used to supply
1993 the TFTP UDP destination port value. If tftpdstp isn't
1994 defined, the normal port 69 is used.
1995
1996 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001997 blindly start the TFTP transfer using the pre-configured
1998 target IP address and UDP port. This has the effect of
1999 "punching through" the (Windows XP) firewall, allowing
2000 the remainder of the TFTP transfer to proceed normally.
2001 A better solution is to properly configure the firewall,
2002 but sometimes that is not allowed.
2003
wdenka8c7c702003-12-06 19:49:23 +00002004- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002005 CONFIG_SHOW_BOOT_PROGRESS
2006
wdenk43d96162003-03-06 00:02:04 +00002007 Defining this option allows to add some board-
2008 specific code (calling a user-provided function
2009 "show_boot_progress(int)") that enables you to show
2010 the system's boot progress on some display (for
2011 example, some LED's) on your board. At the moment,
2012 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002013
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002014- Standalone program support:
2015 CONFIG_STANDALONE_LOAD_ADDR
2016
2017 This option allows to define board specific values
2018 for the address where standalone program gets loaded,
2019 thus overwriting the architecutre dependent default
2020 settings.
2021
Minkyu Kangd32a1a42011-04-24 22:22:34 +00002022- Frame Buffer Address:
2023 CONFIG_FB_ADDR
2024
2025 Define CONFIG_FB_ADDR if you want to use specific address for
2026 frame buffer.
2027 Then system will reserve the frame buffer address to defined address
2028 instead of lcd_setmem (this function grab the memory for frame buffer
2029 by panel's size).
2030
2031 Please see board_init_f function.
2032
2033 If you want this config option then,
2034 please define it at your board config file
2035
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002036Legacy uImage format:
2037
wdenkc6097192002-11-03 00:24:07 +00002038 Arg Where When
2039 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002040 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002041 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002042 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002043 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002044 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002045 4 common/cmd_bootm.c Image data has correct checksum
2046 -4 common/cmd_bootm.c Image is for unsupported architecture
2047 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002048 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002049 6 common/cmd_bootm.c Image Type check OK
2050 -6 common/cmd_bootm.c gunzip uncompression error
2051 -7 common/cmd_bootm.c Unimplemented compression type
2052 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002053 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002054 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002055
2056 9 common/image.c Start initial ramdisk verification
2057 -10 common/image.c Ramdisk header has bad magic number
2058 -11 common/image.c Ramdisk header has bad checksum
2059 10 common/image.c Ramdisk header is OK
2060 -12 common/image.c Ramdisk data has bad checksum
2061 11 common/image.c Ramdisk data has correct checksum
2062 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002063 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002064 13 common/image.c Start multifile image verification
2065 14 common/image.c No initial ramdisk, no multifile, continue.
2066
Peter Tyserea0364f2010-04-12 22:28:04 -05002067 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002068
Stefan Roesea47a12b2010-04-15 16:07:28 +02002069 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002070 -31 post/post.c POST test failed, detected by post_output_backlog()
2071 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002072
Heiko Schocher566a4942007-06-22 19:11:54 +02002073 34 common/cmd_doc.c before loading a Image from a DOC device
2074 -35 common/cmd_doc.c Bad usage of "doc" command
2075 35 common/cmd_doc.c correct usage of "doc" command
2076 -36 common/cmd_doc.c No boot device
2077 36 common/cmd_doc.c correct boot device
2078 -37 common/cmd_doc.c Unknown Chip ID on boot device
2079 37 common/cmd_doc.c correct chip ID found, device available
2080 -38 common/cmd_doc.c Read Error on boot device
2081 38 common/cmd_doc.c reading Image header from DOC device OK
2082 -39 common/cmd_doc.c Image header has bad magic number
2083 39 common/cmd_doc.c Image header has correct magic number
2084 -40 common/cmd_doc.c Error reading Image from DOC device
2085 40 common/cmd_doc.c Image header has correct magic number
2086 41 common/cmd_ide.c before loading a Image from a IDE device
2087 -42 common/cmd_ide.c Bad usage of "ide" command
2088 42 common/cmd_ide.c correct usage of "ide" command
2089 -43 common/cmd_ide.c No boot device
2090 43 common/cmd_ide.c boot device found
2091 -44 common/cmd_ide.c Device not available
2092 44 common/cmd_ide.c Device available
2093 -45 common/cmd_ide.c wrong partition selected
2094 45 common/cmd_ide.c partition selected
2095 -46 common/cmd_ide.c Unknown partition table
2096 46 common/cmd_ide.c valid partition table found
2097 -47 common/cmd_ide.c Invalid partition type
2098 47 common/cmd_ide.c correct partition type
2099 -48 common/cmd_ide.c Error reading Image Header on boot device
2100 48 common/cmd_ide.c reading Image Header from IDE device OK
2101 -49 common/cmd_ide.c Image header has bad magic number
2102 49 common/cmd_ide.c Image header has correct magic number
2103 -50 common/cmd_ide.c Image header has bad checksum
2104 50 common/cmd_ide.c Image header has correct checksum
2105 -51 common/cmd_ide.c Error reading Image from IDE device
2106 51 common/cmd_ide.c reading Image from IDE device OK
2107 52 common/cmd_nand.c before loading a Image from a NAND device
2108 -53 common/cmd_nand.c Bad usage of "nand" command
2109 53 common/cmd_nand.c correct usage of "nand" command
2110 -54 common/cmd_nand.c No boot device
2111 54 common/cmd_nand.c boot device found
2112 -55 common/cmd_nand.c Unknown Chip ID on boot device
2113 55 common/cmd_nand.c correct chip ID found, device available
2114 -56 common/cmd_nand.c Error reading Image Header on boot device
2115 56 common/cmd_nand.c reading Image Header from NAND device OK
2116 -57 common/cmd_nand.c Image header has bad magic number
2117 57 common/cmd_nand.c Image header has correct magic number
2118 -58 common/cmd_nand.c Error reading Image from NAND device
2119 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002120
Heiko Schocher566a4942007-06-22 19:11:54 +02002121 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002122
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002123 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002124 -64 net/eth.c no Ethernet found.
2125 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002126
Heiko Schocher566a4942007-06-22 19:11:54 +02002127 -80 common/cmd_net.c usage wrong
2128 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002129 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002130 81 common/cmd_net.c NetLoop() back without error
2131 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2132 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002133 83 common/cmd_net.c running "source" command
2134 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002135 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002136
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002137FIT uImage format:
2138
2139 Arg Where When
2140 100 common/cmd_bootm.c Kernel FIT Image has correct format
2141 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2142 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2143 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2144 102 common/cmd_bootm.c Kernel unit name specified
2145 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002146 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002147 104 common/cmd_bootm.c Got kernel subimage node offset
2148 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2149 105 common/cmd_bootm.c Kernel subimage hash verification OK
2150 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2151 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002152 -106 common/cmd_bootm.c Kernel subimage has wrong type
2153 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002154 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2155 108 common/cmd_bootm.c Got kernel subimage data/size
2156 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2157 -109 common/cmd_bootm.c Can't get kernel subimage type
2158 -110 common/cmd_bootm.c Can't get kernel subimage comp
2159 -111 common/cmd_bootm.c Can't get kernel subimage os
2160 -112 common/cmd_bootm.c Can't get kernel subimage load address
2161 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2162
2163 120 common/image.c Start initial ramdisk verification
2164 -120 common/image.c Ramdisk FIT image has incorrect format
2165 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002166 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002167 -122 common/image.c Can't get configuration for ramdisk subimage
2168 123 common/image.c Ramdisk unit name specified
2169 -124 common/image.c Can't get ramdisk subimage node offset
2170 125 common/image.c Got ramdisk subimage node offset
2171 -125 common/image.c Ramdisk subimage hash verification failed
2172 126 common/image.c Ramdisk subimage hash verification OK
2173 -126 common/image.c Ramdisk subimage for unsupported architecture
2174 127 common/image.c Architecture check OK
2175 -127 common/image.c Can't get ramdisk subimage data/size
2176 128 common/image.c Got ramdisk subimage data/size
2177 129 common/image.c Can't get ramdisk load address
2178 -129 common/image.c Got ramdisk load address
2179
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002180 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002181 131 common/cmd_doc.c FIT image format OK
2182
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002183 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002184 141 common/cmd_ide.c FIT image format OK
2185
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002186 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002187 151 common/cmd_nand.c FIT image format OK
2188
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002189- Automatic software updates via TFTP server
2190 CONFIG_UPDATE_TFTP
2191 CONFIG_UPDATE_TFTP_CNT_MAX
2192 CONFIG_UPDATE_TFTP_MSEC_MAX
2193
2194 These options enable and control the auto-update feature;
2195 for a more detailed description refer to doc/README.update.
2196
2197- MTD Support (mtdparts command, UBI support)
2198 CONFIG_MTD_DEVICE
2199
2200 Adds the MTD device infrastructure from the Linux kernel.
2201 Needed for mtdparts command support.
2202
2203 CONFIG_MTD_PARTITIONS
2204
2205 Adds the MTD partitioning infrastructure from the Linux
2206 kernel. Needed for UBI support.
2207
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002208
wdenkc6097192002-11-03 00:24:07 +00002209Modem Support:
2210--------------
2211
wdenk85ec0bc2003-03-31 16:34:49 +00002212[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002213
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002214- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002215 CONFIG_MODEM_SUPPORT
2216
2217- RTS/CTS Flow control enable:
2218 CONFIG_HWFLOW
2219
2220- Modem debug support:
2221 CONFIG_MODEM_SUPPORT_DEBUG
2222
wdenk43d96162003-03-06 00:02:04 +00002223 Enables debugging stuff (char screen[1024], dbg())
2224 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002225
wdenka8c7c702003-12-06 19:49:23 +00002226- Interrupt support (PPC):
2227
wdenkd4ca31c2004-01-02 14:00:00 +00002228 There are common interrupt_init() and timer_interrupt()
2229 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002230 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002231 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002232 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002233 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002234 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002235 specific handling. If board has watchdog / status_led
2236 / other_activity_monitor it works automatically from
2237 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002238
wdenkc6097192002-11-03 00:24:07 +00002239- General:
2240
wdenk43d96162003-03-06 00:02:04 +00002241 In the target system modem support is enabled when a
2242 specific key (key combination) is pressed during
2243 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002244 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002245 board_init(). Currently key_pressed() is a dummy
2246 function, returning 1 and thus enabling modem
2247 initialization.
wdenkc6097192002-11-03 00:24:07 +00002248
wdenk43d96162003-03-06 00:02:04 +00002249 If there are no modem init strings in the
2250 environment, U-Boot proceed to autoboot; the
2251 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002252 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002253
2254 See also: doc/README.Modem
2255
2256
wdenkc6097192002-11-03 00:24:07 +00002257Configuration Settings:
2258-----------------------
2259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002260- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002261 undefine this when you're short of memory.
2262
Peter Tyser2fb26042009-01-27 18:03:12 -06002263- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2264 width of the commands listed in the 'help' command output.
2265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002266- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002267 prompt for user input.
2268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002269- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002271- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002272
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002273- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002275- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002276 the application (usually a Linux kernel) when it is
2277 booted
2278
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002279- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002280 List of legal baudrate settings for this board.
2281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002282- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002283 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002284
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002285- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002286 If the board specific function
2287 extern int overwrite_console (void);
2288 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002289 serial port, else the settings in the environment are used.
2290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002291- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002292 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002294- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002295 Enable overwrite of previous console environment settings.
2296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002297- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002298 Begin and End addresses of the area used by the
2299 simple memory test.
2300
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002301- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002302 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002304- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002305 Scratch address used by the alternate memory test
2306 You only need to set this if address zero isn't writeable
2307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002308- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2309 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002310 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002311 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002312 fixing up gd->ram_size the Linux kernel should gets passed
2313 the now "corrected" memory size and won't touch it either.
2314 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002315 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002316 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002317 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002318
2319 This option can be used as a workaround for the 440EPx/GRx
2320 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2321 be touched.
2322
2323 WARNING: Please make sure that this value is a multiple of
2324 the Linux page size (normally 4k). If this is not the case,
2325 then the end address of the Linux memory will be located at a
2326 non page size aligned address and this could cause major
2327 problems.
2328
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002329- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002330 Default load address for network file downloads
2331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002332- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002333 Enable temporary baudrate change while serial download
2334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002335- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002336 Physical start address of SDRAM. _Must_ be 0 here.
2337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002338- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002339 Physical start address of Motherboard I/O (if using a
2340 Cogent motherboard)
2341
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002342- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002343 Physical start address of Flash memory.
2344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002345- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002346 Physical start address of boot monitor code (set by
2347 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002348 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002349 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002351- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002352 Size of memory reserved for monitor code, used to
2353 determine _at_compile_time_ (!) if the environment is
2354 embedded within the U-Boot image, or in a separate
2355 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002356
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002357- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002358 Size of DRAM reserved for malloc() use.
2359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002360- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002361 Normally compressed uImages are limited to an
2362 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002363 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002364 to adjust this setting to your needs.
2365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002366- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002367 Maximum size of memory mapped by the startup code of
2368 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002369 the Linux kernel (bd_info, boot arguments, FDT blob if
2370 used) must be put below this limit, unless "bootm_low"
2371 enviroment variable is defined and non-zero. In such case
2372 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002373 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2374 variable "bootm_mapsize" will override the value of
2375 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2376 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002377
John Rigbyfca43cc2010-10-13 13:57:35 -06002378- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2379 Enable initrd_high functionality. If defined then the
2380 initrd_high feature is enabled and the bootm ramdisk subcommand
2381 is enabled.
2382
2383- CONFIG_SYS_BOOT_GET_CMDLINE:
2384 Enables allocating and saving kernel cmdline in space between
2385 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2386
2387- CONFIG_SYS_BOOT_GET_KBD:
2388 Enables allocating and saving a kernel copy of the bd_info in
2389 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2390
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002391- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002392 Max number of Flash memory banks
2393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002394- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002395 Max number of sectors on a Flash chip
2396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002397- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002398 Timeout for Flash erase operations (in ms)
2399
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002400- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002401 Timeout for Flash write operations (in ms)
2402
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002403- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002404 Timeout for Flash set sector lock bit operation (in ms)
2405
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002406- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002407 Timeout for Flash clear lock bits operation (in ms)
2408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002410 If defined, hardware flash sectors protection is used
2411 instead of U-Boot software protection.
2412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002413- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002414
2415 Enable TFTP transfers directly to flash memory;
2416 without this option such a download has to be
2417 performed in two steps: (1) download to RAM, and (2)
2418 copy from RAM to flash.
2419
2420 The two-step approach is usually more reliable, since
2421 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002422 the flash, but in some situations (when system RAM is
2423 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002424 downloaded image) this option may be very useful.
2425
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002426- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002427 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002428 common flash structure for storing flash geometry.
2429
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002430- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002431 This option also enables the building of the cfi_flash driver
2432 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002433
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002434- CONFIG_FLASH_CFI_MTD
2435 This option enables the building of the cfi_mtd driver
2436 in the drivers directory. The driver exports CFI flash
2437 to the MTD layer.
2438
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002439- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002440 Use buffered writes to flash.
2441
2442- CONFIG_FLASH_SPANSION_S29WS_N
2443 s29ws-n MirrorBit flash has non-standard addresses for buffered
2444 write commands.
2445
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002446- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002447 If this option is defined, the common CFI flash doesn't
2448 print it's warning upon not recognized FLASH banks. This
2449 is useful, if some of the configured banks are only
2450 optionally available.
2451
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002452- CONFIG_FLASH_SHOW_PROGRESS
2453 If defined (must be an integer), print out countdown
2454 digits and dots. Recommended value: 45 (9..1) for 80
2455 column displays, 15 (3..1) for 40 column displays.
2456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002457- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002458 Defines the number of Ethernet receive buffers. On some
2459 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002460 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2461 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002462 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002463 Defaults to 4 if not defined.
2464
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002465- CONFIG_ENV_MAX_ENTRIES
2466
Wolfgang Denk071bc922010-10-27 22:48:30 +02002467 Maximum number of entries in the hash table that is used
2468 internally to store the environment settings. The default
2469 setting is supposed to be generous and should work in most
2470 cases. This setting can be used to tune behaviour; see
2471 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002472
wdenkc6097192002-11-03 00:24:07 +00002473The following definitions that deal with the placement and management
2474of environment data (variable area); in general, we support the
2475following configurations:
2476
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002477- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002478
2479 Define this if the environment is in flash memory.
2480
2481 a) The environment occupies one whole flash sector, which is
2482 "embedded" in the text segment with the U-Boot code. This
2483 happens usually with "bottom boot sector" or "top boot
2484 sector" type flash chips, which have several smaller
2485 sectors at the start or the end. For instance, such a
2486 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2487 such a case you would place the environment in one of the
2488 4 kB sectors - with U-Boot code before and after it. With
2489 "top boot sector" type flash chips, you would put the
2490 environment in one of the last sectors, leaving a gap
2491 between U-Boot and the environment.
2492
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002493 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002494
2495 Offset of environment data (variable area) to the
2496 beginning of flash memory; for instance, with bottom boot
2497 type flash chips the second sector can be used: the offset
2498 for this sector is given here.
2499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002500 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002501
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002502 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002503
2504 This is just another way to specify the start address of
2505 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002506 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002507
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002508 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002509
2510 Size of the sector containing the environment.
2511
2512
2513 b) Sometimes flash chips have few, equal sized, BIG sectors.
2514 In such a case you don't want to spend a whole sector for
2515 the environment.
2516
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002517 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002518
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002519 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002520 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002521 of this flash sector for the environment. This saves
2522 memory for the RAM copy of the environment.
2523
2524 It may also save flash memory if you decide to use this
2525 when your environment is "embedded" within U-Boot code,
2526 since then the remainder of the flash sector could be used
2527 for U-Boot code. It should be pointed out that this is
2528 STRONGLY DISCOURAGED from a robustness point of view:
2529 updating the environment in flash makes it always
2530 necessary to erase the WHOLE sector. If something goes
2531 wrong before the contents has been restored from a copy in
2532 RAM, your target system will be dead.
2533
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002534 - CONFIG_ENV_ADDR_REDUND
2535 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002536
wdenk43d96162003-03-06 00:02:04 +00002537 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002538 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002539 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002540 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002541
2542BE CAREFUL! Any changes to the flash layout, and some changes to the
2543source code will make it necessary to adapt <board>/u-boot.lds*
2544accordingly!
2545
2546
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002547- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002548
2549 Define this if you have some non-volatile memory device
2550 (NVRAM, battery buffered SRAM) which you want to use for the
2551 environment.
2552
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002553 - CONFIG_ENV_ADDR:
2554 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002555
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002556 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002557 want to use for environment. It is assumed that this memory
2558 can just be read and written to, without any special
2559 provision.
2560
2561BE CAREFUL! The first access to the environment happens quite early
2562in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002563console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002564U-Boot will hang.
2565
2566Please note that even with NVRAM we still use a copy of the
2567environment in RAM: we could work on NVRAM directly, but we want to
2568keep settings there always unmodified except somebody uses "saveenv"
2569to save the current settings.
2570
2571
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002572- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002573
2574 Use this if you have an EEPROM or similar serial access
2575 device and a driver for it.
2576
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002577 - CONFIG_ENV_OFFSET:
2578 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002579
2580 These two #defines specify the offset and size of the
2581 environment area within the total memory of your EEPROM.
2582
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002583 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002584 If defined, specified the chip address of the EEPROM device.
2585 The default address is zero.
2586
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002587 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002588 If defined, the number of bits used to address bytes in a
2589 single page in the EEPROM device. A 64 byte page, for example
2590 would require six bits.
2591
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002592 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002593 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002594 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002596 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002597 The length in bytes of the EEPROM memory array address. Note
2598 that this is NOT the chip address length!
2599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002600 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002601 EEPROM chips that implement "address overflow" are ones
2602 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2603 address and the extra bits end up in the "chip address" bit
2604 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2605 byte chips.
2606
2607 Note that we consider the length of the address field to
2608 still be one byte because the extra address bits are hidden
2609 in the chip address.
2610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002611 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002612 The size in bytes of the EEPROM device.
2613
Heiko Schocher548738b2010-01-07 08:55:40 +01002614 - CONFIG_ENV_EEPROM_IS_ON_I2C
2615 define this, if you have I2C and SPI activated, and your
2616 EEPROM, which holds the environment, is on the I2C bus.
2617
2618 - CONFIG_I2C_ENV_EEPROM_BUS
2619 if you have an Environment on an EEPROM reached over
2620 I2C muxes, you can define here, how to reach this
2621 EEPROM. For example:
2622
Wolfgang Denka9046b92010-06-13 17:48:15 +02002623 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002624
2625 EEPROM which holds the environment, is reached over
2626 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002627
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002628- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002629
wdenkd4ca31c2004-01-02 14:00:00 +00002630 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002631 want to use for the environment.
2632
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002633 - CONFIG_ENV_OFFSET:
2634 - CONFIG_ENV_ADDR:
2635 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002636
2637 These three #defines specify the offset and size of the
2638 environment area within the total memory of your DataFlash placed
2639 at the specified address.
2640
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002641- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002642
2643 Define this if you have a NAND device which you want to use
2644 for the environment.
2645
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002646 - CONFIG_ENV_OFFSET:
2647 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002648
2649 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002650 area within the first NAND device. CONFIG_ENV_OFFSET must be
2651 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002652
Scott Woodfdd813d2010-09-17 14:38:37 -05002653 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002654
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002655 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002656 size used to hold a redundant copy of the environment data, so
2657 that there is a valid backup copy in case there is a power failure
2658 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2659 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002660
Scott Woodfdd813d2010-09-17 14:38:37 -05002661 - CONFIG_ENV_RANGE (optional):
2662
2663 Specifies the length of the region in which the environment
2664 can be written. This should be a multiple of the NAND device's
2665 block size. Specifying a range with more erase blocks than
2666 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2667 the range to be avoided.
2668
2669 - CONFIG_ENV_OFFSET_OOB (optional):
2670
2671 Enables support for dynamically retrieving the offset of the
2672 environment from block zero's out-of-band data. The
2673 "nand env.oob" command can be used to record this offset.
2674 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2675 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002676
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002677- CONFIG_NAND_ENV_DST
2678
2679 Defines address in RAM to which the nand_spl code should copy the
2680 environment. If redundant environment is used, it will be copied to
2681 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002683- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002684
2685 Defines offset to the initial SPI buffer area in DPRAM. The
2686 area is used at an early stage (ROM part) if the environment
2687 is configured to reside in the SPI EEPROM: We need a 520 byte
2688 scratch DPRAM area. It is used between the two initialization
2689 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2690 to be a good choice since it makes it far enough from the
2691 start of the data area as well as from the stack pointer.
2692
Bruce Adlere881cb52007-11-02 13:15:42 -07002693Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002694has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002695created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002696until then to read environment variables.
2697
wdenk85ec0bc2003-03-31 16:34:49 +00002698The environment is protected by a CRC32 checksum. Before the monitor
2699is relocated into RAM, as a result of a bad CRC you will be working
2700with the compiled-in default environment - *silently*!!! [This is
2701necessary, because the first environment variable we need is the
2702"baudrate" setting for the console - if we have a bad CRC, we don't
2703have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002704
2705Note: once the monitor has been relocated, then it will complain if
2706the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002707use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002709- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002710 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002711
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002712 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002713 also needs to be defined.
2714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002715- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002716 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002717
Ron Madridf5675aa2009-02-18 14:30:44 -08002718- CONFIG_NS16550_MIN_FUNCTIONS:
2719 Define this if you desire to only have use of the NS16550_init
2720 and NS16550_putc functions for the serial driver located at
2721 drivers/serial/ns16550.c. This option is useful for saving
2722 space for already greatly restricted images, including but not
2723 limited to NAND_SPL configurations.
2724
wdenkc6097192002-11-03 00:24:07 +00002725Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002726---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002728- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002729 Cache Line Size of the CPU.
2730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002731- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002732 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002733
wdenk42d1f032003-10-15 23:53:47 +00002734 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2735 and RPXsuper) to be able to adjust the position of
2736 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002737
wdenk7f6c2cb2002-11-10 22:06:23 +00002738- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002739 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002740
2741 the default drive number (default value 0)
2742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002743 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002744
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002745 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002746 (default value 1)
2747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002748 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002749
wdenk43d96162003-03-06 00:02:04 +00002750 defines the offset of register from address. It
2751 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002752 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002753
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002754 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2755 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002756 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002758 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002759 fdc_hw_init() is called at the beginning of the FDC
2760 setup. fdc_hw_init() must be provided by the board
2761 source code. It is used to make hardware dependant
2762 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002764- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002765 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002766 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002767
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002768- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002769
wdenk7152b1d2003-09-05 23:19:14 +00002770 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002771 initial data and stack; please note that this must be
2772 writable memory that is working WITHOUT special
2773 initialization, i. e. you CANNOT use normal RAM which
2774 will become available only after programming the
2775 memory controller and running certain initialization
2776 sequences.
2777
2778 U-Boot uses the following memory types:
2779 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2780 - MPC824X: data cache
2781 - PPC4xx: data cache
2782
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002783- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002784
2785 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002786 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2787 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002788 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002789 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002790 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2791 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2792 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002793
2794 Note:
2795 On the MPC824X (or other systems that use the data
2796 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002797 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002798 point to an otherwise UNUSED address space between
2799 the top of RAM and the start of the PCI space.
2800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002801- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002805- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002807- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002808
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002809- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002811- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002813- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002814 SDRAM timing
2815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002816- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002817 periodic timer for refresh
2818
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002819- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002820
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002821- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2822 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2823 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2824 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002825 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2826
2827- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002828 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2829 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002830 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002832- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2833 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002834 Machine Mode Register and Memory Periodic Timer
2835 Prescaler definitions (SDRAM timing)
2836
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002837- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002838 enable I2C microcode relocation patch (MPC8xx);
2839 define relocation offset in DPRAM [DSP2]
2840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002841- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002842 enable SMC microcode relocation patch (MPC8xx);
2843 define relocation offset in DPRAM [SMC1]
2844
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002845- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002846 enable SPI microcode relocation patch (MPC8xx);
2847 define relocation offset in DPRAM [SCC4]
2848
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002849- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002850 Use OSCM clock mode on MBX8xx board. Be careful,
2851 wrong setting might damage your board. Read
2852 doc/README.MBX before setting this variable!
2853
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002854- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002855 Offset of the bootmode word in DPRAM used by post
2856 (Power On Self Tests). This definition overrides
2857 #define'd default value in commproc.h resp.
2858 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002859
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002860- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2861 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2862 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2863 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2864 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2865 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2866 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2867 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002868 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002869
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002870- CONFIG_PCI_DISABLE_PCIE:
2871 Disable PCI-Express on systems where it is supported but not
2872 required.
2873
Kumar Galaa09b9b62010-12-30 12:09:53 -06002874- CONFIG_SYS_SRIO:
2875 Chip has SRIO or not
2876
2877- CONFIG_SRIO1:
2878 Board has SRIO 1 port available
2879
2880- CONFIG_SRIO2:
2881 Board has SRIO 2 port available
2882
2883- CONFIG_SYS_SRIOn_MEM_VIRT:
2884 Virtual Address of SRIO port 'n' memory region
2885
2886- CONFIG_SYS_SRIOn_MEM_PHYS:
2887 Physical Address of SRIO port 'n' memory region
2888
2889- CONFIG_SYS_SRIOn_MEM_SIZE:
2890 Size of SRIO port 'n' memory region
2891
Ben Warrenbb99ad62006-09-07 16:50:54 -04002892- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002893 Get DDR timing information from an I2C EEPROM. Common
2894 with pluggable memory modules such as SODIMMs
2895
Ben Warrenbb99ad62006-09-07 16:50:54 -04002896 SPD_EEPROM_ADDRESS
2897 I2C address of the SPD EEPROM
2898
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002899- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002900 If SPD EEPROM is on an I2C bus other than the first
2901 one, specify here. Note that the value must resolve
2902 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002903
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002904- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002905 Only for 83xx systems. If specified, then DDR should
2906 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002907
wdenkc26e4542004-04-18 10:13:26 +00002908- CONFIG_ETHER_ON_FEC[12]
2909 Define to enable FEC[12] on a 8xx series processor.
2910
2911- CONFIG_FEC[12]_PHY
2912 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002913 to the given FEC; i. e.
2914 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002915 means that the PHY with address 4 is connected to FEC1
2916
2917 When set to -1, means to probe for first available.
2918
2919- CONFIG_FEC[12]_PHY_NORXERR
2920 The PHY does not have a RXERR line (RMII only).
2921 (so program the FEC to ignore it).
2922
2923- CONFIG_RMII
2924 Enable RMII mode for all FECs.
2925 Note that this is a global option, we can't
2926 have one FEC in standard MII mode and another in RMII mode.
2927
wdenk5cf91d62004-04-23 20:32:05 +00002928- CONFIG_CRC32_VERIFY
2929 Add a verify option to the crc32 command.
2930 The syntax is:
2931
2932 => crc32 -v <address> <count> <crc32>
2933
2934 Where address/count indicate a memory area
2935 and crc32 is the correct crc32 which the
2936 area should have.
2937
wdenk56523f12004-07-11 17:40:54 +00002938- CONFIG_LOOPW
2939 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002940 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002941
stroese7b466642004-12-16 18:46:55 +00002942- CONFIG_MX_CYCLIC
2943 Add the "mdc" and "mwc" memory commands. These are cyclic
2944 "md/mw" commands.
2945 Examples:
2946
wdenkefe2a4d2004-12-16 21:44:03 +00002947 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002948 This command will print 4 bytes (10,11,12,13) each 500 ms.
2949
wdenkefe2a4d2004-12-16 21:44:03 +00002950 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002951 This command will write 12345678 to address 100 all 10 ms.
2952
wdenkefe2a4d2004-12-16 21:44:03 +00002953 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002954 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002955
wdenk8aa1a2d2005-04-04 12:44:11 +00002956- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002957 [ARM only] If this variable is defined, then certain
2958 low level initializations (like setting up the memory
2959 controller) are omitted and/or U-Boot does not
2960 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002961
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002962 Normally this variable MUST NOT be defined. The only
2963 exception is when U-Boot is loaded (to RAM) by some
2964 other boot loader or by a debugger which performs
2965 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002966
Magnus Liljadf812382009-06-13 20:50:00 +02002967- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02002968 Modifies the behaviour of start.S when compiling a loader
2969 that is executed before the actual U-Boot. E.g. when
2970 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002971
Matthias Weisserd8834a12011-03-10 21:36:32 +00002972- CONFIG_USE_ARCH_MEMCPY
2973 CONFIG_USE_ARCH_MEMSET
2974 If these options are used a optimized version of memcpy/memset will
2975 be used if available. These functions may be faster under some
2976 conditions but may increase the binary size.
2977
wdenkc6097192002-11-03 00:24:07 +00002978Building the Software:
2979======================
2980
Wolfgang Denk218ca722008-03-26 10:40:12 +01002981Building U-Boot has been tested in several native build environments
2982and in many different cross environments. Of course we cannot support
2983all possibly existing versions of cross development tools in all
2984(potentially obsolete) versions. In case of tool chain problems we
2985recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2986which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002987
Wolfgang Denk218ca722008-03-26 10:40:12 +01002988If you are not using a native environment, it is assumed that you
2989have GNU cross compiling tools available in your path. In this case,
2990you must set the environment variable CROSS_COMPILE in your shell.
2991Note that no changes to the Makefile or any other source files are
2992necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002993
Wolfgang Denk218ca722008-03-26 10:40:12 +01002994 $ CROSS_COMPILE=ppc_4xx-
2995 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002996
Peter Tyser2f8d3962009-03-13 18:54:51 -05002997Note: If you wish to generate Windows versions of the utilities in
2998 the tools directory you can use the MinGW toolchain
2999 (http://www.mingw.org). Set your HOST tools to the MinGW
3000 toolchain and execute 'make tools'. For example:
3001
3002 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3003
3004 Binaries such as tools/mkimage.exe will be created which can
3005 be executed on computers running Windows.
3006
Wolfgang Denk218ca722008-03-26 10:40:12 +01003007U-Boot is intended to be simple to build. After installing the
3008sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003009is done by typing:
3010
3011 make NAME_config
3012
Wolfgang Denk218ca722008-03-26 10:40:12 +01003013where "NAME_config" is the name of one of the existing configu-
3014rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003015
wdenk2729af92004-05-03 20:45:30 +00003016Note: for some board special configuration names may exist; check if
3017 additional information is available from the board vendor; for
3018 instance, the TQM823L systems are available without (standard)
3019 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003020 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003021
wdenk2729af92004-05-03 20:45:30 +00003022 make TQM823L_config
3023 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003024
wdenk2729af92004-05-03 20:45:30 +00003025 make TQM823L_LCD_config
3026 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003027
wdenk2729af92004-05-03 20:45:30 +00003028 etc.
wdenkc6097192002-11-03 00:24:07 +00003029
wdenkc6097192002-11-03 00:24:07 +00003030
wdenk2729af92004-05-03 20:45:30 +00003031Finally, type "make all", and you should get some working U-Boot
3032images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003033
wdenk2729af92004-05-03 20:45:30 +00003034- "u-boot.bin" is a raw binary image
3035- "u-boot" is an image in ELF binary format
3036- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003037
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003038By default the build is performed locally and the objects are saved
3039in the source directory. One of the two methods can be used to change
3040this behavior and build U-Boot to some external directory:
3041
30421. Add O= to the make command line invocations:
3043
3044 make O=/tmp/build distclean
3045 make O=/tmp/build NAME_config
3046 make O=/tmp/build all
3047
30482. Set environment variable BUILD_DIR to point to the desired location:
3049
3050 export BUILD_DIR=/tmp/build
3051 make distclean
3052 make NAME_config
3053 make all
3054
3055Note that the command line "O=" setting overrides the BUILD_DIR environment
3056variable.
3057
wdenkc6097192002-11-03 00:24:07 +00003058
wdenk2729af92004-05-03 20:45:30 +00003059Please be aware that the Makefiles assume you are using GNU make, so
3060for instance on NetBSD you might need to use "gmake" instead of
3061native "make".
wdenkc6097192002-11-03 00:24:07 +00003062
wdenkc6097192002-11-03 00:24:07 +00003063
wdenk2729af92004-05-03 20:45:30 +00003064If the system board that you have is not listed, then you will need
3065to port U-Boot to your hardware platform. To do this, follow these
3066steps:
wdenkc6097192002-11-03 00:24:07 +00003067
wdenk2729af92004-05-03 20:45:30 +000030681. Add a new configuration option for your board to the toplevel
3069 "Makefile" and to the "MAKEALL" script, using the existing
3070 entries as examples. Note that here and at many other places
3071 boards and other names are listed in alphabetical sort order. Please
3072 keep this order.
30732. Create a new directory to hold your board specific code. Add any
3074 files you need. In your board directory, you will need at least
3075 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
30763. Create a new configuration file "include/configs/<board>.h" for
3077 your board
30783. If you're porting U-Boot to a new CPU, then also create a new
3079 directory to hold your CPU specific code. Add any files you need.
30804. Run "make <board>_config" with your new name.
30815. Type "make", and you should get a working "u-boot.srec" file
3082 to be installed on your target system.
30836. Debug and solve any problems that might arise.
3084 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003085
wdenkc6097192002-11-03 00:24:07 +00003086
wdenk2729af92004-05-03 20:45:30 +00003087Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3088==============================================================
wdenkc6097192002-11-03 00:24:07 +00003089
Wolfgang Denk218ca722008-03-26 10:40:12 +01003090If you have modified U-Boot sources (for instance added a new board
3091or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003092provide feedback to the other developers. The feedback normally takes
3093the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003094official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003095
Wolfgang Denk218ca722008-03-26 10:40:12 +01003096But before you submit such a patch, please verify that your modifi-
3097cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003098the supported boards compile WITHOUT ANY compiler warnings. To do so,
3099just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003100for ALL supported system. Be warned, this will take a while. You can
3101select which (cross) compiler to use by passing a `CROSS_COMPILE'
3102environment variable to the script, i. e. to use the ELDK cross tools
3103you can type
wdenkc6097192002-11-03 00:24:07 +00003104
wdenk2729af92004-05-03 20:45:30 +00003105 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003106
wdenk2729af92004-05-03 20:45:30 +00003107or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003108
wdenk2729af92004-05-03 20:45:30 +00003109 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003110
Wolfgang Denk218ca722008-03-26 10:40:12 +01003111When using the MAKEALL script, the default behaviour is to build
3112U-Boot in the source directory. This location can be changed by
3113setting the BUILD_DIR environment variable. Also, for each target
3114built, the MAKEALL script saves two log files (<target>.ERR and
3115<target>.MAKEALL) in the <source dir>/LOG directory. This default
3116location can be changed by setting the MAKEALL_LOGDIR environment
3117variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003118
3119 export BUILD_DIR=/tmp/build
3120 export MAKEALL_LOGDIR=/tmp/log
3121 CROSS_COMPILE=ppc_8xx- MAKEALL
3122
Wolfgang Denk218ca722008-03-26 10:40:12 +01003123With the above settings build objects are saved in the /tmp/build,
3124log files are saved in the /tmp/log and the source tree remains clean
3125during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003126
3127
wdenk2729af92004-05-03 20:45:30 +00003128See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003129
wdenkc6097192002-11-03 00:24:07 +00003130
wdenk2729af92004-05-03 20:45:30 +00003131Monitor Commands - Overview:
3132============================
wdenkc6097192002-11-03 00:24:07 +00003133
wdenk2729af92004-05-03 20:45:30 +00003134go - start application at address 'addr'
3135run - run commands in an environment variable
3136bootm - boot application image from memory
3137bootp - boot image via network using BootP/TFTP protocol
3138tftpboot- boot image via network using TFTP protocol
3139 and env variables "ipaddr" and "serverip"
3140 (and eventually "gatewayip")
3141rarpboot- boot image via network using RARP/TFTP protocol
3142diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3143loads - load S-Record file over serial line
3144loadb - load binary file over serial line (kermit mode)
3145md - memory display
3146mm - memory modify (auto-incrementing)
3147nm - memory modify (constant address)
3148mw - memory write (fill)
3149cp - memory copy
3150cmp - memory compare
3151crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003152i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003153sspi - SPI utility commands
3154base - print or set address offset
3155printenv- print environment variables
3156setenv - set environment variables
3157saveenv - save environment variables to persistent storage
3158protect - enable or disable FLASH write protection
3159erase - erase FLASH memory
3160flinfo - print FLASH memory information
3161bdinfo - print Board Info structure
3162iminfo - print header information for application image
3163coninfo - print console devices and informations
3164ide - IDE sub-system
3165loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003166loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003167mtest - simple RAM test
3168icache - enable or disable instruction cache
3169dcache - enable or disable data cache
3170reset - Perform RESET of the CPU
3171echo - echo args to console
3172version - print monitor version
3173help - print online help
3174? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003175
wdenkc6097192002-11-03 00:24:07 +00003176
wdenk2729af92004-05-03 20:45:30 +00003177Monitor Commands - Detailed Description:
3178========================================
wdenkc6097192002-11-03 00:24:07 +00003179
wdenk2729af92004-05-03 20:45:30 +00003180TODO.
wdenkc6097192002-11-03 00:24:07 +00003181
wdenk2729af92004-05-03 20:45:30 +00003182For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003183
3184
wdenk2729af92004-05-03 20:45:30 +00003185Environment Variables:
3186======================
wdenkc6097192002-11-03 00:24:07 +00003187
wdenk2729af92004-05-03 20:45:30 +00003188U-Boot supports user configuration using Environment Variables which
3189can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003190
wdenk2729af92004-05-03 20:45:30 +00003191Environment Variables are set using "setenv", printed using
3192"printenv", and saved to Flash using "saveenv". Using "setenv"
3193without a value can be used to delete a variable from the
3194environment. As long as you don't save the environment you are
3195working with an in-memory copy. In case the Flash area containing the
3196environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003197
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003198Some configuration options can be set using Environment Variables.
3199
3200List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003201
wdenk2729af92004-05-03 20:45:30 +00003202 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003203
wdenk2729af92004-05-03 20:45:30 +00003204 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003205
wdenk2729af92004-05-03 20:45:30 +00003206 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003207
wdenk2729af92004-05-03 20:45:30 +00003208 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003209
wdenk2729af92004-05-03 20:45:30 +00003210 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003211
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003212 bootm_low - Memory range available for image processing in the bootm
3213 command can be restricted. This variable is given as
3214 a hexadecimal number and defines lowest address allowed
3215 for use by the bootm command. See also "bootm_size"
3216 environment variable. Address defined by "bootm_low" is
3217 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003218 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3219 bootm_mapsize.
3220
3221 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3222 This variable is given as a hexadecimal number and it
3223 defines the size of the memory region starting at base
3224 address bootm_low that is accessible by the Linux kernel
3225 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3226 as the default value if it is defined, and bootm_size is
3227 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003228
3229 bootm_size - Memory range available for image processing in the bootm
3230 command can be restricted. This variable is given as
3231 a hexadecimal number and defines the size of the region
3232 allowed for use by the bootm command. See also "bootm_low"
3233 environment variable.
3234
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003235 updatefile - Location of the software update file on a TFTP server, used
3236 by the automatic software update feature. Please refer to
3237 documentation in doc/README.update for more details.
3238
wdenk2729af92004-05-03 20:45:30 +00003239 autoload - if set to "no" (any string beginning with 'n'),
3240 "bootp" will just load perform a lookup of the
3241 configuration from the BOOTP server, but not try to
3242 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003243
wdenk2729af92004-05-03 20:45:30 +00003244 autostart - if set to "yes", an image loaded using the "bootp",
3245 "rarpboot", "tftpboot" or "diskboot" commands will
3246 be automatically started (by internally calling
3247 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003248
wdenk2729af92004-05-03 20:45:30 +00003249 If set to "no", a standalone image passed to the
3250 "bootm" command will be copied to the load address
3251 (and eventually uncompressed), but NOT be started.
3252 This can be used to load and uncompress arbitrary
3253 data.
wdenkc6097192002-11-03 00:24:07 +00003254
wdenk17ea1172004-06-06 21:51:03 +00003255 i2cfast - (PPC405GP|PPC405EP only)
3256 if set to 'y' configures Linux I2C driver for fast
3257 mode (400kHZ). This environment variable is used in
3258 initialization code. So, for changes to be effective
3259 it must be saved and board must be reset.
3260
wdenk2729af92004-05-03 20:45:30 +00003261 initrd_high - restrict positioning of initrd images:
3262 If this variable is not set, initrd images will be
3263 copied to the highest possible address in RAM; this
3264 is usually what you want since it allows for
3265 maximum initrd size. If for some reason you want to
3266 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003267 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003268 variable to a value of "no" or "off" or "0".
3269 Alternatively, you can set it to a maximum upper
3270 address to use (U-Boot will still check that it
3271 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003272
wdenk2729af92004-05-03 20:45:30 +00003273 For instance, when you have a system with 16 MB
3274 RAM, and want to reserve 4 MB from use by Linux,
3275 you can do this by adding "mem=12M" to the value of
3276 the "bootargs" variable. However, now you must make
3277 sure that the initrd image is placed in the first
3278 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003279
wdenk2729af92004-05-03 20:45:30 +00003280 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk2729af92004-05-03 20:45:30 +00003282 If you set initrd_high to 0xFFFFFFFF, this is an
3283 indication to U-Boot that all addresses are legal
3284 for the Linux kernel, including addresses in flash
3285 memory. In this case U-Boot will NOT COPY the
3286 ramdisk at all. This may be useful to reduce the
3287 boot time on your system, but requires that this
3288 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003289
wdenk2729af92004-05-03 20:45:30 +00003290 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003291
wdenk2729af92004-05-03 20:45:30 +00003292 loadaddr - Default load address for commands like "bootp",
3293 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003294
wdenk2729af92004-05-03 20:45:30 +00003295 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003296
wdenk2729af92004-05-03 20:45:30 +00003297 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003298
wdenk2729af92004-05-03 20:45:30 +00003299 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003300
wdenk2729af92004-05-03 20:45:30 +00003301 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003304
wdenk2729af92004-05-03 20:45:30 +00003305 ethprime - When CONFIG_NET_MULTI is enabled controls which
3306 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003307
wdenk2729af92004-05-03 20:45:30 +00003308 ethact - When CONFIG_NET_MULTI is enabled controls which
3309 interface is currently active. For example you
3310 can do the following
wdenkc6097192002-11-03 00:24:07 +00003311
Heiko Schocher48690d82010-07-20 17:45:02 +02003312 => setenv ethact FEC
3313 => ping 192.168.0.1 # traffic sent on FEC
3314 => setenv ethact SCC
3315 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003316
Matthias Fuchse1692572008-01-17 07:45:05 +01003317 ethrotate - When set to "no" U-Boot does not go through all
3318 available network interfaces.
3319 It just stays at the currently selected interface.
3320
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003321 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003322 either succeed or fail without retrying.
3323 When set to "once" the network operation will
3324 fail when all the available network interfaces
3325 are tried once without success.
3326 Useful on scripts which control the retry operation
3327 themselves.
wdenkc6097192002-11-03 00:24:07 +00003328
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003329 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003330
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003331 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003332 UDP source port.
3333
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003334 tftpdstport - If this is set, the value is used for TFTP's UDP
3335 destination port instead of the Well Know Port 69.
3336
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003337 tftpblocksize - Block size to use for TFTP transfers; if not set,
3338 we use the TFTP server's default block size
3339
3340 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3341 seconds, minimum value is 1000 = 1 second). Defines
3342 when a packet is considered to be lost so it has to
3343 be retransmitted. The default is 5000 = 5 seconds.
3344 Lowering this value may make downloads succeed
3345 faster in networks with high packet loss rates or
3346 with unreliable TFTP servers.
3347
3348 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003349 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003350 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003351
wdenk2729af92004-05-03 20:45:30 +00003352The following environment variables may be used and automatically
3353updated by the network boot commands ("bootp" and "rarpboot"),
3354depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003355
wdenk2729af92004-05-03 20:45:30 +00003356 bootfile - see above
3357 dnsip - IP address of your Domain Name Server
3358 dnsip2 - IP address of your secondary Domain Name Server
3359 gatewayip - IP address of the Gateway (Router) to use
3360 hostname - Target hostname
3361 ipaddr - see above
3362 netmask - Subnet Mask
3363 rootpath - Pathname of the root filesystem on the NFS server
3364 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003365
wdenka3d991b2004-04-15 21:48:45 +00003366
wdenk2729af92004-05-03 20:45:30 +00003367There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003368
wdenk2729af92004-05-03 20:45:30 +00003369 serial# - contains hardware identification information such
3370 as type string and/or serial number
3371 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003372
wdenk2729af92004-05-03 20:45:30 +00003373These variables can be set only once (usually during manufacturing of
3374the board). U-Boot refuses to delete or overwrite these variables
3375once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003376
3377
wdenk2729af92004-05-03 20:45:30 +00003378Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003379
wdenk2729af92004-05-03 20:45:30 +00003380 ver - Contains the U-Boot version string as printed
3381 with the "version" command. This variable is
3382 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003383
wdenkc6097192002-11-03 00:24:07 +00003384
wdenk2729af92004-05-03 20:45:30 +00003385Please note that changes to some configuration parameters may take
3386only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003387
stroesec1551ea2003-04-04 15:53:41 +00003388
wdenk2729af92004-05-03 20:45:30 +00003389Command Line Parsing:
3390=====================
stroesec1551ea2003-04-04 15:53:41 +00003391
wdenk2729af92004-05-03 20:45:30 +00003392There are two different command line parsers available with U-Boot:
3393the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003394
wdenk2729af92004-05-03 20:45:30 +00003395Old, simple command line parser:
3396--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003397
wdenk2729af92004-05-03 20:45:30 +00003398- supports environment variables (through setenv / saveenv commands)
3399- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003400- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003401- special characters ('$', ';') can be escaped by prefixing with '\',
3402 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003403 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003404- You can also escape text by enclosing in single apostrophes, for example:
3405 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003406
wdenk2729af92004-05-03 20:45:30 +00003407Hush shell:
3408-----------
wdenkf07771c2003-05-28 08:06:31 +00003409
wdenk2729af92004-05-03 20:45:30 +00003410- similar to Bourne shell, with control structures like
3411 if...then...else...fi, for...do...done; while...do...done,
3412 until...do...done, ...
3413- supports environment ("global") variables (through setenv / saveenv
3414 commands) and local shell variables (through standard shell syntax
3415 "name=value"); only environment variables can be used with "run"
3416 command
wdenkf07771c2003-05-28 08:06:31 +00003417
wdenk2729af92004-05-03 20:45:30 +00003418General rules:
3419--------------
wdenkf07771c2003-05-28 08:06:31 +00003420
wdenk2729af92004-05-03 20:45:30 +00003421(1) If a command line (or an environment variable executed by a "run"
3422 command) contains several commands separated by semicolon, and
3423 one of these commands fails, then the remaining commands will be
3424 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003425
wdenk2729af92004-05-03 20:45:30 +00003426(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003427 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003428 command will cause "run" to terminate, i. e. the remaining
3429 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003430
wdenk2729af92004-05-03 20:45:30 +00003431Note for Redundant Ethernet Interfaces:
3432=======================================
wdenkf07771c2003-05-28 08:06:31 +00003433
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003434Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003435such configurations and is capable of automatic selection of a
3436"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003437
wdenk2729af92004-05-03 20:45:30 +00003438Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3439MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3440"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003441
wdenk2729af92004-05-03 20:45:30 +00003442If the network interface stores some valid MAC address (for instance
3443in SROM), this is used as default address if there is NO correspon-
3444ding setting in the environment; if the corresponding environment
3445variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003446
wdenk2729af92004-05-03 20:45:30 +00003447o If the SROM has a valid MAC address, and there is no address in the
3448 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003449
wdenk2729af92004-05-03 20:45:30 +00003450o If there is no valid address in the SROM, and a definition in the
3451 environment exists, then the value from the environment variable is
3452 used.
wdenkc6097192002-11-03 00:24:07 +00003453
wdenk2729af92004-05-03 20:45:30 +00003454o If both the SROM and the environment contain a MAC address, and
3455 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003456
wdenk2729af92004-05-03 20:45:30 +00003457o If both the SROM and the environment contain a MAC address, and the
3458 addresses differ, the value from the environment is used and a
3459 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003460
wdenk2729af92004-05-03 20:45:30 +00003461o If neither SROM nor the environment contain a MAC address, an error
3462 is raised.
wdenkc6097192002-11-03 00:24:07 +00003463
Ben Warrenecee9322010-04-26 11:11:46 -07003464If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3465will be programmed into hardware as part of the initialization process. This
3466may be skipped by setting the appropriate 'ethmacskip' environment variable.
3467The naming convention is as follows:
3468"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003469
wdenk2729af92004-05-03 20:45:30 +00003470Image Formats:
3471==============
wdenkc6097192002-11-03 00:24:07 +00003472
Marian Balakowicz3310c542008-03-12 12:13:13 +01003473U-Boot is capable of booting (and performing other auxiliary operations on)
3474images in two formats:
3475
3476New uImage format (FIT)
3477-----------------------
3478
3479Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3480to Flattened Device Tree). It allows the use of images with multiple
3481components (several kernels, ramdisks, etc.), with contents protected by
3482SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3483
3484
3485Old uImage format
3486-----------------
3487
3488Old image format is based on binary files which can be basically anything,
3489preceded by a special header; see the definitions in include/image.h for
3490details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003491
wdenk2729af92004-05-03 20:45:30 +00003492* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3493 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003494 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3495 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3496 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003497* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003498 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3499 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003500* Compression Type (uncompressed, gzip, bzip2)
3501* Load Address
3502* Entry Point
3503* Image Name
3504* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003505
wdenk2729af92004-05-03 20:45:30 +00003506The header is marked by a special Magic Number, and both the header
3507and the data portions of the image are secured against corruption by
3508CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003509
wdenkc6097192002-11-03 00:24:07 +00003510
wdenk2729af92004-05-03 20:45:30 +00003511Linux Support:
3512==============
wdenkc6097192002-11-03 00:24:07 +00003513
wdenk2729af92004-05-03 20:45:30 +00003514Although U-Boot should support any OS or standalone application
3515easily, the main focus has always been on Linux during the design of
3516U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003517
wdenk2729af92004-05-03 20:45:30 +00003518U-Boot includes many features that so far have been part of some
3519special "boot loader" code within the Linux kernel. Also, any
3520"initrd" images to be used are no longer part of one big Linux image;
3521instead, kernel and "initrd" are separate images. This implementation
3522serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003523
wdenk2729af92004-05-03 20:45:30 +00003524- the same features can be used for other OS or standalone
3525 applications (for instance: using compressed images to reduce the
3526 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003527
wdenk2729af92004-05-03 20:45:30 +00003528- it becomes much easier to port new Linux kernel versions because
3529 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003530
wdenk2729af92004-05-03 20:45:30 +00003531- the same Linux kernel image can now be used with different "initrd"
3532 images; of course this also means that different kernel images can
3533 be run with the same "initrd". This makes testing easier (you don't
3534 have to build a new "zImage.initrd" Linux image when you just
3535 change a file in your "initrd"). Also, a field-upgrade of the
3536 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003537
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk2729af92004-05-03 20:45:30 +00003539Linux HOWTO:
3540============
wdenkc6097192002-11-03 00:24:07 +00003541
wdenk2729af92004-05-03 20:45:30 +00003542Porting Linux to U-Boot based systems:
3543---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003544
wdenk2729af92004-05-03 20:45:30 +00003545U-Boot cannot save you from doing all the necessary modifications to
3546configure the Linux device drivers for use with your target hardware
3547(no, we don't intend to provide a full virtual machine interface to
3548Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003549
Stefan Roesea47a12b2010-04-15 16:07:28 +02003550But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003551
wdenk2729af92004-05-03 20:45:30 +00003552Just make sure your machine specific header file (for instance
3553include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003554Information structure as we define in include/asm-<arch>/u-boot.h,
3555and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003556as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003557
wdenkc6097192002-11-03 00:24:07 +00003558
wdenk2729af92004-05-03 20:45:30 +00003559Configuring the Linux kernel:
3560-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003561
wdenk2729af92004-05-03 20:45:30 +00003562No specific requirements for U-Boot. Make sure you have some root
3563device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003564
wdenkc6097192002-11-03 00:24:07 +00003565
wdenk2729af92004-05-03 20:45:30 +00003566Building a Linux Image:
3567-----------------------
wdenkc6097192002-11-03 00:24:07 +00003568
wdenk2729af92004-05-03 20:45:30 +00003569With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3570not used. If you use recent kernel source, a new build target
3571"uImage" will exist which automatically builds an image usable by
3572U-Boot. Most older kernels also have support for a "pImage" target,
3573which was introduced for our predecessor project PPCBoot and uses a
3574100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003575
wdenk2729af92004-05-03 20:45:30 +00003576Example:
wdenkc6097192002-11-03 00:24:07 +00003577
wdenk2729af92004-05-03 20:45:30 +00003578 make TQM850L_config
3579 make oldconfig
3580 make dep
3581 make uImage
wdenkc6097192002-11-03 00:24:07 +00003582
wdenk2729af92004-05-03 20:45:30 +00003583The "uImage" build target uses a special tool (in 'tools/mkimage') to
3584encapsulate a compressed Linux kernel image with header information,
3585CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk2729af92004-05-03 20:45:30 +00003587* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591 ${CROSS_COMPILE}-objcopy -O binary \
3592 -R .note -R .comment \
3593 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003594
wdenk2729af92004-05-03 20:45:30 +00003595* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003596
wdenk2729af92004-05-03 20:45:30 +00003597 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003598
wdenk2729af92004-05-03 20:45:30 +00003599* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003600
wdenk2729af92004-05-03 20:45:30 +00003601 mkimage -A ppc -O linux -T kernel -C gzip \
3602 -a 0 -e 0 -n "Linux Kernel Image" \
3603 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003604
wdenk24ee89b2002-11-03 17:56:27 +00003605
wdenk2729af92004-05-03 20:45:30 +00003606The "mkimage" tool can also be used to create ramdisk images for use
3607with U-Boot, either separated from the Linux kernel image, or
3608combined into one file. "mkimage" encapsulates the images with a 64
3609byte header containing information about target architecture,
3610operating system, image type, compression method, entry points, time
3611stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003612
wdenk2729af92004-05-03 20:45:30 +00003613"mkimage" can be called in two ways: to verify existing images and
3614print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003615
wdenk2729af92004-05-03 20:45:30 +00003616In the first form (with "-l" option) mkimage lists the information
3617contained in the header of an existing U-Boot image; this includes
3618checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003619
wdenk2729af92004-05-03 20:45:30 +00003620 tools/mkimage -l image
3621 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003622
wdenk2729af92004-05-03 20:45:30 +00003623The second form (with "-d" option) is used to build a U-Boot image
3624from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003625
wdenk2729af92004-05-03 20:45:30 +00003626 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3627 -n name -d data_file image
3628 -A ==> set architecture to 'arch'
3629 -O ==> set operating system to 'os'
3630 -T ==> set image type to 'type'
3631 -C ==> set compression type 'comp'
3632 -a ==> set load address to 'addr' (hex)
3633 -e ==> set entry point to 'ep' (hex)
3634 -n ==> set image name to 'name'
3635 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003636
wdenk69459792004-05-29 16:53:29 +00003637Right now, all Linux kernels for PowerPC systems use the same load
3638address (0x00000000), but the entry point address depends on the
3639kernel version:
wdenkc6097192002-11-03 00:24:07 +00003640
wdenk2729af92004-05-03 20:45:30 +00003641- 2.2.x kernels have the entry point at 0x0000000C,
3642- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003643
wdenk2729af92004-05-03 20:45:30 +00003644So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003645
wdenk2729af92004-05-03 20:45:30 +00003646 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3647 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003648 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003649 > examples/uImage.TQM850L
3650 Image Name: 2.4.4 kernel for TQM850L
3651 Created: Wed Jul 19 02:34:59 2000
3652 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3653 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3654 Load Address: 0x00000000
3655 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003656
wdenk2729af92004-05-03 20:45:30 +00003657To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659 -> tools/mkimage -l examples/uImage.TQM850L
3660 Image Name: 2.4.4 kernel for TQM850L
3661 Created: Wed Jul 19 02:34:59 2000
3662 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3663 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3664 Load Address: 0x00000000
3665 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667NOTE: for embedded systems where boot time is critical you can trade
3668speed for memory and install an UNCOMPRESSED image instead: this
3669needs more space in Flash, but boots much faster since it does not
3670need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003671
Stefan Roesea47a12b2010-04-15 16:07:28 +02003672 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003673 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3674 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003675 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003676 > examples/uImage.TQM850L-uncompressed
3677 Image Name: 2.4.4 kernel for TQM850L
3678 Created: Wed Jul 19 02:34:59 2000
3679 Image Type: PowerPC Linux Kernel Image (uncompressed)
3680 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3681 Load Address: 0x00000000
3682 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003683
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk2729af92004-05-03 20:45:30 +00003685Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3686when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003687
wdenk2729af92004-05-03 20:45:30 +00003688 -> tools/mkimage -n 'Simple Ramdisk Image' \
3689 > -A ppc -O linux -T ramdisk -C gzip \
3690 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3691 Image Name: Simple Ramdisk Image
3692 Created: Wed Jan 12 14:01:50 2000
3693 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3694 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3695 Load Address: 0x00000000
3696 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003697
wdenkdb01a2e2004-04-15 23:14:49 +00003698
wdenk2729af92004-05-03 20:45:30 +00003699Installing a Linux Image:
3700-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003701
wdenk2729af92004-05-03 20:45:30 +00003702To downloading a U-Boot image over the serial (console) interface,
3703you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003704
wdenk2729af92004-05-03 20:45:30 +00003705 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003706
wdenk2729af92004-05-03 20:45:30 +00003707The 'objcopy' does not understand the information in the U-Boot
3708image header, so the resulting S-Record file will be relative to
3709address 0x00000000. To load it to a given address, you need to
3710specify the target address as 'offset' parameter with the 'loads'
3711command.
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk2729af92004-05-03 20:45:30 +00003713Example: install the image to address 0x40100000 (which on the
3714TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003715
wdenk2729af92004-05-03 20:45:30 +00003716 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003717
wdenk2729af92004-05-03 20:45:30 +00003718 .......... done
3719 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003720
wdenk2729af92004-05-03 20:45:30 +00003721 => loads 40100000
3722 ## Ready for S-Record download ...
3723 ~>examples/image.srec
3724 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3725 ...
3726 15989 15990 15991 15992
3727 [file transfer complete]
3728 [connected]
3729 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003730
3731
wdenk2729af92004-05-03 20:45:30 +00003732You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003733this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003734corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk2729af92004-05-03 20:45:30 +00003736 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003737
wdenk2729af92004-05-03 20:45:30 +00003738 ## Checking Image at 40100000 ...
3739 Image Name: 2.2.13 for initrd on TQM850L
3740 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3741 Data Size: 335725 Bytes = 327 kB = 0 MB
3742 Load Address: 00000000
3743 Entry Point: 0000000c
3744 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003745
3746
wdenk2729af92004-05-03 20:45:30 +00003747Boot Linux:
3748-----------
wdenkc6097192002-11-03 00:24:07 +00003749
wdenk2729af92004-05-03 20:45:30 +00003750The "bootm" command is used to boot an application that is stored in
3751memory (RAM or Flash). In case of a Linux kernel image, the contents
3752of the "bootargs" environment variable is passed to the kernel as
3753parameters. You can check and modify this variable using the
3754"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003755
3756
wdenk2729af92004-05-03 20:45:30 +00003757 => printenv bootargs
3758 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003759
wdenk2729af92004-05-03 20:45:30 +00003760 => 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 +00003761
wdenk2729af92004-05-03 20:45:30 +00003762 => printenv bootargs
3763 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 +00003764
wdenk2729af92004-05-03 20:45:30 +00003765 => bootm 40020000
3766 ## Booting Linux kernel at 40020000 ...
3767 Image Name: 2.2.13 for NFS on TQM850L
3768 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3769 Data Size: 381681 Bytes = 372 kB = 0 MB
3770 Load Address: 00000000
3771 Entry Point: 0000000c
3772 Verifying Checksum ... OK
3773 Uncompressing Kernel Image ... OK
3774 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
3775 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3776 time_init: decrementer frequency = 187500000/60
3777 Calibrating delay loop... 49.77 BogoMIPS
3778 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3779 ...
wdenkc6097192002-11-03 00:24:07 +00003780
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003781If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003782the memory addresses of both the kernel and the initrd image (PPBCOOT
3783format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003784
wdenk2729af92004-05-03 20:45:30 +00003785 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003786
wdenk2729af92004-05-03 20:45:30 +00003787 ## Checking Image at 40100000 ...
3788 Image Name: 2.2.13 for initrd on TQM850L
3789 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3790 Data Size: 335725 Bytes = 327 kB = 0 MB
3791 Load Address: 00000000
3792 Entry Point: 0000000c
3793 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003794
wdenk2729af92004-05-03 20:45:30 +00003795 ## Checking Image at 40200000 ...
3796 Image Name: Simple Ramdisk Image
3797 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3798 Data Size: 566530 Bytes = 553 kB = 0 MB
3799 Load Address: 00000000
3800 Entry Point: 00000000
3801 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003802
wdenk2729af92004-05-03 20:45:30 +00003803 => bootm 40100000 40200000
3804 ## Booting Linux kernel at 40100000 ...
3805 Image Name: 2.2.13 for initrd on TQM850L
3806 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3807 Data Size: 335725 Bytes = 327 kB = 0 MB
3808 Load Address: 00000000
3809 Entry Point: 0000000c
3810 Verifying Checksum ... OK
3811 Uncompressing Kernel Image ... OK
3812 ## Loading RAMDisk Image at 40200000 ...
3813 Image Name: Simple Ramdisk Image
3814 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3815 Data Size: 566530 Bytes = 553 kB = 0 MB
3816 Load Address: 00000000
3817 Entry Point: 00000000
3818 Verifying Checksum ... OK
3819 Loading Ramdisk ... OK
3820 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
3821 Boot arguments: root=/dev/ram
3822 time_init: decrementer frequency = 187500000/60
3823 Calibrating delay loop... 49.77 BogoMIPS
3824 ...
3825 RAMDISK: Compressed image found at block 0
3826 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828 bash#
wdenkc6097192002-11-03 00:24:07 +00003829
Matthew McClintock02677682006-06-28 10:41:37 -05003830Boot Linux and pass a flat device tree:
3831-----------
3832
3833First, U-Boot must be compiled with the appropriate defines. See the section
3834titled "Linux Kernel Interface" above for a more in depth explanation. The
3835following is an example of how to start a kernel and pass an updated
3836flat device tree:
3837
3838=> print oftaddr
3839oftaddr=0x300000
3840=> print oft
3841oft=oftrees/mpc8540ads.dtb
3842=> tftp $oftaddr $oft
3843Speed: 1000, full duplex
3844Using TSEC0 device
3845TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3846Filename 'oftrees/mpc8540ads.dtb'.
3847Load address: 0x300000
3848Loading: #
3849done
3850Bytes transferred = 4106 (100a hex)
3851=> tftp $loadaddr $bootfile
3852Speed: 1000, full duplex
3853Using TSEC0 device
3854TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3855Filename 'uImage'.
3856Load address: 0x200000
3857Loading:############
3858done
3859Bytes transferred = 1029407 (fb51f hex)
3860=> print loadaddr
3861loadaddr=200000
3862=> print oftaddr
3863oftaddr=0x300000
3864=> bootm $loadaddr - $oftaddr
3865## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003866 Image Name: Linux-2.6.17-dirty
3867 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3868 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003869 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003870 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003871 Verifying Checksum ... OK
3872 Uncompressing Kernel Image ... OK
3873Booting using flat device tree at 0x300000
3874Using MPC85xx ADS machine description
3875Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3876[snip]
3877
3878
wdenk2729af92004-05-03 20:45:30 +00003879More About U-Boot Image Types:
3880------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003881
wdenk2729af92004-05-03 20:45:30 +00003882U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884 "Standalone Programs" are directly runnable in the environment
3885 provided by U-Boot; it is expected that (if they behave
3886 well) you can continue to work in U-Boot after return from
3887 the Standalone Program.
3888 "OS Kernel Images" are usually images of some Embedded OS which
3889 will take over control completely. Usually these programs
3890 will install their own set of exception handlers, device
3891 drivers, set up the MMU, etc. - this means, that you cannot
3892 expect to re-enter U-Boot except by resetting the CPU.
3893 "RAMDisk Images" are more or less just data blocks, and their
3894 parameters (address, size) are passed to an OS kernel that is
3895 being started.
3896 "Multi-File Images" contain several images, typically an OS
3897 (Linux) kernel image and one or more data images like
3898 RAMDisks. This construct is useful for instance when you want
3899 to boot over the network using BOOTP etc., where the boot
3900 server provides just a single image file, but you want to get
3901 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003902
wdenk2729af92004-05-03 20:45:30 +00003903 "Multi-File Images" start with a list of image sizes, each
3904 image size (in bytes) specified by an "uint32_t" in network
3905 byte order. This list is terminated by an "(uint32_t)0".
3906 Immediately after the terminating 0 follow the images, one by
3907 one, all aligned on "uint32_t" boundaries (size rounded up to
3908 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003909
wdenk2729af92004-05-03 20:45:30 +00003910 "Firmware Images" are binary images containing firmware (like
3911 U-Boot or FPGA images) which usually will be programmed to
3912 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003913
wdenk2729af92004-05-03 20:45:30 +00003914 "Script files" are command sequences that will be executed by
3915 U-Boot's command interpreter; this feature is especially
3916 useful when you configure U-Boot to use a real shell (hush)
3917 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003918
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk2729af92004-05-03 20:45:30 +00003920Standalone HOWTO:
3921=================
wdenkc6097192002-11-03 00:24:07 +00003922
wdenk2729af92004-05-03 20:45:30 +00003923One of the features of U-Boot is that you can dynamically load and
3924run "standalone" applications, which can use some resources of
3925U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003926
wdenk2729af92004-05-03 20:45:30 +00003927Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003928
wdenk2729af92004-05-03 20:45:30 +00003929"Hello World" Demo:
3930-------------------
wdenkc6097192002-11-03 00:24:07 +00003931
wdenk2729af92004-05-03 20:45:30 +00003932'examples/hello_world.c' contains a small "Hello World" Demo
3933application; it is automatically compiled when you build U-Boot.
3934It's configured to run at address 0x00040004, so you can play with it
3935like that:
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937 => loads
3938 ## Ready for S-Record download ...
3939 ~>examples/hello_world.srec
3940 1 2 3 4 5 6 7 8 9 10 11 ...
3941 [file transfer complete]
3942 [connected]
3943 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945 => go 40004 Hello World! This is a test.
3946 ## Starting application at 0x00040004 ...
3947 Hello World
3948 argc = 7
3949 argv[0] = "40004"
3950 argv[1] = "Hello"
3951 argv[2] = "World!"
3952 argv[3] = "This"
3953 argv[4] = "is"
3954 argv[5] = "a"
3955 argv[6] = "test."
3956 argv[7] = "<NULL>"
3957 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003958
wdenk2729af92004-05-03 20:45:30 +00003959 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003960
wdenk2729af92004-05-03 20:45:30 +00003961Another example, which demonstrates how to register a CPM interrupt
3962handler with the U-Boot code, can be found in 'examples/timer.c'.
3963Here, a CPM timer is set up to generate an interrupt every second.
3964The interrupt service routine is trivial, just printing a '.'
3965character, but this is just a demo program. The application can be
3966controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003967
wdenk2729af92004-05-03 20:45:30 +00003968 ? - print current values og the CPM Timer registers
3969 b - enable interrupts and start timer
3970 e - stop timer and disable interrupts
3971 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973 => loads
3974 ## Ready for S-Record download ...
3975 ~>examples/timer.srec
3976 1 2 3 4 5 6 7 8 9 10 11 ...
3977 [file transfer complete]
3978 [connected]
3979 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003980
wdenk2729af92004-05-03 20:45:30 +00003981 => go 40004
3982 ## Starting application at 0x00040004 ...
3983 TIMERS=0xfff00980
3984 Using timer 1
3985 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003986
wdenk2729af92004-05-03 20:45:30 +00003987Hit 'b':
3988 [q, b, e, ?] Set interval 1000000 us
3989 Enabling timer
3990Hit '?':
3991 [q, b, e, ?] ........
3992 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3993Hit '?':
3994 [q, b, e, ?] .
3995 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3996Hit '?':
3997 [q, b, e, ?] .
3998 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3999Hit '?':
4000 [q, b, e, ?] .
4001 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4002Hit 'e':
4003 [q, b, e, ?] ...Stopping timer
4004Hit 'q':
4005 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004006
4007
wdenk2729af92004-05-03 20:45:30 +00004008Minicom warning:
4009================
wdenk85ec0bc2003-03-31 16:34:49 +00004010
wdenk2729af92004-05-03 20:45:30 +00004011Over time, many people have reported problems when trying to use the
4012"minicom" terminal emulation program for serial download. I (wd)
4013consider minicom to be broken, and recommend not to use it. Under
4014Unix, I recommend to use C-Kermit for general purpose use (and
4015especially for kermit binary protocol download ("loadb" command), and
4016use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004017
wdenk2729af92004-05-03 20:45:30 +00004018Nevertheless, if you absolutely want to use it try adding this
4019configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004020
wdenk2729af92004-05-03 20:45:30 +00004021 Name Program Name U/D FullScr IO-Red. Multi
4022 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4023 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004024
4025
wdenk2729af92004-05-03 20:45:30 +00004026NetBSD Notes:
4027=============
wdenkc6097192002-11-03 00:24:07 +00004028
wdenk2729af92004-05-03 20:45:30 +00004029Starting at version 0.9.2, U-Boot supports NetBSD both as host
4030(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004031
wdenk2729af92004-05-03 20:45:30 +00004032Building requires a cross environment; it is known to work on
4033NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4034need gmake since the Makefiles are not compatible with BSD make).
4035Note that the cross-powerpc package does not install include files;
4036attempting to build U-Boot will fail because <machine/ansi.h> is
4037missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004038
wdenk2729af92004-05-03 20:45:30 +00004039 # cd /usr/pkg/cross/powerpc-netbsd/include
4040 # mkdir powerpc
4041 # ln -s powerpc machine
4042 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4043 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004044
wdenk2729af92004-05-03 20:45:30 +00004045Native builds *don't* work due to incompatibilities between native
4046and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004047
wdenk2729af92004-05-03 20:45:30 +00004048Booting assumes that (the first part of) the image booted is a
4049stage-2 loader which in turn loads and then invokes the kernel
4050proper. Loader sources will eventually appear in the NetBSD source
4051tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004052meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004053
4054
wdenk2729af92004-05-03 20:45:30 +00004055Implementation Internals:
4056=========================
wdenkc6097192002-11-03 00:24:07 +00004057
wdenk2729af92004-05-03 20:45:30 +00004058The following is not intended to be a complete description of every
4059implementation detail. However, it should help to understand the
4060inner workings of U-Boot and make it easier to port it to custom
4061hardware.
wdenkc6097192002-11-03 00:24:07 +00004062
4063
wdenk2729af92004-05-03 20:45:30 +00004064Initial Stack, Global Data:
4065---------------------------
wdenkc6097192002-11-03 00:24:07 +00004066
wdenk2729af92004-05-03 20:45:30 +00004067The implementation of U-Boot is complicated by the fact that U-Boot
4068starts running out of ROM (flash memory), usually without access to
4069system RAM (because the memory controller is not initialized yet).
4070This means that we don't have writable Data or BSS segments, and BSS
4071is not initialized as zero. To be able to get a C environment working
4072at all, we have to allocate at least a minimal stack. Implementation
4073options for this are defined and restricted by the CPU used: Some CPU
4074models provide on-chip memory (like the IMMR area on MPC8xx and
4075MPC826x processors), on others (parts of) the data cache can be
4076locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004077
Wolfgang Denk218ca722008-03-26 10:40:12 +01004078 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004079 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4082 From: "Chris Hallinan" <clh@net1plus.com>
4083 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4084 ...
wdenk43d96162003-03-06 00:02:04 +00004085
wdenk2729af92004-05-03 20:45:30 +00004086 Correct me if I'm wrong, folks, but the way I understand it
4087 is this: Using DCACHE as initial RAM for Stack, etc, does not
4088 require any physical RAM backing up the cache. The cleverness
4089 is that the cache is being used as a temporary supply of
4090 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004091 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004092 can see how this works by studying the cache architecture and
4093 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4096 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004097 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004098 option should work for you. Using CS 4 should be fine if your
4099 board designers haven't used it for something that would
4100 cause you grief during the initial boot! It is frequently not
4101 used.
wdenk43d96162003-03-06 00:02:04 +00004102
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004103 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004104 with your processor/board/system design. The default value
4105 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004106 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004107 than your SDRAM module. If you have a 64MB SDRAM module, set
4108 it above 400_0000. Just make sure your board has no resources
4109 that are supposed to respond to that address! That code in
4110 start.S has been around a while and should work as is when
4111 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004112
wdenk2729af92004-05-03 20:45:30 +00004113 -Chris Hallinan
4114 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004115
wdenk2729af92004-05-03 20:45:30 +00004116It is essential to remember this, since it has some impact on the C
4117code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004118
wdenk2729af92004-05-03 20:45:30 +00004119* Initialized global data (data segment) is read-only. Do not attempt
4120 to write it.
wdenkc6097192002-11-03 00:24:07 +00004121
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004122* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004123 as zero data - BSS segment) at all - this is undefined, initiali-
4124 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk2729af92004-05-03 20:45:30 +00004126* Stack space is very limited. Avoid big data buffers or things like
4127 that.
wdenkc6097192002-11-03 00:24:07 +00004128
wdenk2729af92004-05-03 20:45:30 +00004129Having only the stack as writable memory limits means we cannot use
4130normal global data to share information beween the code. But it
4131turned out that the implementation of U-Boot can be greatly
4132simplified by making a global data structure (gd_t) available to all
4133functions. We could pass a pointer to this data as argument to _all_
4134functions, but this would bloat the code. Instead we use a feature of
4135the GCC compiler (Global Register Variables) to share the data: we
4136place a pointer (gd) to the global data into a register which we
4137reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004138
wdenk2729af92004-05-03 20:45:30 +00004139When choosing a register for such a purpose we are restricted by the
4140relevant (E)ABI specifications for the current architecture, and by
4141GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004142
wdenk2729af92004-05-03 20:45:30 +00004143For PowerPC, the following registers have specific use:
4144 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004145 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004146 R3-R4: parameter passing and return values
4147 R5-R10: parameter passing
4148 R13: small data area pointer
4149 R30: GOT pointer
4150 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004151
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004152 (U-Boot also uses R12 as internal GOT pointer. r12
4153 is a volatile register so r12 needs to be reset when
4154 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004155
Wolfgang Denke7670f62008-02-14 22:43:22 +01004156 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004157
wdenk2729af92004-05-03 20:45:30 +00004158 Note: on PPC, we could use a static initializer (since the
4159 address of the global data structure is known at compile time),
4160 but it turned out that reserving a register results in somewhat
4161 smaller code - although the code savings are not that big (on
4162 average for all boards 752 bytes for the whole U-Boot image,
4163 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004164
Robin Getzc4db3352009-08-17 15:23:02 +00004165On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004166 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4167
Robin Getzc4db3352009-08-17 15:23:02 +00004168 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004169
wdenk2729af92004-05-03 20:45:30 +00004170On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004171
wdenk2729af92004-05-03 20:45:30 +00004172 R0: function argument word/integer result
4173 R1-R3: function argument word
4174 R9: GOT pointer
4175 R10: stack limit (used only if stack checking if enabled)
4176 R11: argument (frame) pointer
4177 R12: temporary workspace
4178 R13: stack pointer
4179 R14: link register
4180 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004181
wdenk2729af92004-05-03 20:45:30 +00004182 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004183
Thomas Chou0df01fd2010-05-21 11:08:03 +08004184On Nios II, the ABI is documented here:
4185 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4186
4187 ==> U-Boot will use gp to hold a pointer to the global data
4188
4189 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4190 to access small data sections, so gp is free.
4191
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004192NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4193or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004194
wdenk2729af92004-05-03 20:45:30 +00004195Memory Management:
4196------------------
wdenkc6097192002-11-03 00:24:07 +00004197
wdenk2729af92004-05-03 20:45:30 +00004198U-Boot runs in system state and uses physical addresses, i.e. the
4199MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201The available memory is mapped to fixed addresses using the memory
4202controller. In this process, a contiguous block is formed for each
4203memory type (Flash, SDRAM, SRAM), even when it consists of several
4204physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk2729af92004-05-03 20:45:30 +00004206U-Boot is installed in the first 128 kB of the first Flash bank (on
4207TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4208booting and sizing and initializing DRAM, the code relocates itself
4209to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004210memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004211configuration setting]. Below that, a structure with global Board
4212Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004213
wdenk2729af92004-05-03 20:45:30 +00004214Additionally, some exception handler code is copied to the low 8 kB
4215of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004216
wdenk2729af92004-05-03 20:45:30 +00004217So a typical memory configuration with 16 MB of DRAM could look like
4218this:
wdenkc6097192002-11-03 00:24:07 +00004219
wdenk2729af92004-05-03 20:45:30 +00004220 0x0000 0000 Exception Vector code
4221 :
4222 0x0000 1FFF
4223 0x0000 2000 Free for Application Use
4224 :
4225 :
wdenkc6097192002-11-03 00:24:07 +00004226
wdenk2729af92004-05-03 20:45:30 +00004227 :
4228 :
4229 0x00FB FF20 Monitor Stack (Growing downward)
4230 0x00FB FFAC Board Info Data and permanent copy of global data
4231 0x00FC 0000 Malloc Arena
4232 :
4233 0x00FD FFFF
4234 0x00FE 0000 RAM Copy of Monitor Code
4235 ... eventually: LCD or video framebuffer
4236 ... eventually: pRAM (Protected RAM - unchanged by reset)
4237 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004238
4239
wdenk2729af92004-05-03 20:45:30 +00004240System Initialization:
4241----------------------
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004244(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004245configuration for CS0# this is a mirror of the onboard Flash memory.
4246To be able to re-map memory U-Boot then jumps to its link address.
4247To be able to implement the initialization code in C, a (small!)
4248initial stack is set up in the internal Dual Ported RAM (in case CPUs
4249which provide such a feature like MPC8xx or MPC8260), or in a locked
4250part of the data cache. After that, U-Boot initializes the CPU core,
4251the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253Next, all (potentially) available memory banks are mapped using a
4254preliminary mapping. For example, we put them on 512 MB boundaries
4255(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4256on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4257programmed for SDRAM access. Using the temporary configuration, a
4258simple memory test is run that determines the size of the SDRAM
4259banks.
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk2729af92004-05-03 20:45:30 +00004261When there is more than one SDRAM bank, and the banks are of
4262different size, the largest is mapped first. For equal size, the first
4263bank (CS2#) is mapped first. The first mapping is always for address
42640x00000000, with any additional banks following immediately to create
4265contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267Then, the monitor installs itself at the upper end of the SDRAM area
4268and allocates memory for use by malloc() and for the global Board
4269Info data; also, the exception vector code is copied to the low RAM
4270pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004271
wdenk2729af92004-05-03 20:45:30 +00004272Only after this relocation will you have a "normal" C environment;
4273until that you are restricted in several ways, mostly because you are
4274running from ROM, and because the code will have to be relocated to a
4275new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004276
4277
wdenk2729af92004-05-03 20:45:30 +00004278U-Boot Porting Guide:
4279----------------------
wdenkc6097192002-11-03 00:24:07 +00004280
wdenk2729af92004-05-03 20:45:30 +00004281[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4282list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004283
4284
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004285int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004286{
4287 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004288
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004289 signal(SIGALRM, no_more_time);
4290 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004291
wdenk2729af92004-05-03 20:45:30 +00004292 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004293 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004294 return 0;
4295 }
4296
wdenk2729af92004-05-03 20:45:30 +00004297 Download latest U-Boot source;
4298
Wolfgang Denk06682362008-12-30 22:56:11 +01004299 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004300
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004301 if (clueless)
4302 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk2729af92004-05-03 20:45:30 +00004304 while (learning) {
4305 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004306 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4307 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004308 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004309 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004310 }
wdenkc6097192002-11-03 00:24:07 +00004311
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004312 if (available_money > toLocalCurrency ($2500))
4313 Buy a BDI3000;
4314 else
wdenk2729af92004-05-03 20:45:30 +00004315 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004316
4317 if (a similar board exists) { /* hopefully... */
4318 cp -a board/<similar> board/<myboard>
4319 cp include/configs/<similar>.h include/configs/<myboard>.h
4320 } else {
4321 Create your own board support subdirectory;
4322 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004323 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004324 Edit new board/<myboard> files
4325 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004326
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004327 while (!accepted) {
4328 while (!running) {
4329 do {
4330 Add / modify source code;
4331 } until (compiles);
4332 Debug;
4333 if (clueless)
4334 email("Hi, I am having problems...");
4335 }
4336 Send patch file to the U-Boot email list;
4337 if (reasonable critiques)
4338 Incorporate improvements from email list code review;
4339 else
4340 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004341 }
wdenkc6097192002-11-03 00:24:07 +00004342
wdenk2729af92004-05-03 20:45:30 +00004343 return 0;
4344}
4345
4346void no_more_time (int sig)
4347{
4348 hire_a_guru();
4349}
wdenkc6097192002-11-03 00:24:07 +00004350
4351
wdenk2729af92004-05-03 20:45:30 +00004352Coding Standards:
4353-----------------
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk2729af92004-05-03 20:45:30 +00004355All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004356coding style; see the file "Documentation/CodingStyle" and the script
4357"scripts/Lindent" in your Linux kernel source directory. In sources
4358originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4359spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004360
Detlev Zundel2c051652006-09-01 15:39:02 +02004361Source files originating from a different project (for example the
4362MTD subsystem) are generally exempt from these guidelines and are not
4363reformated to ease subsequent migration to newer versions of those
4364sources.
4365
4366Please note that U-Boot is implemented in C (and to some small parts in
4367Assembler); no C++ is used, so please do not use C++ style comments (//)
4368in your code.
wdenk2729af92004-05-03 20:45:30 +00004369
4370Please also stick to the following formatting rules:
4371- remove any trailing white space
4372- use TAB characters for indentation, not spaces
4373- make sure NOT to use DOS '\r\n' line feeds
4374- do not add more than 2 empty lines to source files
4375- do not add trailing empty lines to source files
4376
4377Submissions which do not conform to the standards may be returned
4378with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004379
4380
wdenk2729af92004-05-03 20:45:30 +00004381Submitting Patches:
4382-------------------
wdenkc6097192002-11-03 00:24:07 +00004383
wdenk2729af92004-05-03 20:45:30 +00004384Since the number of patches for U-Boot is growing, we need to
4385establish some rules. Submissions which do not conform to these rules
4386may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004387
Magnus Lilja0d28f342008-08-06 19:32:33 +02004388Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004389
Wolfgang Denk06682362008-12-30 22:56:11 +01004390Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4391see http://lists.denx.de/mailman/listinfo/u-boot
4392
wdenk2729af92004-05-03 20:45:30 +00004393When you send a patch, please include the following information with
4394it:
wdenkc6097192002-11-03 00:24:07 +00004395
wdenk2729af92004-05-03 20:45:30 +00004396* For bug fixes: a description of the bug and how your patch fixes
4397 this bug. Please try to include a way of demonstrating that the
4398 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk2729af92004-05-03 20:45:30 +00004400* For new features: a description of the feature and your
4401 implementation.
wdenkc6097192002-11-03 00:24:07 +00004402
wdenk2729af92004-05-03 20:45:30 +00004403* A CHANGELOG entry as plaintext (separate from the patch)
4404
4405* For major contributions, your entry to the CREDITS file
4406
4407* When you add support for a new board, don't forget to add this
4408 board to the MAKEALL script, too.
4409
4410* If your patch adds new configuration options, don't forget to
4411 document these in the README file.
4412
Wolfgang Denk218ca722008-03-26 10:40:12 +01004413* The patch itself. If you are using git (which is *strongly*
4414 recommended) you can easily generate the patch using the
4415 "git-format-patch". If you then use "git-send-email" to send it to
4416 the U-Boot mailing list, you will avoid most of the common problems
4417 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004418
Wolfgang Denk218ca722008-03-26 10:40:12 +01004419 If you cannot use git, use "diff -purN OLD NEW". If your version of
4420 diff does not support these options, then get the latest version of
4421 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004422
Wolfgang Denk218ca722008-03-26 10:40:12 +01004423 The current directory when running this command shall be the parent
4424 directory of the U-Boot source tree (i. e. please make sure that
4425 your patch includes sufficient directory information for the
4426 affected files).
4427
4428 We prefer patches as plain text. MIME attachments are discouraged,
4429 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004430
4431* If one logical set of modifications affects or creates several
4432 files, all these changes shall be submitted in a SINGLE patch file.
4433
4434* Changesets that contain different, unrelated modifications shall be
4435 submitted as SEPARATE patches, one patch per changeset.
4436
4437
4438Notes:
4439
4440* Before sending the patch, run the MAKEALL script on your patched
4441 source tree and make sure that no errors or warnings are reported
4442 for any of the boards.
4443
4444* Keep your modifications to the necessary minimum: A patch
4445 containing several unrelated changes or arbitrary reformats will be
4446 returned with a request to re-formatting / split it.
4447
4448* If you modify existing code, make sure that your new code does not
4449 add to the memory footprint of the code ;-) Small is beautiful!
4450 When adding new features, these should compile conditionally only
4451 (using #ifdef), and the resulting code with the new feature
4452 disabled must not need more memory than the old code without your
4453 modification.
wdenk90dc6702005-05-03 14:12:25 +00004454
Wolfgang Denk06682362008-12-30 22:56:11 +01004455* Remember that there is a size limit of 100 kB per message on the
4456 u-boot mailing list. Bigger patches will be moderated. If they are
4457 reasonable and not too big, they will be acknowledged. But patches
4458 bigger than the size limit should be avoided.