blob: d7e5b76295d22b0b3a90ad3cdee1db0e82de9000 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002# (C) Copyright 2000 - 2009
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Wolfgang Denka9046b92010-06-13 17:48:15 +0200150 /at91rm9200 Files specific to Atmel AT91RM9200 CPU
151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
183 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /nios2 Files generic to Altera NIOS2 architecture
185 /cpu CPU specific files
186 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200187 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /cpu CPU specific files
189 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
190 /mpc5xx Files specific to Freescale MPC5xx CPUs
191 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
192 /mpc8xx Files specific to Freescale MPC8xx CPUs
193 /mpc8220 Files specific to Freescale MPC8220 CPUs
194 /mpc824x Files specific to Freescale MPC824x CPUs
195 /mpc8260 Files specific to Freescale MPC8260 CPUs
196 /mpc85xx Files specific to Freescale MPC85xx CPUs
197 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
198 /lib Architecture specific library files
199 /sh Files generic to SH architecture
200 /cpu CPU specific files
201 /sh2 Files specific to sh2 CPUs
202 /sh3 Files specific to sh3 CPUs
203 /sh4 Files specific to sh4 CPUs
204 /lib Architecture specific library files
205 /sparc Files generic to SPARC architecture
206 /cpu CPU specific files
207 /leon2 Files specific to Gaisler LEON2 SPARC CPU
208 /leon3 Files specific to Gaisler LEON3 SPARC CPU
209 /lib Architecture specific library files
210/api Machine/arch independent API for external apps
211/board Board dependent files
212/common Misc architecture independent functions
213/disk Code for disk drive partition handling
214/doc Documentation (don't expect too much)
215/drivers Commonly used device drivers
216/examples Example code for standalone applications, etc.
217/fs Filesystem code (cramfs, ext2, jffs2, etc.)
218/include Header Files
219/lib Files generic to all architectures
220 /libfdt Library files to support flattened device trees
221 /lzma Library files to support LZMA decompression
222 /lzo Library files to support LZO decompression
223/net Networking code
224/post Power On Self Test
225/rtc Real Time Clock drivers
226/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000227
wdenkc6097192002-11-03 00:24:07 +0000228Software Configuration:
229=======================
230
231Configuration is usually done using C preprocessor defines; the
232rationale behind that is to avoid dead code whenever possible.
233
234There are two classes of configuration variables:
235
236* Configuration _OPTIONS_:
237 These are selectable by the user and have names beginning with
238 "CONFIG_".
239
240* Configuration _SETTINGS_:
241 These depend on the hardware etc. and should not be meddled with if
242 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200243 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000244
245Later we will add a configuration tool - probably similar to or even
246identical to what's used for the Linux kernel. Right now, we have to
247do the configuration by hand, which means creating some symbolic
248links and editing some configuration files. We use the TQM8xxL boards
249as an example here.
250
251
252Selection of Processor Architecture and Board Type:
253---------------------------------------------------
254
255For all supported boards there are ready-to-use default
256configurations available; just type "make <board_name>_config".
257
258Example: For a TQM823L module type:
259
260 cd u-boot
261 make TQM823L_config
262
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200263For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000264e.g. "make cogent_mpc8xx_config". And also configure the cogent
265directory according to the instructions in cogent/README.
266
267
268Configuration Options:
269----------------------
270
271Configuration depends on the combination of board and CPU type; all
272such information is kept in a configuration file
273"include/configs/<board_name>.h".
274
275Example: For a TQM823L module, all configuration settings are in
276"include/configs/TQM823L.h".
277
278
wdenk7f6c2cb2002-11-10 22:06:23 +0000279Many of the options are named exactly as the corresponding Linux
280kernel configuration options. The intention is to make it easier to
281build a config tool - later.
282
283
wdenkc6097192002-11-03 00:24:07 +0000284The following options need to be configured:
285
Kim Phillips26281142007-08-10 13:28:25 -0500286- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000287
Kim Phillips26281142007-08-10 13:28:25 -0500288- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200289
290- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100291 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000292
293- CPU Module Type: (if CONFIG_COGENT is defined)
294 Define exactly one of
295 CONFIG_CMA286_60_OLD
296--- FIXME --- not tested yet:
297 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298 CONFIG_CMA287_23, CONFIG_CMA287_50
299
300- Motherboard Type: (if CONFIG_COGENT is defined)
301 Define exactly one of
302 CONFIG_CMA101, CONFIG_CMA102
303
304- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305 Define one or more of
306 CONFIG_CMA302
307
308- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309 Define one or more of
310 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200311 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000312 a "rotator" |\-/|\-/
313
wdenk2535d602003-07-17 23:16:40 +0000314- Board flavour: (if CONFIG_MPC8260ADS is defined)
315 CONFIG_ADSTYPE
316 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200317 CONFIG_SYS_8260ADS - original MPC8260ADS
318 CONFIG_SYS_8266ADS - MPC8266ADS
319 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
320 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
wdenkc6097192002-11-03 00:24:07 +0000327- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000328 Define exactly one of
329 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200331- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
333 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000334 e.g. if there is no 32KHz
335 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
337 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000338
wdenk66ca92a2004-09-28 17:59:53 +0000339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_8xx_CPUCLK_MIN
341 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000343 See doc/README.MPC866
344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200345 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000346
wdenkba56f622004-02-06 23:19:44 +0000347 Define this to measure the actual CPU clock instead
348 of relying on the correctness of the configured
349 values. Mostly useful for board bringup to make sure
350 the PLL is locked at the intended frequency. Note
351 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200352 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000353
Heiko Schocher506f3912009-03-12 07:37:15 +0100354 CONFIG_SYS_DELAYED_ICACHE
355
356 Define this option if you want to enable the
357 ICache only when Code runs from RAM.
358
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100359- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200360 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100361
362 Defines the Monahans run mode to oscillator
363 ratio. Valid values are 8, 16, 24, 31. The core
364 frequency is this value multiplied by 13 MHz.
365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200366 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200367
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100368 Defines the Monahans turbo mode to oscillator
369 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200370 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100371 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200372
wdenk5da627a2003-10-09 20:09:04 +0000373- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000374 CONFIG_CLOCKS_IN_MHZ
375
376 U-Boot stores all clock information in Hz
377 internally. For binary compatibility with older Linux
378 kernels (which expect the clocks passed in the
379 bd_info data to be in MHz) the environment variable
380 "clocks_in_mhz" can be defined so that U-Boot
381 converts clock data to MHZ before passing it to the
382 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000383 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100384 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000385 default environment.
386
wdenk5da627a2003-10-09 20:09:04 +0000387 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
388
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200389 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000390 expect it to be in bytes, others in MB.
391 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
392
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400393 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200394
395 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400396 passed using flattened device trees (based on open firmware
397 concepts).
398
399 CONFIG_OF_LIBFDT
400 * New libfdt-based support
401 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500402 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400403
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200404 OF_CPU - The proper name of the cpus node (only required for
405 MPC512X and MPC5xxx based boards).
406 OF_SOC - The proper name of the soc node (only required for
407 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200408 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600409 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200410
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200411 boards with QUICC Engines require OF_QE to set UCC MAC
412 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500413
Kumar Gala4e253132006-01-11 13:54:17 -0600414 CONFIG_OF_BOARD_SETUP
415
416 Board code has addition modification that it wants to make
417 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000418
Matthew McClintock02677682006-06-28 10:41:37 -0500419 CONFIG_OF_BOOT_CPU
420
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200421 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500422 param header, the default value is zero if undefined.
423
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200424 CONFIG_OF_IDE_FIXUP
425
426 U-Boot can detect if an IDE device is present or not.
427 If not, and this new config option is activated, U-Boot
428 removes the ATA node from the DTS before booting Linux,
429 so the Linux IDE driver does not probe the device and
430 crash. This is needed for buggy hardware (uc101) where
431 no pull down resistor is connected to the signal IDE5V_DD7.
432
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100433- vxWorks boot parameters:
434
435 bootvx constructs a valid bootline using the following
436 environments variables: bootfile, ipaddr, serverip, hostname.
437 It loads the vxWorks image pointed bootfile.
438
439 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
440 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
441 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
442 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
443
444 CONFIG_SYS_VXWORKS_ADD_PARAMS
445
446 Add it at the end of the bootline. E.g "u=username pw=secret"
447
448 Note: If a "bootargs" environment is defined, it will overwride
449 the defaults discussed just above.
450
wdenk6705d812004-08-02 23:22:59 +0000451- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200452 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000453
454 Define this if you want support for Amba PrimeCell PL010 UARTs.
455
Andreas Engel48d01922008-09-08 14:30:53 +0200456 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000457
458 Define this if you want support for Amba PrimeCell PL011 UARTs.
459
460 CONFIG_PL011_CLOCK
461
462 If you have Amba PrimeCell PL011 UARTs, set this variable to
463 the clock speed of the UARTs.
464
465 CONFIG_PL01x_PORTS
466
467 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
468 define this to a list of base addresses for each (supported)
469 port. See e.g. include/configs/versatile.h
470
471
wdenkc6097192002-11-03 00:24:07 +0000472- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000473 Depending on board, define exactly one serial port
474 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
475 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
476 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000477
478 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
479 port routines must be defined elsewhere
480 (i.e. serial_init(), serial_getc(), ...)
481
482 CONFIG_CFB_CONSOLE
483 Enables console device for a color framebuffer. Needs following
484 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
485 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
486 (default big endian)
487 VIDEO_HW_RECTFILL graphic chip supports
488 rectangle fill
489 (cf. smiLynxEM)
490 VIDEO_HW_BITBLT graphic chip supports
491 bit-blit (cf. smiLynxEM)
492 VIDEO_VISIBLE_COLS visible pixel columns
493 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000494 VIDEO_VISIBLE_ROWS visible pixel rows
495 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000496 VIDEO_DATA_FORMAT graphic data format
497 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000498 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000499 VIDEO_KBD_INIT_FCT keyboard int fct
500 (i.e. i8042_kbd_init())
501 VIDEO_TSTC_FCT test char fct
502 (i.e. i8042_tstc)
503 VIDEO_GETC_FCT get char fct
504 (i.e. i8042_getc)
505 CONFIG_CONSOLE_CURSOR cursor drawing on/off
506 (requires blink timer
507 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200508 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000509 CONFIG_CONSOLE_TIME display time/date info in
510 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500511 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000512 CONFIG_VIDEO_LOGO display Linux logo in
513 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000514 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
515 linux_logo.h for logo.
516 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000517 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200518 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000519 the logo
520
wdenk43d96162003-03-06 00:02:04 +0000521 When CONFIG_CFB_CONSOLE is defined, video console is
522 default i/o. Serial console can be forced with
523 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000524
wdenkd4ca31c2004-01-02 14:00:00 +0000525 When CONFIG_SILENT_CONSOLE is defined, all console
526 messages (by U-Boot and Linux!) can be silenced with
527 the "silent" environment variable. See
528 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000529
wdenkc6097192002-11-03 00:24:07 +0000530- Console Baudrate:
531 CONFIG_BAUDRATE - in bps
532 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200533 CONFIG_SYS_BAUDRATE_TABLE, see below.
534 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000535
Heiko Schocherc92fac92009-01-30 12:55:38 +0100536- Console Rx buffer length
537 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
538 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100539 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100540 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
541 must be defined, to setup the maximum idle timeout for
542 the SMC.
543
wdenkc6097192002-11-03 00:24:07 +0000544- Boot Delay: CONFIG_BOOTDELAY - in seconds
545 Delay before automatically booting the default image;
546 set to -1 to disable autoboot.
547
548 See doc/README.autoboot for these options that
549 work with CONFIG_BOOTDELAY. None are required.
550 CONFIG_BOOT_RETRY_TIME
551 CONFIG_BOOT_RETRY_MIN
552 CONFIG_AUTOBOOT_KEYED
553 CONFIG_AUTOBOOT_PROMPT
554 CONFIG_AUTOBOOT_DELAY_STR
555 CONFIG_AUTOBOOT_STOP_STR
556 CONFIG_AUTOBOOT_DELAY_STR2
557 CONFIG_AUTOBOOT_STOP_STR2
558 CONFIG_ZERO_BOOTDELAY_CHECK
559 CONFIG_RESET_TO_RETRY
560
561- Autoboot Command:
562 CONFIG_BOOTCOMMAND
563 Only needed when CONFIG_BOOTDELAY is enabled;
564 define a command string that is automatically executed
565 when no character is read on the console interface
566 within "Boot Delay" after reset.
567
568 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000569 This can be used to pass arguments to the bootm
570 command. The value of CONFIG_BOOTARGS goes into the
571 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000572
573 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000574 The value of these goes into the environment as
575 "ramboot" and "nfsboot" respectively, and can be used
576 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200577 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000578
579- Pre-Boot Commands:
580 CONFIG_PREBOOT
581
582 When this option is #defined, the existence of the
583 environment variable "preboot" will be checked
584 immediately before starting the CONFIG_BOOTDELAY
585 countdown and/or running the auto-boot command resp.
586 entering interactive mode.
587
588 This feature is especially useful when "preboot" is
589 automatically generated or modified. For an example
590 see the LWMON board specific code: here "preboot" is
591 modified when the user holds down a certain
592 combination of keys on the (special) keyboard when
593 booting the systems
594
595- Serial Download Echo Mode:
596 CONFIG_LOADS_ECHO
597 If defined to 1, all characters received during a
598 serial download (using the "loads" command) are
599 echoed back. This might be needed by some terminal
600 emulations (like "cu"), but may as well just take
601 time on others. This setting #define's the initial
602 value of the "loads_echo" environment variable.
603
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500604- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000605 CONFIG_KGDB_BAUDRATE
606 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200607 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000608
609- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500610 Monitor commands can be included or excluded
611 from the build by using the #include files
612 "config_cmd_all.h" and #undef'ing unwanted
613 commands, or using "config_cmd_default.h"
614 and augmenting with additional #define's
615 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000616
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500617 The default command configuration includes all commands
618 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000619
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500620 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500621 CONFIG_CMD_BDI bdinfo
622 CONFIG_CMD_BEDBUG * Include BedBug Debugger
623 CONFIG_CMD_BMP * BMP support
624 CONFIG_CMD_BSP * Board specific commands
625 CONFIG_CMD_BOOTD bootd
626 CONFIG_CMD_CACHE * icache, dcache
627 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500628 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500629 CONFIG_CMD_DATE * support for RTC, date/time...
630 CONFIG_CMD_DHCP * DHCP support
631 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600632 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
633 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
634 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
635 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500636 CONFIG_CMD_DTT * Digital Therm and Thermostat
637 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500638 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500639 CONFIG_CMD_EEPROM * EEPROM read/write support
640 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500641 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500642 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500643 CONFIG_CMD_FDC * Floppy Disk Support
644 CONFIG_CMD_FAT * FAT partition support
645 CONFIG_CMD_FDOS * Dos diskette Support
646 CONFIG_CMD_FLASH flinfo, erase, protect
647 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500648 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000649 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500650 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
651 CONFIG_CMD_I2C * I2C serial bus support
652 CONFIG_CMD_IDE * IDE harddisk support
653 CONFIG_CMD_IMI iminfo
654 CONFIG_CMD_IMLS List all found images
655 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500656 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500657 CONFIG_CMD_IRQ * irqinfo
658 CONFIG_CMD_ITEST Integer/string test of 2 values
659 CONFIG_CMD_JFFS2 * JFFS2 Support
660 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500661 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500662 CONFIG_CMD_LOADB loadb
663 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400664 CONFIG_CMD_MD5SUM print md5 message digest
665 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500666 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
667 loop, loopw, mtest
668 CONFIG_CMD_MISC Misc functions like sleep etc
669 CONFIG_CMD_MMC * MMC memory mapped support
670 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100671 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500672 CONFIG_CMD_NAND * NAND support
673 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600674 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
675 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500676 CONFIG_CMD_PCI * pciinfo
677 CONFIG_CMD_PCMCIA * PCMCIA support
678 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
679 host
680 CONFIG_CMD_PORTIO * Port I/O
681 CONFIG_CMD_REGINFO * Register dump
682 CONFIG_CMD_RUN run command in env variable
683 CONFIG_CMD_SAVES * save S record dump
684 CONFIG_CMD_SCSI * SCSI Support
685 CONFIG_CMD_SDRAM * print SDRAM configuration information
686 (requires CONFIG_CMD_I2C)
687 CONFIG_CMD_SETGETDCR Support for DCR Register access
688 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100689 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400690 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200691 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500692 CONFIG_CMD_SPI * SPI serial bus support
693 CONFIG_CMD_USB * USB support
694 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500695 CONFIG_CMD_CDP * Cisco Discover Protocol support
696 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000697
wdenkc6097192002-11-03 00:24:07 +0000698
699 EXAMPLE: If you want all functions except of network
700 support you can write:
701
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500702 #include "config_cmd_all.h"
703 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000704
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400705 Other Commands:
706 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000707
708 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500709 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000710 what you (and your U-Boot users) are doing. Data
711 cache cannot be enabled on systems like the 8xx or
712 8260 (where accesses to the IMMR region must be
713 uncached), and it cannot be disabled on all other
714 systems where we (mis-) use the data cache to hold an
715 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000716
717
718 XXX - this list needs to get updated!
719
720- Watchdog:
721 CONFIG_WATCHDOG
722 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000723 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000724 code for a watchdog. For the 8xx and 8260 CPUs, the
725 SIU Watchdog feature is enabled in the SYPCR
726 register.
727
stroesec1551ea2003-04-04 15:53:41 +0000728- U-Boot Version:
729 CONFIG_VERSION_VARIABLE
730 If this variable is defined, an environment variable
731 named "ver" is created by U-Boot showing the U-Boot
732 version as printed by the "version" command.
733 This variable is readonly.
734
wdenkc6097192002-11-03 00:24:07 +0000735- Real-Time Clock:
736
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500737 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000738 has to be selected, too. Define exactly one of the
739 following options:
740
741 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
742 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200743 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000744 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000745 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000746 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000747 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000748 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100749 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000750 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200751 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200752 CONFIG_SYS_RV3029_TCR - enable trickle charger on
753 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000754
wdenkb37c7e52003-06-30 16:24:52 +0000755 Note that if the RTC uses I2C, then the I2C interface
756 must also be configured. See I2C Support, below.
757
Peter Tysere92739d2008-12-17 16:36:21 -0600758- GPIO Support:
759 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
760 CONFIG_PCA953X_INFO - enable pca953x info command
761
Chris Packham5dec49c2010-12-19 10:12:13 +0000762 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
763 chip-ngpio pairs that tell the PCA953X driver the number of
764 pins supported by a particular chip.
765
Peter Tysere92739d2008-12-17 16:36:21 -0600766 Note that if the GPIO device uses I2C, then the I2C interface
767 must also be configured. See I2C Support, below.
768
wdenkc6097192002-11-03 00:24:07 +0000769- Timestamp Support:
770
wdenk43d96162003-03-06 00:02:04 +0000771 When CONFIG_TIMESTAMP is selected, the timestamp
772 (date and time) of an image is printed by image
773 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500774 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000775
776- Partition Support:
777 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400778 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000779
Wolfgang Denk218ca722008-03-26 10:40:12 +0100780 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
781 CONFIG_CMD_SCSI) you must configure support for at
782 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000783
784- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000785 CONFIG_IDE_RESET_ROUTINE - this is defined in several
786 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000787
wdenk4d13cba2004-03-14 14:09:05 +0000788 CONFIG_IDE_RESET - is this is defined, IDE Reset will
789 be performed by calling the function
790 ide_set_reset(int reset)
791 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000792
793- ATAPI Support:
794 CONFIG_ATAPI
795
796 Set this to enable ATAPI support.
797
wdenkc40b2952004-03-13 23:29:43 +0000798- LBA48 Support
799 CONFIG_LBA48
800
801 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100802 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000803 Whithout these , LBA48 support uses 32bit variables and will 'only'
804 support disks up to 2.1TB.
805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200806 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000807 When enabled, makes the IDE subsystem use 64bit sector addresses.
808 Default is 32bit.
809
wdenkc6097192002-11-03 00:24:07 +0000810- SCSI Support:
811 At the moment only there is only support for the
812 SYM53C8XX SCSI controller; define
813 CONFIG_SCSI_SYM53C8XX to enable it.
814
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200815 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
816 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
817 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000818 maximum numbers of LUNs, SCSI ID's and target
819 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200820 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000821
822- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000823 CONFIG_E1000
824 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000825
Andre Schwarzac3315c2008-03-06 16:45:44 +0100826 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200827 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100828
wdenkc6097192002-11-03 00:24:07 +0000829 CONFIG_EEPRO100
830 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200831 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000832 write routine for first time initialisation.
833
834 CONFIG_TULIP
835 Support for Digital 2114x chips.
836 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
837 modem chip initialisation (KS8761/QS6611).
838
839 CONFIG_NATSEMI
840 Support for National dp83815 chips.
841
842 CONFIG_NS8382X
843 Support for National dp8382[01] gigabit chips.
844
wdenk45219c42003-05-12 21:50:16 +0000845- NETWORK Support (other):
846
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100847 CONFIG_DRIVER_AT91EMAC
848 Support for AT91RM9200 EMAC.
849
850 CONFIG_RMII
851 Define this to use reduced MII inteface
852
853 CONFIG_DRIVER_AT91EMAC_QUIET
854 If this defined, the driver is quiet.
855 The driver doen't show link status messages.
856
wdenk45219c42003-05-12 21:50:16 +0000857 CONFIG_DRIVER_LAN91C96
858 Support for SMSC's LAN91C96 chips.
859
860 CONFIG_LAN91C96_BASE
861 Define this to hold the physical address
862 of the LAN91C96's I/O space
863
864 CONFIG_LAN91C96_USE_32_BIT
865 Define this to enable 32 bit addressing
866
wdenkf39748a2004-06-09 13:37:52 +0000867 CONFIG_DRIVER_SMC91111
868 Support for SMSC's LAN91C111 chip
869
870 CONFIG_SMC91111_BASE
871 Define this to hold the physical address
872 of the device (I/O space)
873
874 CONFIG_SMC_USE_32_BIT
875 Define this if data bus is 32 bits
876
877 CONFIG_SMC_USE_IOFUNCS
878 Define this to use i/o functions instead of macros
879 (some hardware wont work with macros)
880
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800881 CONFIG_FTGMAC100
882 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
883
884 CONFIG_FTGMAC100_EGIGA
885 Define this to use GE link update with gigabit PHY.
886 Define this if FTGMAC100 is connected to gigabit PHY.
887 If your system has 10/100 PHY only, it might not occur
888 wrong behavior. Because PHY usually return timeout or
889 useless data when polling gigabit status and gigabit
890 control registers. This behavior won't affect the
891 correctnessof 10/100 link speed update.
892
Mike Rapoportc2fff332009-11-11 10:03:03 +0200893 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200894 Support for SMSC's LAN911x and LAN921x chips
895
Mike Rapoportc2fff332009-11-11 10:03:03 +0200896 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200897 Define this to hold the physical address
898 of the device (I/O space)
899
Mike Rapoportc2fff332009-11-11 10:03:03 +0200900 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200901 Define this if data bus is 32 bits
902
Mike Rapoportc2fff332009-11-11 10:03:03 +0200903 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200904 Define this if data bus is 16 bits. If your processor
905 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200906 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200907
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900908 CONFIG_SH_ETHER
909 Support for Renesas on-chip Ethernet controller
910
911 CONFIG_SH_ETHER_USE_PORT
912 Define the number of ports to be used
913
914 CONFIG_SH_ETHER_PHY_ADDR
915 Define the ETH PHY's address
916
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900917 CONFIG_SH_ETHER_CACHE_WRITEBACK
918 If this option is set, the driver enables cache flush.
919
wdenkc6097192002-11-03 00:24:07 +0000920- USB Support:
921 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000922 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000923 CONFIG_USB_UHCI to enable it.
924 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000925 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000926 storage devices.
927 Note:
928 Supported are USB Keyboards and USB Floppy drives
929 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000930 MPC5200 USB requires additional defines:
931 CONFIG_USB_CLOCK
932 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500933 CONFIG_PSC3_USB
934 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000935 CONFIG_USB_CONFIG
936 for differential drivers: 0x00001000
937 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500938 for differential drivers on PSC3: 0x00000100
939 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200940 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200941 May be defined to allow interrupt polling
942 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000943
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200944- USB Device:
945 Define the below if you wish to use the USB console.
946 Once firmware is rebuilt from a serial console issue the
947 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200948 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200949 it has found a new device. The environment variable usbtty
950 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200951 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200952 Common Device Class Abstract Control Model serial device.
953 If you select usbtty = gserial you should be able to enumerate
954 a Linux host by
955 # modprobe usbserial vendor=0xVendorID product=0xProductID
956 else if using cdc_acm, simply setting the environment
957 variable usbtty to be cdc_acm should suffice. The following
958 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200959
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200960 CONFIG_USB_DEVICE
961 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000962
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200963 CONFIG_USB_TTY
964 Define this to have a tty type of device available to
965 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200966
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200967 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200968 Define this if you want stdin, stdout &/or stderr to
969 be set to usbtty.
970
971 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200972 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200973 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200974 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200976 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200977 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200978 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200979
Wolfgang Denk386eda02006-06-14 18:14:56 +0200980 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200981 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200982 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200983 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
984 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
985 should pretend to be a Linux device to it's target host.
986
987 CONFIG_USBD_MANUFACTURER
988 Define this string as the name of your company for
989 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200990
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200991 CONFIG_USBD_PRODUCT_NAME
992 Define this string as the name of your product
993 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
994
995 CONFIG_USBD_VENDORID
996 Define this as your assigned Vendor ID from the USB
997 Implementors Forum. This *must* be a genuine Vendor ID
998 to avoid polluting the USB namespace.
999 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001000
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001001 CONFIG_USBD_PRODUCTID
1002 Define this as the unique Product ID
1003 for your device
1004 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001005
1006
1007- MMC Support:
1008 The MMC controller on the Intel PXA is supported. To
1009 enable this define CONFIG_MMC. The MMC can be
1010 accessed from the boot prompt by mapping the device
1011 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001012 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1013 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001014
wdenk6705d812004-08-02 23:22:59 +00001015- Journaling Flash filesystem support:
1016 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1017 CONFIG_JFFS2_NAND_DEV
1018 Define these for a default partition on a NAND device
1019
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001020 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1021 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001022 Define these for a default partition on a NOR device
1023
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001024 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001025 Define this to create an own partition. You have to provide a
1026 function struct part_info* jffs2_part_info(int part_num)
1027
1028 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001029 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001030 to disable the command chpart. This is the default when you
1031 have not defined a custom partition
1032
wdenkc6097192002-11-03 00:24:07 +00001033- Keyboard Support:
1034 CONFIG_ISA_KEYBOARD
1035
1036 Define this to enable standard (PC-Style) keyboard
1037 support
1038
1039 CONFIG_I8042_KBD
1040 Standard PC keyboard driver with US (is default) and
1041 GERMAN key layout (switch via environment 'keymap=de') support.
1042 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1043 for cfb_console. Supports cursor blinking.
1044
1045- Video support:
1046 CONFIG_VIDEO
1047
1048 Define this to enable video support (for output to
1049 video).
1050
1051 CONFIG_VIDEO_CT69000
1052
1053 Enable Chips & Technologies 69000 Video chip
1054
1055 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001056 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001057 video output is selected via environment 'videoout'
1058 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1059 assumed.
wdenkc6097192002-11-03 00:24:07 +00001060
wdenkb79a11c2004-03-25 15:14:43 +00001061 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001062 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001063 are possible:
1064 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001065 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001066
1067 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1068 -------------+---------------------------------------------
1069 8 bits | 0x301* 0x303 0x305 0x161 0x307
1070 15 bits | 0x310 0x313 0x316 0x162 0x319
1071 16 bits | 0x311 0x314 0x317 0x163 0x31A
1072 24 bits | 0x312 0x315 0x318 ? 0x31B
1073 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001074 (i.e. setenv videomode 317; saveenv; reset;)
1075
wdenkb79a11c2004-03-25 15:14:43 +00001076 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001077 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001078
1079
stroesec1551ea2003-04-04 15:53:41 +00001080 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001081 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001082 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1083 or CONFIG_VIDEO_SED13806_16BPP
1084
Timur Tabi7d3053f2011-02-15 17:09:19 -06001085 CONFIG_FSL_DIU_FB
1086 Enable the Freescale DIU video driver. Reference boards for
1087 SOCs that have a DIU should define this macro to enable DIU
1088 support, and should also define these other macros:
1089
1090 CONFIG_SYS_DIU_ADDR
1091 CONFIG_VIDEO
1092 CONFIG_CMD_BMP
1093 CONFIG_CFB_CONSOLE
1094 CONFIG_VIDEO_SW_CURSOR
1095 CONFIG_VGA_AS_SINGLE_DEVICE
1096 CONFIG_VIDEO_LOGO
1097 CONFIG_VIDEO_BMP_LOGO
1098
Timur Tabiba8e76b2011-04-11 14:18:22 -05001099 The DIU driver will look for the 'video-mode' environment
1100 variable, and if defined, enable the DIU as a console during
1101 boot. See the documentation file README.video for a
1102 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001103
wdenk682011f2003-06-03 23:54:09 +00001104- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001105 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001106
wdenk8bde7f72003-06-27 21:31:46 +00001107 Define this to enable a custom keyboard support.
1108 This simply calls drv_keyboard_init() which must be
1109 defined in your board-specific files.
1110 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001111
wdenkc6097192002-11-03 00:24:07 +00001112- LCD Support: CONFIG_LCD
1113
1114 Define this to enable LCD support (for output to LCD
1115 display); also select one of the supported displays
1116 by defining one of these:
1117
Stelian Pop39cf4802008-05-09 21:57:18 +02001118 CONFIG_ATMEL_LCD:
1119
1120 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1121
wdenkfd3103b2003-11-25 16:55:19 +00001122 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001123
wdenkfd3103b2003-11-25 16:55:19 +00001124 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001125
wdenkfd3103b2003-11-25 16:55:19 +00001126 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001127
wdenkfd3103b2003-11-25 16:55:19 +00001128 NEC NL6448BC20-08. 6.5", 640x480.
1129 Active, color, single scan.
1130
1131 CONFIG_NEC_NL6448BC33_54
1132
1133 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001134 Active, color, single scan.
1135
1136 CONFIG_SHARP_16x9
1137
1138 Sharp 320x240. Active, color, single scan.
1139 It isn't 16x9, and I am not sure what it is.
1140
1141 CONFIG_SHARP_LQ64D341
1142
1143 Sharp LQ64D341 display, 640x480.
1144 Active, color, single scan.
1145
1146 CONFIG_HLD1045
1147
1148 HLD1045 display, 640x480.
1149 Active, color, single scan.
1150
1151 CONFIG_OPTREX_BW
1152
1153 Optrex CBL50840-2 NF-FW 99 22 M5
1154 or
1155 Hitachi LMG6912RPFC-00T
1156 or
1157 Hitachi SP14Q002
1158
1159 320x240. Black & white.
1160
1161 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001162 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001163
wdenk7152b1d2003-09-05 23:19:14 +00001164- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001165
wdenk8bde7f72003-06-27 21:31:46 +00001166 If this option is set, the environment is checked for
1167 a variable "splashimage". If found, the usual display
1168 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001169 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001170 specified in "splashimage" is loaded instead. The
1171 console is redirected to the "nulldev", too. This
1172 allows for a "silent" boot where a splash screen is
1173 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001174
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001175 CONFIG_SPLASH_SCREEN_ALIGN
1176
1177 If this option is set the splash image can be freely positioned
1178 on the screen. Environment variable "splashpos" specifies the
1179 position as "x,y". If a positive number is given it is used as
1180 number of pixel from left/top. If a negative number is given it
1181 is used as number of pixel from right/bottom. You can also
1182 specify 'm' for centering the image.
1183
1184 Example:
1185 setenv splashpos m,m
1186 => image at center of screen
1187
1188 setenv splashpos 30,20
1189 => image at x = 30 and y = 20
1190
1191 setenv splashpos -10,m
1192 => vertically centered image
1193 at x = dspWidth - bmpWidth - 9
1194
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001195- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1196
1197 If this option is set, additionally to standard BMP
1198 images, gzipped BMP images can be displayed via the
1199 splashscreen support or the bmp command.
1200
Anatolij Gustschind5011762010-03-15 14:50:25 +01001201- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1202
1203 If this option is set, 8-bit RLE compressed BMP images
1204 can be displayed via the splashscreen support or the
1205 bmp command.
1206
wdenkc29fdfc2003-08-29 20:57:53 +00001207- Compression support:
1208 CONFIG_BZIP2
1209
1210 If this option is set, support for bzip2 compressed
1211 images is included. If not, only uncompressed and gzip
1212 compressed images are supported.
1213
wdenk42d1f032003-10-15 23:53:47 +00001214 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001215 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001216 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001217
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001218 CONFIG_LZMA
1219
1220 If this option is set, support for lzma compressed
1221 images is included.
1222
1223 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1224 requires an amount of dynamic memory that is given by the
1225 formula:
1226
1227 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1228
1229 Where lc and lp stand for, respectively, Literal context bits
1230 and Literal pos bits.
1231
1232 This value is upper-bounded by 14MB in the worst case. Anyway,
1233 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1234 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1235 a very small buffer.
1236
1237 Use the lzmainfo tool to determinate the lc and lp values and
1238 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001239 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001240
wdenk17ea1172004-06-06 21:51:03 +00001241- MII/PHY support:
1242 CONFIG_PHY_ADDR
1243
1244 The address of PHY on MII bus.
1245
1246 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1247
1248 The clock frequency of the MII bus
1249
1250 CONFIG_PHY_GIGE
1251
1252 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001253 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001254
1255 CONFIG_PHY_RESET_DELAY
1256
1257 Some PHY like Intel LXT971A need extra delay after
1258 reset before any MII register access is possible.
1259 For such PHY, set this option to the usec delay
1260 required. (minimum 300usec for LXT971A)
1261
1262 CONFIG_PHY_CMD_DELAY (ppc4xx)
1263
1264 Some PHY like Intel LXT971A need extra delay after
1265 command issued before MII status register can be read
1266
wdenkc6097192002-11-03 00:24:07 +00001267- Ethernet address:
1268 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001269 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001270 CONFIG_ETH2ADDR
1271 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001272 CONFIG_ETH4ADDR
1273 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001274
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001275 Define a default value for Ethernet address to use
1276 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001277 is not determined automatically.
1278
1279- IP address:
1280 CONFIG_IPADDR
1281
1282 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001283 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001284 determined through e.g. bootp.
1285
1286- Server IP address:
1287 CONFIG_SERVERIP
1288
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001289 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001290 server to contact when using the "tftboot" command.
1291
Robin Getz97cfe862009-07-21 12:15:28 -04001292 CONFIG_KEEP_SERVERADDR
1293
1294 Keeps the server's MAC address, in the env 'serveraddr'
1295 for passing to bootargs (like Linux's netconsole option)
1296
David Updegraff53a5c422007-06-11 10:41:07 -05001297- Multicast TFTP Mode:
1298 CONFIG_MCAST_TFTP
1299
1300 Defines whether you want to support multicast TFTP as per
1301 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001302 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001303 driver in use must provide a function: mcast() to join/leave a
1304 multicast group.
1305
1306 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001307- BOOTP Recovery Mode:
1308 CONFIG_BOOTP_RANDOM_DELAY
1309
1310 If you have many targets in a network that try to
1311 boot using BOOTP, you may want to avoid that all
1312 systems send out BOOTP requests at precisely the same
1313 moment (which would happen for instance at recovery
1314 from a power failure, when all systems will try to
1315 boot, thus flooding the BOOTP server. Defining
1316 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1317 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001318 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001319
1320 1st BOOTP request: delay 0 ... 1 sec
1321 2nd BOOTP request: delay 0 ... 2 sec
1322 3rd BOOTP request: delay 0 ... 4 sec
1323 4th and following
1324 BOOTP requests: delay 0 ... 8 sec
1325
stroesefe389a82003-08-28 14:17:32 +00001326- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001327 You can fine tune the DHCP functionality by defining
1328 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001329
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001330 CONFIG_BOOTP_SUBNETMASK
1331 CONFIG_BOOTP_GATEWAY
1332 CONFIG_BOOTP_HOSTNAME
1333 CONFIG_BOOTP_NISDOMAIN
1334 CONFIG_BOOTP_BOOTPATH
1335 CONFIG_BOOTP_BOOTFILESIZE
1336 CONFIG_BOOTP_DNS
1337 CONFIG_BOOTP_DNS2
1338 CONFIG_BOOTP_SEND_HOSTNAME
1339 CONFIG_BOOTP_NTPSERVER
1340 CONFIG_BOOTP_TIMEOFFSET
1341 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001342
Wilson Callan5d110f02007-07-28 10:56:13 -04001343 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1344 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001345
1346 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1347 serverip from a DHCP server, it is possible that more
1348 than one DNS serverip is offered to the client.
1349 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1350 serverip will be stored in the additional environment
1351 variable "dnsip2". The first DNS serverip is always
1352 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001353 is defined.
stroesefe389a82003-08-28 14:17:32 +00001354
1355 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1356 to do a dynamic update of a DNS server. To do this, they
1357 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001358 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001359 of the "hostname" environment variable is passed as
1360 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001361
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001362 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1363
1364 A 32bit value in microseconds for a delay between
1365 receiving a "DHCP Offer" and sending the "DHCP Request".
1366 This fixes a problem with certain DHCP servers that don't
1367 respond 100% of the time to a "DHCP request". E.g. On an
1368 AT91RM9200 processor running at 180MHz, this delay needed
1369 to be *at least* 15,000 usec before a Windows Server 2003
1370 DHCP server would reply 100% of the time. I recommend at
1371 least 50,000 usec to be safe. The alternative is to hope
1372 that one of the retries will be successful but note that
1373 the DHCP timeout and retry process takes a longer than
1374 this delay.
1375
wdenka3d991b2004-04-15 21:48:45 +00001376 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001377 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001378
1379 The device id used in CDP trigger frames.
1380
1381 CONFIG_CDP_DEVICE_ID_PREFIX
1382
1383 A two character string which is prefixed to the MAC address
1384 of the device.
1385
1386 CONFIG_CDP_PORT_ID
1387
1388 A printf format string which contains the ascii name of
1389 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001390 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001391
1392 CONFIG_CDP_CAPABILITIES
1393
1394 A 32bit integer which indicates the device capabilities;
1395 0x00000010 for a normal host which does not forwards.
1396
1397 CONFIG_CDP_VERSION
1398
1399 An ascii string containing the version of the software.
1400
1401 CONFIG_CDP_PLATFORM
1402
1403 An ascii string containing the name of the platform.
1404
1405 CONFIG_CDP_TRIGGER
1406
1407 A 32bit integer sent on the trigger.
1408
1409 CONFIG_CDP_POWER_CONSUMPTION
1410
1411 A 16bit integer containing the power consumption of the
1412 device in .1 of milliwatts.
1413
1414 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1415
1416 A byte containing the id of the VLAN.
1417
wdenkc6097192002-11-03 00:24:07 +00001418- Status LED: CONFIG_STATUS_LED
1419
1420 Several configurations allow to display the current
1421 status using a LED. For instance, the LED will blink
1422 fast while running U-Boot code, stop blinking as
1423 soon as a reply to a BOOTP request was received, and
1424 start blinking slow once the Linux kernel is running
1425 (supported by a status LED driver in the Linux
1426 kernel). Defining CONFIG_STATUS_LED enables this
1427 feature in U-Boot.
1428
1429- CAN Support: CONFIG_CAN_DRIVER
1430
1431 Defining CONFIG_CAN_DRIVER enables CAN driver support
1432 on those systems that support this (optional)
1433 feature, like the TQM8xxL modules.
1434
1435- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1436
wdenkb37c7e52003-06-30 16:24:52 +00001437 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001438 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001439 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001440
wdenk945af8d2003-07-16 21:53:01 +00001441 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001442 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001443 CONFIG_COMMANDS) and communicate with i2c based realtime
1444 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001445 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001446
Ben Warrenbb99ad62006-09-07 16:50:54 -04001447 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001448
wdenk945af8d2003-07-16 21:53:01 +00001449 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001450 bit-banging) driver instead of CPM or similar hardware
1451 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001452
wdenk945af8d2003-07-16 21:53:01 +00001453 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001454 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001455
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001456 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001457 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001458 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001459 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001460
Peter Tyser8d321b82010-04-12 22:28:21 -05001461 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001462 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001463 and so its address should therefore be cleared to 0 (See,
1464 eg, MPC823e User's Manual p.16-473). So, set
1465 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001466
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001467 CONFIG_SYS_I2C_INIT_MPC5XXX
1468
1469 When a board is reset during an i2c bus transfer
1470 chips might think that the current transfer is still
1471 in progress. Reset the slave devices by sending start
1472 commands until the slave device responds.
1473
wdenk945af8d2003-07-16 21:53:01 +00001474 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001475
1476 If you use the software i2c interface (CONFIG_SOFT_I2C)
1477 then the following macros need to be defined (examples are
1478 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001479
1480 I2C_INIT
1481
wdenkb37c7e52003-06-30 16:24:52 +00001482 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001483 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001484
wdenkba56f622004-02-06 23:19:44 +00001485 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001486
wdenkc6097192002-11-03 00:24:07 +00001487 I2C_PORT
1488
wdenk43d96162003-03-06 00:02:04 +00001489 (Only for MPC8260 CPU). The I/O port to use (the code
1490 assumes both bits are on the same port). Valid values
1491 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001492
1493 I2C_ACTIVE
1494
1495 The code necessary to make the I2C data line active
1496 (driven). If the data line is open collector, this
1497 define can be null.
1498
wdenkb37c7e52003-06-30 16:24:52 +00001499 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1500
wdenkc6097192002-11-03 00:24:07 +00001501 I2C_TRISTATE
1502
1503 The code necessary to make the I2C data line tri-stated
1504 (inactive). If the data line is open collector, this
1505 define can be null.
1506
wdenkb37c7e52003-06-30 16:24:52 +00001507 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1508
wdenkc6097192002-11-03 00:24:07 +00001509 I2C_READ
1510
1511 Code that returns TRUE if the I2C data line is high,
1512 FALSE if it is low.
1513
wdenkb37c7e52003-06-30 16:24:52 +00001514 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1515
wdenkc6097192002-11-03 00:24:07 +00001516 I2C_SDA(bit)
1517
1518 If <bit> is TRUE, sets the I2C data line high. If it
1519 is FALSE, it clears it (low).
1520
wdenkb37c7e52003-06-30 16:24:52 +00001521 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001522 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001523 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001524
wdenkc6097192002-11-03 00:24:07 +00001525 I2C_SCL(bit)
1526
1527 If <bit> is TRUE, sets the I2C clock line high. If it
1528 is FALSE, it clears it (low).
1529
wdenkb37c7e52003-06-30 16:24:52 +00001530 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001531 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001532 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001533
wdenkc6097192002-11-03 00:24:07 +00001534 I2C_DELAY
1535
1536 This delay is invoked four times per clock cycle so this
1537 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001538 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001539 like:
1540
wdenkb37c7e52003-06-30 16:24:52 +00001541 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001542
Mike Frysinger793b5722010-07-21 13:38:02 -04001543 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1544
1545 If your arch supports the generic GPIO framework (asm/gpio.h),
1546 then you may alternatively define the two GPIOs that are to be
1547 used as SCL / SDA. Any of the previous I2C_xxx macros will
1548 have GPIO-based defaults assigned to them as appropriate.
1549
1550 You should define these to the GPIO value as given directly to
1551 the generic GPIO functions.
1552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001553 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001554
wdenk8bde7f72003-06-27 21:31:46 +00001555 When a board is reset during an i2c bus transfer
1556 chips might think that the current transfer is still
1557 in progress. On some boards it is possible to access
1558 the i2c SCLK line directly, either by using the
1559 processor pin as a GPIO or by having a second pin
1560 connected to the bus. If this option is defined a
1561 custom i2c_init_board() routine in boards/xxx/board.c
1562 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001563
Richard Retanubun26a33502010-04-12 15:08:17 -04001564 CONFIG_SYS_I2C_BOARD_LATE_INIT
1565
1566 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1567 defined a custom i2c_board_late_init() routine in
1568 boards/xxx/board.c is run AFTER the operations in i2c_init()
1569 is completed. This callpoint can be used to unreset i2c bus
1570 using CPU i2c controller register accesses for CPUs whose i2c
1571 controller provide such a method. It is called at the end of
1572 i2c_init() to allow i2c_init operations to setup the i2c bus
1573 controller on the CPU (e.g. setting bus speed & slave address).
1574
wdenk17ea1172004-06-06 21:51:03 +00001575 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1576
1577 This option enables configuration of bi_iic_fast[] flags
1578 in u-boot bd_info structure based on u-boot environment
1579 variable "i2cfast". (see also i2cfast)
1580
Ben Warrenbb99ad62006-09-07 16:50:54 -04001581 CONFIG_I2C_MULTI_BUS
1582
1583 This option allows the use of multiple I2C buses, each of which
1584 must have a controller. At any point in time, only one bus is
1585 active. To switch to a different bus, use the 'i2c dev' command.
1586 Note that bus numbering is zero-based.
1587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001588 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001589
1590 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001591 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1592 is set, specify a list of bus-device pairs. Otherwise, specify
1593 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001594
1595 e.g.
1596 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001597 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001598
1599 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1600
1601 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001602 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001603
1604 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1605
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001606 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001607
1608 If defined, then this indicates the I2C bus number for DDR SPD.
1609 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001611 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001612
1613 If defined, then this indicates the I2C bus number for the RTC.
1614 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001616 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001617
1618 If defined, then this indicates the I2C bus number for the DTT.
1619 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001621 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001622
1623 If defined, specifies the I2C address of the DTT device.
1624 If not defined, then U-Boot uses predefined value for
1625 specified DTT device.
1626
Timur Tabibe5e6182006-11-03 19:15:00 -06001627 CONFIG_FSL_I2C
1628
1629 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001630 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001631
Heiko Schocher67b23a32008-10-15 09:39:47 +02001632 CONFIG_I2C_MUX
1633
1634 Define this option if you have I2C devices reached over 1 .. n
1635 I2C Muxes like the pca9544a. This option addes a new I2C
1636 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1637 new I2C Bus to the existing I2C Busses. If you select the
1638 new Bus with "i2c dev", u-bbot sends first the commandos for
1639 the muxes to activate this new "bus".
1640
1641 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1642 feature!
1643
1644 Example:
1645 Adding a new I2C Bus reached over 2 pca9544a muxes
1646 The First mux with address 70 and channel 6
1647 The Second mux with address 71 and channel 4
1648
1649 => i2c bus pca9544a:70:6:pca9544a:71:4
1650
1651 Use the "i2c bus" command without parameter, to get a list
1652 of I2C Busses with muxes:
1653
1654 => i2c bus
1655 Busses reached over muxes:
1656 Bus ID: 2
1657 reached over Mux(es):
1658 pca9544a@70 ch: 4
1659 Bus ID: 3
1660 reached over Mux(es):
1661 pca9544a@70 ch: 6
1662 pca9544a@71 ch: 4
1663 =>
1664
1665 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1666 u-boot sends First the Commando to the mux@70 to enable
1667 channel 6, and then the Commando to the mux@71 to enable
1668 the channel 4.
1669
1670 After that, you can use the "normal" i2c commands as
1671 usual, to communicate with your I2C devices behind
1672 the 2 muxes.
1673
1674 This option is actually implemented for the bitbanging
1675 algorithm in common/soft_i2c.c and for the Hardware I2C
1676 Bus on the MPC8260. But it should be not so difficult
1677 to add this option to other architectures.
1678
Andrew Dyer2ac69852008-12-29 17:36:01 -06001679 CONFIG_SOFT_I2C_READ_REPEATED_START
1680
1681 defining this will force the i2c_read() function in
1682 the soft_i2c driver to perform an I2C repeated start
1683 between writing the address pointer and reading the
1684 data. If this define is omitted the default behaviour
1685 of doing a stop-start sequence will be used. Most I2C
1686 devices can use either method, but some require one or
1687 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001688
wdenkc6097192002-11-03 00:24:07 +00001689- SPI Support: CONFIG_SPI
1690
1691 Enables SPI driver (so far only tested with
1692 SPI EEPROM, also an instance works with Crystal A/D and
1693 D/As on the SACSng board)
1694
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001695 CONFIG_SH_SPI
1696
1697 Enables the driver for SPI controller on SuperH. Currently
1698 only SH7757 is supported.
1699
wdenkc6097192002-11-03 00:24:07 +00001700 CONFIG_SPI_X
1701
1702 Enables extended (16-bit) SPI EEPROM addressing.
1703 (symmetrical to CONFIG_I2C_X)
1704
1705 CONFIG_SOFT_SPI
1706
wdenk43d96162003-03-06 00:02:04 +00001707 Enables a software (bit-bang) SPI driver rather than
1708 using hardware support. This is a general purpose
1709 driver that only requires three general I/O port pins
1710 (two outputs, one input) to function. If this is
1711 defined, the board configuration must define several
1712 SPI configuration items (port pins to use, etc). For
1713 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001714
Ben Warren04a9e112008-01-16 22:37:35 -05001715 CONFIG_HARD_SPI
1716
1717 Enables a hardware SPI driver for general-purpose reads
1718 and writes. As with CONFIG_SOFT_SPI, the board configuration
1719 must define a list of chip-select function pointers.
1720 Currently supported on some MPC8xxx processors. For an
1721 example, see include/configs/mpc8349emds.h.
1722
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001723 CONFIG_MXC_SPI
1724
1725 Enables the driver for the SPI controllers on i.MX and MXC
1726 SoCs. Currently only i.MX31 is supported.
1727
Matthias Fuchs01335022007-12-27 17:12:34 +01001728- FPGA Support: CONFIG_FPGA
1729
1730 Enables FPGA subsystem.
1731
1732 CONFIG_FPGA_<vendor>
1733
1734 Enables support for specific chip vendors.
1735 (ALTERA, XILINX)
1736
1737 CONFIG_FPGA_<family>
1738
1739 Enables support for FPGA family.
1740 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1741
1742 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001743
wdenk43d96162003-03-06 00:02:04 +00001744 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001746 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001747
wdenk8bde7f72003-06-27 21:31:46 +00001748 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001750 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001751
wdenk43d96162003-03-06 00:02:04 +00001752 Enable checks on FPGA configuration interface busy
1753 status by the configuration function. This option
1754 will require a board or device specific function to
1755 be written.
wdenkc6097192002-11-03 00:24:07 +00001756
1757 CONFIG_FPGA_DELAY
1758
1759 If defined, a function that provides delays in the FPGA
1760 configuration driver.
1761
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001762 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001763 Allow Control-C to interrupt FPGA configuration
1764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001765 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001766
wdenk43d96162003-03-06 00:02:04 +00001767 Check for configuration errors during FPGA bitfile
1768 loading. For example, abort during Virtex II
1769 configuration if the INIT_B line goes low (which
1770 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001771
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001772 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001773
wdenk43d96162003-03-06 00:02:04 +00001774 Maximum time to wait for the INIT_B line to deassert
1775 after PROB_B has been deasserted during a Virtex II
1776 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001777 ms.
wdenkc6097192002-11-03 00:24:07 +00001778
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001779 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001780
wdenk43d96162003-03-06 00:02:04 +00001781 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001782 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001784 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001785
wdenk43d96162003-03-06 00:02:04 +00001786 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001787 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001788
1789- Configuration Management:
1790 CONFIG_IDENT_STRING
1791
wdenk43d96162003-03-06 00:02:04 +00001792 If defined, this string will be added to the U-Boot
1793 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001794
1795- Vendor Parameter Protection:
1796
wdenk43d96162003-03-06 00:02:04 +00001797 U-Boot considers the values of the environment
1798 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001799 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001800 are set once by the board vendor / manufacturer, and
1801 protects these variables from casual modification by
1802 the user. Once set, these variables are read-only,
1803 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001804 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001805
1806 If CONFIG_ENV_OVERWRITE is #defined in your config
1807 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001808 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001809 these parameters.
1810
1811 Alternatively, if you #define _both_ CONFIG_ETHADDR
1812 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001813 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001814 which can be changed exactly ONCE by the user. [The
1815 serial# is unaffected by this, i. e. it remains
1816 read-only.]
1817
1818- Protected RAM:
1819 CONFIG_PRAM
1820
1821 Define this variable to enable the reservation of
1822 "protected RAM", i. e. RAM which is not overwritten
1823 by U-Boot. Define CONFIG_PRAM to hold the number of
1824 kB you want to reserve for pRAM. You can overwrite
1825 this default value by defining an environment
1826 variable "pram" to the number of kB you want to
1827 reserve. Note that the board info structure will
1828 still show the full amount of RAM. If pRAM is
1829 reserved, a new environment variable "mem" will
1830 automatically be defined to hold the amount of
1831 remaining RAM in a form that can be passed as boot
1832 argument to Linux, for instance like that:
1833
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001834 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001835 saveenv
1836
1837 This way you can tell Linux not to use this memory,
1838 either, which results in a memory region that will
1839 not be affected by reboots.
1840
1841 *WARNING* If your board configuration uses automatic
1842 detection of the RAM size, you must make sure that
1843 this memory test is non-destructive. So far, the
1844 following board configurations are known to be
1845 "pRAM-clean":
1846
1847 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1848 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001849 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001850
1851- Error Recovery:
1852 CONFIG_PANIC_HANG
1853
1854 Define this variable to stop the system in case of a
1855 fatal error, so that you have to reset it manually.
1856 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001857 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001858 automatically as fast as possible, but it may be
1859 useful during development since you can try to debug
1860 the conditions that lead to the situation.
1861
1862 CONFIG_NET_RETRY_COUNT
1863
wdenk43d96162003-03-06 00:02:04 +00001864 This variable defines the number of retries for
1865 network operations like ARP, RARP, TFTP, or BOOTP
1866 before giving up the operation. If not defined, a
1867 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001868
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001869 CONFIG_ARP_TIMEOUT
1870
1871 Timeout waiting for an ARP reply in milliseconds.
1872
wdenkc6097192002-11-03 00:24:07 +00001873- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001874 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001875
1876 Enable auto completion of commands using TAB.
1877
Wolfgang Denka9398e02006-11-27 15:32:42 +01001878 Note that this feature has NOT been implemented yet
1879 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001880
1881
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001882 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001883
1884 Define this variable to enable the "hush" shell (from
1885 Busybox) as command line interpreter, thus enabling
1886 powerful command line syntax like
1887 if...then...else...fi conditionals or `&&' and '||'
1888 constructs ("shell scripts").
1889
1890 If undefined, you get the old, much simpler behaviour
1891 with a somewhat smaller memory footprint.
1892
1893
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001894 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001895
1896 This defines the secondary prompt string, which is
1897 printed when the command interpreter needs more input
1898 to complete a command. Usually "> ".
1899
1900 Note:
1901
wdenk8bde7f72003-06-27 21:31:46 +00001902 In the current implementation, the local variables
1903 space and global environment variables space are
1904 separated. Local variables are those you define by
1905 simply typing `name=value'. To access a local
1906 variable later on, you have write `$name' or
1907 `${name}'; to execute the contents of a variable
1908 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001909
wdenk43d96162003-03-06 00:02:04 +00001910 Global environment variables are those you use
1911 setenv/printenv to work with. To run a command stored
1912 in such a variable, you need to use the run command,
1913 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001914
1915 To store commands and special characters in a
1916 variable, please use double quotation marks
1917 surrounding the whole text of the variable, instead
1918 of the backslashes before semicolons and special
1919 symbols.
1920
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001921- Commandline Editing and History:
1922 CONFIG_CMDLINE_EDITING
1923
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001924 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001925 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001926
wdenka8c7c702003-12-06 19:49:23 +00001927- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001928 CONFIG_EXTRA_ENV_SETTINGS
1929
wdenk43d96162003-03-06 00:02:04 +00001930 Define this to contain any number of null terminated
1931 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001932 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001933
wdenk43d96162003-03-06 00:02:04 +00001934 For example, place something like this in your
1935 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001936
1937 #define CONFIG_EXTRA_ENV_SETTINGS \
1938 "myvar1=value1\0" \
1939 "myvar2=value2\0"
1940
wdenk43d96162003-03-06 00:02:04 +00001941 Warning: This method is based on knowledge about the
1942 internal format how the environment is stored by the
1943 U-Boot code. This is NOT an official, exported
1944 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001945 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001946 You better know what you are doing here.
1947
wdenk43d96162003-03-06 00:02:04 +00001948 Note: overly (ab)use of the default environment is
1949 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001950 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001951 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001952
wdenka8c7c702003-12-06 19:49:23 +00001953- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001954 CONFIG_HAS_DATAFLASH
1955
wdenk8bde7f72003-06-27 21:31:46 +00001956 Defining this option enables DataFlash features and
1957 allows to read/write in Dataflash via the standard
1958 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001959
wdenk3f85ce22004-02-23 16:11:30 +00001960- SystemACE Support:
1961 CONFIG_SYSTEMACE
1962
1963 Adding this option adds support for Xilinx SystemACE
1964 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001965 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001966 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001967
1968 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001969 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001970
1971 When SystemACE support is added, the "ace" device type
1972 becomes available to the fat commands, i.e. fatls.
1973
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001974- TFTP Fixed UDP Port:
1975 CONFIG_TFTP_PORT
1976
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001977 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001978 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001979 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001980 number generator is used.
1981
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001982 Also, the environment variable tftpdstp is used to supply
1983 the TFTP UDP destination port value. If tftpdstp isn't
1984 defined, the normal port 69 is used.
1985
1986 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001987 blindly start the TFTP transfer using the pre-configured
1988 target IP address and UDP port. This has the effect of
1989 "punching through" the (Windows XP) firewall, allowing
1990 the remainder of the TFTP transfer to proceed normally.
1991 A better solution is to properly configure the firewall,
1992 but sometimes that is not allowed.
1993
wdenka8c7c702003-12-06 19:49:23 +00001994- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001995 CONFIG_SHOW_BOOT_PROGRESS
1996
wdenk43d96162003-03-06 00:02:04 +00001997 Defining this option allows to add some board-
1998 specific code (calling a user-provided function
1999 "show_boot_progress(int)") that enables you to show
2000 the system's boot progress on some display (for
2001 example, some LED's) on your board. At the moment,
2002 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002003
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002004- Standalone program support:
2005 CONFIG_STANDALONE_LOAD_ADDR
2006
2007 This option allows to define board specific values
2008 for the address where standalone program gets loaded,
2009 thus overwriting the architecutre dependent default
2010 settings.
2011
Minkyu Kangd32a1a42011-04-24 22:22:34 +00002012- Frame Buffer Address:
2013 CONFIG_FB_ADDR
2014
2015 Define CONFIG_FB_ADDR if you want to use specific address for
2016 frame buffer.
2017 Then system will reserve the frame buffer address to defined address
2018 instead of lcd_setmem (this function grab the memory for frame buffer
2019 by panel's size).
2020
2021 Please see board_init_f function.
2022
2023 If you want this config option then,
2024 please define it at your board config file
2025
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002026Legacy uImage format:
2027
wdenkc6097192002-11-03 00:24:07 +00002028 Arg Where When
2029 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002030 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002031 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002032 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002033 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002034 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002035 4 common/cmd_bootm.c Image data has correct checksum
2036 -4 common/cmd_bootm.c Image is for unsupported architecture
2037 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002038 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002039 6 common/cmd_bootm.c Image Type check OK
2040 -6 common/cmd_bootm.c gunzip uncompression error
2041 -7 common/cmd_bootm.c Unimplemented compression type
2042 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002043 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002044 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002045
2046 9 common/image.c Start initial ramdisk verification
2047 -10 common/image.c Ramdisk header has bad magic number
2048 -11 common/image.c Ramdisk header has bad checksum
2049 10 common/image.c Ramdisk header is OK
2050 -12 common/image.c Ramdisk data has bad checksum
2051 11 common/image.c Ramdisk data has correct checksum
2052 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002053 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002054 13 common/image.c Start multifile image verification
2055 14 common/image.c No initial ramdisk, no multifile, continue.
2056
Peter Tyserea0364f2010-04-12 22:28:04 -05002057 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002058
Stefan Roesea47a12b2010-04-15 16:07:28 +02002059 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002060 -31 post/post.c POST test failed, detected by post_output_backlog()
2061 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002062
Heiko Schocher566a4942007-06-22 19:11:54 +02002063 34 common/cmd_doc.c before loading a Image from a DOC device
2064 -35 common/cmd_doc.c Bad usage of "doc" command
2065 35 common/cmd_doc.c correct usage of "doc" command
2066 -36 common/cmd_doc.c No boot device
2067 36 common/cmd_doc.c correct boot device
2068 -37 common/cmd_doc.c Unknown Chip ID on boot device
2069 37 common/cmd_doc.c correct chip ID found, device available
2070 -38 common/cmd_doc.c Read Error on boot device
2071 38 common/cmd_doc.c reading Image header from DOC device OK
2072 -39 common/cmd_doc.c Image header has bad magic number
2073 39 common/cmd_doc.c Image header has correct magic number
2074 -40 common/cmd_doc.c Error reading Image from DOC device
2075 40 common/cmd_doc.c Image header has correct magic number
2076 41 common/cmd_ide.c before loading a Image from a IDE device
2077 -42 common/cmd_ide.c Bad usage of "ide" command
2078 42 common/cmd_ide.c correct usage of "ide" command
2079 -43 common/cmd_ide.c No boot device
2080 43 common/cmd_ide.c boot device found
2081 -44 common/cmd_ide.c Device not available
2082 44 common/cmd_ide.c Device available
2083 -45 common/cmd_ide.c wrong partition selected
2084 45 common/cmd_ide.c partition selected
2085 -46 common/cmd_ide.c Unknown partition table
2086 46 common/cmd_ide.c valid partition table found
2087 -47 common/cmd_ide.c Invalid partition type
2088 47 common/cmd_ide.c correct partition type
2089 -48 common/cmd_ide.c Error reading Image Header on boot device
2090 48 common/cmd_ide.c reading Image Header from IDE device OK
2091 -49 common/cmd_ide.c Image header has bad magic number
2092 49 common/cmd_ide.c Image header has correct magic number
2093 -50 common/cmd_ide.c Image header has bad checksum
2094 50 common/cmd_ide.c Image header has correct checksum
2095 -51 common/cmd_ide.c Error reading Image from IDE device
2096 51 common/cmd_ide.c reading Image from IDE device OK
2097 52 common/cmd_nand.c before loading a Image from a NAND device
2098 -53 common/cmd_nand.c Bad usage of "nand" command
2099 53 common/cmd_nand.c correct usage of "nand" command
2100 -54 common/cmd_nand.c No boot device
2101 54 common/cmd_nand.c boot device found
2102 -55 common/cmd_nand.c Unknown Chip ID on boot device
2103 55 common/cmd_nand.c correct chip ID found, device available
2104 -56 common/cmd_nand.c Error reading Image Header on boot device
2105 56 common/cmd_nand.c reading Image Header from NAND device OK
2106 -57 common/cmd_nand.c Image header has bad magic number
2107 57 common/cmd_nand.c Image header has correct magic number
2108 -58 common/cmd_nand.c Error reading Image from NAND device
2109 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002110
Heiko Schocher566a4942007-06-22 19:11:54 +02002111 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002112
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002113 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002114 -64 net/eth.c no Ethernet found.
2115 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002116
Heiko Schocher566a4942007-06-22 19:11:54 +02002117 -80 common/cmd_net.c usage wrong
2118 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002119 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002120 81 common/cmd_net.c NetLoop() back without error
2121 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2122 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002123 83 common/cmd_net.c running "source" command
2124 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002125 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002126
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002127FIT uImage format:
2128
2129 Arg Where When
2130 100 common/cmd_bootm.c Kernel FIT Image has correct format
2131 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2132 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2133 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2134 102 common/cmd_bootm.c Kernel unit name specified
2135 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002136 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002137 104 common/cmd_bootm.c Got kernel subimage node offset
2138 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2139 105 common/cmd_bootm.c Kernel subimage hash verification OK
2140 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2141 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002142 -106 common/cmd_bootm.c Kernel subimage has wrong type
2143 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002144 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2145 108 common/cmd_bootm.c Got kernel subimage data/size
2146 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2147 -109 common/cmd_bootm.c Can't get kernel subimage type
2148 -110 common/cmd_bootm.c Can't get kernel subimage comp
2149 -111 common/cmd_bootm.c Can't get kernel subimage os
2150 -112 common/cmd_bootm.c Can't get kernel subimage load address
2151 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2152
2153 120 common/image.c Start initial ramdisk verification
2154 -120 common/image.c Ramdisk FIT image has incorrect format
2155 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002156 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002157 -122 common/image.c Can't get configuration for ramdisk subimage
2158 123 common/image.c Ramdisk unit name specified
2159 -124 common/image.c Can't get ramdisk subimage node offset
2160 125 common/image.c Got ramdisk subimage node offset
2161 -125 common/image.c Ramdisk subimage hash verification failed
2162 126 common/image.c Ramdisk subimage hash verification OK
2163 -126 common/image.c Ramdisk subimage for unsupported architecture
2164 127 common/image.c Architecture check OK
2165 -127 common/image.c Can't get ramdisk subimage data/size
2166 128 common/image.c Got ramdisk subimage data/size
2167 129 common/image.c Can't get ramdisk load address
2168 -129 common/image.c Got ramdisk load address
2169
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002170 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002171 131 common/cmd_doc.c FIT image format OK
2172
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002173 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002174 141 common/cmd_ide.c FIT image format OK
2175
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002176 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002177 151 common/cmd_nand.c FIT image format OK
2178
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002179- Automatic software updates via TFTP server
2180 CONFIG_UPDATE_TFTP
2181 CONFIG_UPDATE_TFTP_CNT_MAX
2182 CONFIG_UPDATE_TFTP_MSEC_MAX
2183
2184 These options enable and control the auto-update feature;
2185 for a more detailed description refer to doc/README.update.
2186
2187- MTD Support (mtdparts command, UBI support)
2188 CONFIG_MTD_DEVICE
2189
2190 Adds the MTD device infrastructure from the Linux kernel.
2191 Needed for mtdparts command support.
2192
2193 CONFIG_MTD_PARTITIONS
2194
2195 Adds the MTD partitioning infrastructure from the Linux
2196 kernel. Needed for UBI support.
2197
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002198
wdenkc6097192002-11-03 00:24:07 +00002199Modem Support:
2200--------------
2201
wdenk85ec0bc2003-03-31 16:34:49 +00002202[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002203
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002204- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002205 CONFIG_MODEM_SUPPORT
2206
2207- RTS/CTS Flow control enable:
2208 CONFIG_HWFLOW
2209
2210- Modem debug support:
2211 CONFIG_MODEM_SUPPORT_DEBUG
2212
wdenk43d96162003-03-06 00:02:04 +00002213 Enables debugging stuff (char screen[1024], dbg())
2214 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002215
wdenka8c7c702003-12-06 19:49:23 +00002216- Interrupt support (PPC):
2217
wdenkd4ca31c2004-01-02 14:00:00 +00002218 There are common interrupt_init() and timer_interrupt()
2219 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002220 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002221 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002222 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002223 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002224 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002225 specific handling. If board has watchdog / status_led
2226 / other_activity_monitor it works automatically from
2227 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002228
wdenkc6097192002-11-03 00:24:07 +00002229- General:
2230
wdenk43d96162003-03-06 00:02:04 +00002231 In the target system modem support is enabled when a
2232 specific key (key combination) is pressed during
2233 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002234 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002235 board_init(). Currently key_pressed() is a dummy
2236 function, returning 1 and thus enabling modem
2237 initialization.
wdenkc6097192002-11-03 00:24:07 +00002238
wdenk43d96162003-03-06 00:02:04 +00002239 If there are no modem init strings in the
2240 environment, U-Boot proceed to autoboot; the
2241 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002242 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002243
2244 See also: doc/README.Modem
2245
2246
wdenkc6097192002-11-03 00:24:07 +00002247Configuration Settings:
2248-----------------------
2249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002250- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002251 undefine this when you're short of memory.
2252
Peter Tyser2fb26042009-01-27 18:03:12 -06002253- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2254 width of the commands listed in the 'help' command output.
2255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002256- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002257 prompt for user input.
2258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002259- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002261- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002263- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002265- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002266 the application (usually a Linux kernel) when it is
2267 booted
2268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002269- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002270 List of legal baudrate settings for this board.
2271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002272- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002273 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002275- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002276 If the board specific function
2277 extern int overwrite_console (void);
2278 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002279 serial port, else the settings in the environment are used.
2280
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002281- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002282 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002284- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002285 Enable overwrite of previous console environment settings.
2286
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002287- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002288 Begin and End addresses of the area used by the
2289 simple memory test.
2290
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002291- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002292 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002294- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002295 Scratch address used by the alternate memory test
2296 You only need to set this if address zero isn't writeable
2297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002298- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2299 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002300 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002301 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002302 fixing up gd->ram_size the Linux kernel should gets passed
2303 the now "corrected" memory size and won't touch it either.
2304 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002305 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002306 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002307 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002308
2309 This option can be used as a workaround for the 440EPx/GRx
2310 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2311 be touched.
2312
2313 WARNING: Please make sure that this value is a multiple of
2314 the Linux page size (normally 4k). If this is not the case,
2315 then the end address of the Linux memory will be located at a
2316 non page size aligned address and this could cause major
2317 problems.
2318
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002319- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002320 Default load address for network file downloads
2321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002322- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002323 Enable temporary baudrate change while serial download
2324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002325- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002326 Physical start address of SDRAM. _Must_ be 0 here.
2327
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002328- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002329 Physical start address of Motherboard I/O (if using a
2330 Cogent motherboard)
2331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002332- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002333 Physical start address of Flash memory.
2334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002335- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002336 Physical start address of boot monitor code (set by
2337 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002338 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002339 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002341- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002342 Size of memory reserved for monitor code, used to
2343 determine _at_compile_time_ (!) if the environment is
2344 embedded within the U-Boot image, or in a separate
2345 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002347- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002348 Size of DRAM reserved for malloc() use.
2349
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002350- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002351 Normally compressed uImages are limited to an
2352 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002353 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002354 to adjust this setting to your needs.
2355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002356- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002357 Maximum size of memory mapped by the startup code of
2358 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002359 the Linux kernel (bd_info, boot arguments, FDT blob if
2360 used) must be put below this limit, unless "bootm_low"
2361 enviroment variable is defined and non-zero. In such case
2362 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002363 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2364 variable "bootm_mapsize" will override the value of
2365 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2366 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002367
John Rigbyfca43cc2010-10-13 13:57:35 -06002368- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2369 Enable initrd_high functionality. If defined then the
2370 initrd_high feature is enabled and the bootm ramdisk subcommand
2371 is enabled.
2372
2373- CONFIG_SYS_BOOT_GET_CMDLINE:
2374 Enables allocating and saving kernel cmdline in space between
2375 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2376
2377- CONFIG_SYS_BOOT_GET_KBD:
2378 Enables allocating and saving a kernel copy of the bd_info in
2379 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2380
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002381- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002382 Max number of Flash memory banks
2383
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002384- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002385 Max number of sectors on a Flash chip
2386
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002387- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002388 Timeout for Flash erase operations (in ms)
2389
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002390- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002391 Timeout for Flash write operations (in ms)
2392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002393- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002394 Timeout for Flash set sector lock bit operation (in ms)
2395
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002396- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002397 Timeout for Flash clear lock bits operation (in ms)
2398
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002399- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002400 If defined, hardware flash sectors protection is used
2401 instead of U-Boot software protection.
2402
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002403- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002404
2405 Enable TFTP transfers directly to flash memory;
2406 without this option such a download has to be
2407 performed in two steps: (1) download to RAM, and (2)
2408 copy from RAM to flash.
2409
2410 The two-step approach is usually more reliable, since
2411 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002412 the flash, but in some situations (when system RAM is
2413 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002414 downloaded image) this option may be very useful.
2415
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002416- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002417 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002418 common flash structure for storing flash geometry.
2419
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002420- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002421 This option also enables the building of the cfi_flash driver
2422 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002423
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002424- CONFIG_FLASH_CFI_MTD
2425 This option enables the building of the cfi_mtd driver
2426 in the drivers directory. The driver exports CFI flash
2427 to the MTD layer.
2428
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002429- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002430 Use buffered writes to flash.
2431
2432- CONFIG_FLASH_SPANSION_S29WS_N
2433 s29ws-n MirrorBit flash has non-standard addresses for buffered
2434 write commands.
2435
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002436- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002437 If this option is defined, the common CFI flash doesn't
2438 print it's warning upon not recognized FLASH banks. This
2439 is useful, if some of the configured banks are only
2440 optionally available.
2441
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002442- CONFIG_FLASH_SHOW_PROGRESS
2443 If defined (must be an integer), print out countdown
2444 digits and dots. Recommended value: 45 (9..1) for 80
2445 column displays, 15 (3..1) for 40 column displays.
2446
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002447- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002448 Defines the number of Ethernet receive buffers. On some
2449 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002450 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2451 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002452 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002453 Defaults to 4 if not defined.
2454
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002455- CONFIG_ENV_MAX_ENTRIES
2456
Wolfgang Denk071bc922010-10-27 22:48:30 +02002457 Maximum number of entries in the hash table that is used
2458 internally to store the environment settings. The default
2459 setting is supposed to be generous and should work in most
2460 cases. This setting can be used to tune behaviour; see
2461 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002462
wdenkc6097192002-11-03 00:24:07 +00002463The following definitions that deal with the placement and management
2464of environment data (variable area); in general, we support the
2465following configurations:
2466
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002467- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002468
2469 Define this if the environment is in flash memory.
2470
2471 a) The environment occupies one whole flash sector, which is
2472 "embedded" in the text segment with the U-Boot code. This
2473 happens usually with "bottom boot sector" or "top boot
2474 sector" type flash chips, which have several smaller
2475 sectors at the start or the end. For instance, such a
2476 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2477 such a case you would place the environment in one of the
2478 4 kB sectors - with U-Boot code before and after it. With
2479 "top boot sector" type flash chips, you would put the
2480 environment in one of the last sectors, leaving a gap
2481 between U-Boot and the environment.
2482
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002483 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002484
2485 Offset of environment data (variable area) to the
2486 beginning of flash memory; for instance, with bottom boot
2487 type flash chips the second sector can be used: the offset
2488 for this sector is given here.
2489
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002490 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002491
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002492 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002493
2494 This is just another way to specify the start address of
2495 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002496 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002497
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002498 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002499
2500 Size of the sector containing the environment.
2501
2502
2503 b) Sometimes flash chips have few, equal sized, BIG sectors.
2504 In such a case you don't want to spend a whole sector for
2505 the environment.
2506
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002507 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002508
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002509 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002510 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002511 of this flash sector for the environment. This saves
2512 memory for the RAM copy of the environment.
2513
2514 It may also save flash memory if you decide to use this
2515 when your environment is "embedded" within U-Boot code,
2516 since then the remainder of the flash sector could be used
2517 for U-Boot code. It should be pointed out that this is
2518 STRONGLY DISCOURAGED from a robustness point of view:
2519 updating the environment in flash makes it always
2520 necessary to erase the WHOLE sector. If something goes
2521 wrong before the contents has been restored from a copy in
2522 RAM, your target system will be dead.
2523
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002524 - CONFIG_ENV_ADDR_REDUND
2525 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002526
wdenk43d96162003-03-06 00:02:04 +00002527 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002528 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002529 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002530 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002531
2532BE CAREFUL! Any changes to the flash layout, and some changes to the
2533source code will make it necessary to adapt <board>/u-boot.lds*
2534accordingly!
2535
2536
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002537- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002538
2539 Define this if you have some non-volatile memory device
2540 (NVRAM, battery buffered SRAM) which you want to use for the
2541 environment.
2542
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002543 - CONFIG_ENV_ADDR:
2544 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002545
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002546 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002547 want to use for environment. It is assumed that this memory
2548 can just be read and written to, without any special
2549 provision.
2550
2551BE CAREFUL! The first access to the environment happens quite early
2552in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002553console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002554U-Boot will hang.
2555
2556Please note that even with NVRAM we still use a copy of the
2557environment in RAM: we could work on NVRAM directly, but we want to
2558keep settings there always unmodified except somebody uses "saveenv"
2559to save the current settings.
2560
2561
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002562- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002563
2564 Use this if you have an EEPROM or similar serial access
2565 device and a driver for it.
2566
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002567 - CONFIG_ENV_OFFSET:
2568 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002569
2570 These two #defines specify the offset and size of the
2571 environment area within the total memory of your EEPROM.
2572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002573 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002574 If defined, specified the chip address of the EEPROM device.
2575 The default address is zero.
2576
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002577 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002578 If defined, the number of bits used to address bytes in a
2579 single page in the EEPROM device. A 64 byte page, for example
2580 would require six bits.
2581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002582 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002583 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002584 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002586 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002587 The length in bytes of the EEPROM memory array address. Note
2588 that this is NOT the chip address length!
2589
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002590 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002591 EEPROM chips that implement "address overflow" are ones
2592 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2593 address and the extra bits end up in the "chip address" bit
2594 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2595 byte chips.
2596
2597 Note that we consider the length of the address field to
2598 still be one byte because the extra address bits are hidden
2599 in the chip address.
2600
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002601 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002602 The size in bytes of the EEPROM device.
2603
Heiko Schocher548738b2010-01-07 08:55:40 +01002604 - CONFIG_ENV_EEPROM_IS_ON_I2C
2605 define this, if you have I2C and SPI activated, and your
2606 EEPROM, which holds the environment, is on the I2C bus.
2607
2608 - CONFIG_I2C_ENV_EEPROM_BUS
2609 if you have an Environment on an EEPROM reached over
2610 I2C muxes, you can define here, how to reach this
2611 EEPROM. For example:
2612
Wolfgang Denka9046b92010-06-13 17:48:15 +02002613 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002614
2615 EEPROM which holds the environment, is reached over
2616 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002617
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002618- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002619
wdenkd4ca31c2004-01-02 14:00:00 +00002620 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002621 want to use for the environment.
2622
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002623 - CONFIG_ENV_OFFSET:
2624 - CONFIG_ENV_ADDR:
2625 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002626
2627 These three #defines specify the offset and size of the
2628 environment area within the total memory of your DataFlash placed
2629 at the specified address.
2630
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002631- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002632
2633 Define this if you have a NAND device which you want to use
2634 for the environment.
2635
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002636 - CONFIG_ENV_OFFSET:
2637 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002638
2639 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002640 area within the first NAND device. CONFIG_ENV_OFFSET must be
2641 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002642
Scott Woodfdd813d2010-09-17 14:38:37 -05002643 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002644
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002645 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002646 size used to hold a redundant copy of the environment data, so
2647 that there is a valid backup copy in case there is a power failure
2648 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2649 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002650
Scott Woodfdd813d2010-09-17 14:38:37 -05002651 - CONFIG_ENV_RANGE (optional):
2652
2653 Specifies the length of the region in which the environment
2654 can be written. This should be a multiple of the NAND device's
2655 block size. Specifying a range with more erase blocks than
2656 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2657 the range to be avoided.
2658
2659 - CONFIG_ENV_OFFSET_OOB (optional):
2660
2661 Enables support for dynamically retrieving the offset of the
2662 environment from block zero's out-of-band data. The
2663 "nand env.oob" command can be used to record this offset.
2664 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2665 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002666
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002667- CONFIG_NAND_ENV_DST
2668
2669 Defines address in RAM to which the nand_spl code should copy the
2670 environment. If redundant environment is used, it will be copied to
2671 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2672
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002673- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002674
2675 Defines offset to the initial SPI buffer area in DPRAM. The
2676 area is used at an early stage (ROM part) if the environment
2677 is configured to reside in the SPI EEPROM: We need a 520 byte
2678 scratch DPRAM area. It is used between the two initialization
2679 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2680 to be a good choice since it makes it far enough from the
2681 start of the data area as well as from the stack pointer.
2682
Bruce Adlere881cb52007-11-02 13:15:42 -07002683Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002684has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002685created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002686until then to read environment variables.
2687
wdenk85ec0bc2003-03-31 16:34:49 +00002688The environment is protected by a CRC32 checksum. Before the monitor
2689is relocated into RAM, as a result of a bad CRC you will be working
2690with the compiled-in default environment - *silently*!!! [This is
2691necessary, because the first environment variable we need is the
2692"baudrate" setting for the console - if we have a bad CRC, we don't
2693have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002694
2695Note: once the monitor has been relocated, then it will complain if
2696the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002697use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002698
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002699- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002700 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002701
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002702 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002703 also needs to be defined.
2704
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002705- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002706 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002707
Ron Madridf5675aa2009-02-18 14:30:44 -08002708- CONFIG_NS16550_MIN_FUNCTIONS:
2709 Define this if you desire to only have use of the NS16550_init
2710 and NS16550_putc functions for the serial driver located at
2711 drivers/serial/ns16550.c. This option is useful for saving
2712 space for already greatly restricted images, including but not
2713 limited to NAND_SPL configurations.
2714
wdenkc6097192002-11-03 00:24:07 +00002715Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002716---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002718- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002719 Cache Line Size of the CPU.
2720
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002721- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002722 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002723
wdenk42d1f032003-10-15 23:53:47 +00002724 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2725 and RPXsuper) to be able to adjust the position of
2726 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002727
wdenk7f6c2cb2002-11-10 22:06:23 +00002728- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002729 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002730
2731 the default drive number (default value 0)
2732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002734
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002735 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002736 (default value 1)
2737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002738 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002739
wdenk43d96162003-03-06 00:02:04 +00002740 defines the offset of register from address. It
2741 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002742 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002744 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2745 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002746 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002748 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002749 fdc_hw_init() is called at the beginning of the FDC
2750 setup. fdc_hw_init() must be provided by the board
2751 source code. It is used to make hardware dependant
2752 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002753
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002754- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002755 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002756 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002758- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002759
wdenk7152b1d2003-09-05 23:19:14 +00002760 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002761 initial data and stack; please note that this must be
2762 writable memory that is working WITHOUT special
2763 initialization, i. e. you CANNOT use normal RAM which
2764 will become available only after programming the
2765 memory controller and running certain initialization
2766 sequences.
2767
2768 U-Boot uses the following memory types:
2769 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2770 - MPC824X: data cache
2771 - PPC4xx: data cache
2772
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002773- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002774
2775 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002776 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2777 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002778 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002779 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002780 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2781 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2782 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002783
2784 Note:
2785 On the MPC824X (or other systems that use the data
2786 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002787 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002788 point to an otherwise UNUSED address space between
2789 the top of RAM and the start of the PCI space.
2790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002791- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002793- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002794
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002795- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002797- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002798
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002799- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002801- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002804 SDRAM timing
2805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002806- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002807 periodic timer for refresh
2808
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002809- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002811- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2812 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2813 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2814 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002815 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2816
2817- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002818 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2819 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002820 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002822- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2823 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002824 Machine Mode Register and Memory Periodic Timer
2825 Prescaler definitions (SDRAM timing)
2826
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002827- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002828 enable I2C microcode relocation patch (MPC8xx);
2829 define relocation offset in DPRAM [DSP2]
2830
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002831- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002832 enable SMC microcode relocation patch (MPC8xx);
2833 define relocation offset in DPRAM [SMC1]
2834
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002835- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002836 enable SPI microcode relocation patch (MPC8xx);
2837 define relocation offset in DPRAM [SCC4]
2838
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002839- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002840 Use OSCM clock mode on MBX8xx board. Be careful,
2841 wrong setting might damage your board. Read
2842 doc/README.MBX before setting this variable!
2843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002844- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002845 Offset of the bootmode word in DPRAM used by post
2846 (Power On Self Tests). This definition overrides
2847 #define'd default value in commproc.h resp.
2848 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002849
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002850- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2851 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2852 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2853 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2854 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2855 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2856 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2857 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002858 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002859
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002860- CONFIG_PCI_DISABLE_PCIE:
2861 Disable PCI-Express on systems where it is supported but not
2862 required.
2863
Kumar Galaa09b9b62010-12-30 12:09:53 -06002864- CONFIG_SYS_SRIO:
2865 Chip has SRIO or not
2866
2867- CONFIG_SRIO1:
2868 Board has SRIO 1 port available
2869
2870- CONFIG_SRIO2:
2871 Board has SRIO 2 port available
2872
2873- CONFIG_SYS_SRIOn_MEM_VIRT:
2874 Virtual Address of SRIO port 'n' memory region
2875
2876- CONFIG_SYS_SRIOn_MEM_PHYS:
2877 Physical Address of SRIO port 'n' memory region
2878
2879- CONFIG_SYS_SRIOn_MEM_SIZE:
2880 Size of SRIO port 'n' memory region
2881
Ben Warrenbb99ad62006-09-07 16:50:54 -04002882- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002883 Get DDR timing information from an I2C EEPROM. Common
2884 with pluggable memory modules such as SODIMMs
2885
Ben Warrenbb99ad62006-09-07 16:50:54 -04002886 SPD_EEPROM_ADDRESS
2887 I2C address of the SPD EEPROM
2888
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002889- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002890 If SPD EEPROM is on an I2C bus other than the first
2891 one, specify here. Note that the value must resolve
2892 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002893
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002894- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002895 Only for 83xx systems. If specified, then DDR should
2896 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002897
wdenkc26e4542004-04-18 10:13:26 +00002898- CONFIG_ETHER_ON_FEC[12]
2899 Define to enable FEC[12] on a 8xx series processor.
2900
2901- CONFIG_FEC[12]_PHY
2902 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002903 to the given FEC; i. e.
2904 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002905 means that the PHY with address 4 is connected to FEC1
2906
2907 When set to -1, means to probe for first available.
2908
2909- CONFIG_FEC[12]_PHY_NORXERR
2910 The PHY does not have a RXERR line (RMII only).
2911 (so program the FEC to ignore it).
2912
2913- CONFIG_RMII
2914 Enable RMII mode for all FECs.
2915 Note that this is a global option, we can't
2916 have one FEC in standard MII mode and another in RMII mode.
2917
wdenk5cf91d62004-04-23 20:32:05 +00002918- CONFIG_CRC32_VERIFY
2919 Add a verify option to the crc32 command.
2920 The syntax is:
2921
2922 => crc32 -v <address> <count> <crc32>
2923
2924 Where address/count indicate a memory area
2925 and crc32 is the correct crc32 which the
2926 area should have.
2927
wdenk56523f12004-07-11 17:40:54 +00002928- CONFIG_LOOPW
2929 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002930 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002931
stroese7b466642004-12-16 18:46:55 +00002932- CONFIG_MX_CYCLIC
2933 Add the "mdc" and "mwc" memory commands. These are cyclic
2934 "md/mw" commands.
2935 Examples:
2936
wdenkefe2a4d2004-12-16 21:44:03 +00002937 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002938 This command will print 4 bytes (10,11,12,13) each 500 ms.
2939
wdenkefe2a4d2004-12-16 21:44:03 +00002940 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002941 This command will write 12345678 to address 100 all 10 ms.
2942
wdenkefe2a4d2004-12-16 21:44:03 +00002943 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002944 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002945
wdenk8aa1a2d2005-04-04 12:44:11 +00002946- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002947 [ARM only] If this variable is defined, then certain
2948 low level initializations (like setting up the memory
2949 controller) are omitted and/or U-Boot does not
2950 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002951
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002952 Normally this variable MUST NOT be defined. The only
2953 exception is when U-Boot is loaded (to RAM) by some
2954 other boot loader or by a debugger which performs
2955 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002956
Magnus Liljadf812382009-06-13 20:50:00 +02002957- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02002958 Modifies the behaviour of start.S when compiling a loader
2959 that is executed before the actual U-Boot. E.g. when
2960 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002961
Matthias Weisserd8834a12011-03-10 21:36:32 +00002962- CONFIG_USE_ARCH_MEMCPY
2963 CONFIG_USE_ARCH_MEMSET
2964 If these options are used a optimized version of memcpy/memset will
2965 be used if available. These functions may be faster under some
2966 conditions but may increase the binary size.
2967
wdenkc6097192002-11-03 00:24:07 +00002968Building the Software:
2969======================
2970
Wolfgang Denk218ca722008-03-26 10:40:12 +01002971Building U-Boot has been tested in several native build environments
2972and in many different cross environments. Of course we cannot support
2973all possibly existing versions of cross development tools in all
2974(potentially obsolete) versions. In case of tool chain problems we
2975recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2976which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002977
Wolfgang Denk218ca722008-03-26 10:40:12 +01002978If you are not using a native environment, it is assumed that you
2979have GNU cross compiling tools available in your path. In this case,
2980you must set the environment variable CROSS_COMPILE in your shell.
2981Note that no changes to the Makefile or any other source files are
2982necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002983
Wolfgang Denk218ca722008-03-26 10:40:12 +01002984 $ CROSS_COMPILE=ppc_4xx-
2985 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002986
Peter Tyser2f8d3962009-03-13 18:54:51 -05002987Note: If you wish to generate Windows versions of the utilities in
2988 the tools directory you can use the MinGW toolchain
2989 (http://www.mingw.org). Set your HOST tools to the MinGW
2990 toolchain and execute 'make tools'. For example:
2991
2992 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2993
2994 Binaries such as tools/mkimage.exe will be created which can
2995 be executed on computers running Windows.
2996
Wolfgang Denk218ca722008-03-26 10:40:12 +01002997U-Boot is intended to be simple to build. After installing the
2998sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002999is done by typing:
3000
3001 make NAME_config
3002
Wolfgang Denk218ca722008-03-26 10:40:12 +01003003where "NAME_config" is the name of one of the existing configu-
3004rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003005
wdenk2729af92004-05-03 20:45:30 +00003006Note: for some board special configuration names may exist; check if
3007 additional information is available from the board vendor; for
3008 instance, the TQM823L systems are available without (standard)
3009 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003010 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003011
wdenk2729af92004-05-03 20:45:30 +00003012 make TQM823L_config
3013 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003014
wdenk2729af92004-05-03 20:45:30 +00003015 make TQM823L_LCD_config
3016 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003017
wdenk2729af92004-05-03 20:45:30 +00003018 etc.
wdenkc6097192002-11-03 00:24:07 +00003019
wdenkc6097192002-11-03 00:24:07 +00003020
wdenk2729af92004-05-03 20:45:30 +00003021Finally, type "make all", and you should get some working U-Boot
3022images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003023
wdenk2729af92004-05-03 20:45:30 +00003024- "u-boot.bin" is a raw binary image
3025- "u-boot" is an image in ELF binary format
3026- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003027
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003028By default the build is performed locally and the objects are saved
3029in the source directory. One of the two methods can be used to change
3030this behavior and build U-Boot to some external directory:
3031
30321. Add O= to the make command line invocations:
3033
3034 make O=/tmp/build distclean
3035 make O=/tmp/build NAME_config
3036 make O=/tmp/build all
3037
30382. Set environment variable BUILD_DIR to point to the desired location:
3039
3040 export BUILD_DIR=/tmp/build
3041 make distclean
3042 make NAME_config
3043 make all
3044
3045Note that the command line "O=" setting overrides the BUILD_DIR environment
3046variable.
3047
wdenkc6097192002-11-03 00:24:07 +00003048
wdenk2729af92004-05-03 20:45:30 +00003049Please be aware that the Makefiles assume you are using GNU make, so
3050for instance on NetBSD you might need to use "gmake" instead of
3051native "make".
wdenkc6097192002-11-03 00:24:07 +00003052
wdenkc6097192002-11-03 00:24:07 +00003053
wdenk2729af92004-05-03 20:45:30 +00003054If the system board that you have is not listed, then you will need
3055to port U-Boot to your hardware platform. To do this, follow these
3056steps:
wdenkc6097192002-11-03 00:24:07 +00003057
wdenk2729af92004-05-03 20:45:30 +000030581. Add a new configuration option for your board to the toplevel
3059 "Makefile" and to the "MAKEALL" script, using the existing
3060 entries as examples. Note that here and at many other places
3061 boards and other names are listed in alphabetical sort order. Please
3062 keep this order.
30632. Create a new directory to hold your board specific code. Add any
3064 files you need. In your board directory, you will need at least
3065 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
30663. Create a new configuration file "include/configs/<board>.h" for
3067 your board
30683. If you're porting U-Boot to a new CPU, then also create a new
3069 directory to hold your CPU specific code. Add any files you need.
30704. Run "make <board>_config" with your new name.
30715. Type "make", and you should get a working "u-boot.srec" file
3072 to be installed on your target system.
30736. Debug and solve any problems that might arise.
3074 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003075
wdenkc6097192002-11-03 00:24:07 +00003076
wdenk2729af92004-05-03 20:45:30 +00003077Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3078==============================================================
wdenkc6097192002-11-03 00:24:07 +00003079
Wolfgang Denk218ca722008-03-26 10:40:12 +01003080If you have modified U-Boot sources (for instance added a new board
3081or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003082provide feedback to the other developers. The feedback normally takes
3083the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003084official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003085
Wolfgang Denk218ca722008-03-26 10:40:12 +01003086But before you submit such a patch, please verify that your modifi-
3087cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003088the supported boards compile WITHOUT ANY compiler warnings. To do so,
3089just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003090for ALL supported system. Be warned, this will take a while. You can
3091select which (cross) compiler to use by passing a `CROSS_COMPILE'
3092environment variable to the script, i. e. to use the ELDK cross tools
3093you can type
wdenkc6097192002-11-03 00:24:07 +00003094
wdenk2729af92004-05-03 20:45:30 +00003095 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003096
wdenk2729af92004-05-03 20:45:30 +00003097or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003098
wdenk2729af92004-05-03 20:45:30 +00003099 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003100
Wolfgang Denk218ca722008-03-26 10:40:12 +01003101When using the MAKEALL script, the default behaviour is to build
3102U-Boot in the source directory. This location can be changed by
3103setting the BUILD_DIR environment variable. Also, for each target
3104built, the MAKEALL script saves two log files (<target>.ERR and
3105<target>.MAKEALL) in the <source dir>/LOG directory. This default
3106location can be changed by setting the MAKEALL_LOGDIR environment
3107variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003108
3109 export BUILD_DIR=/tmp/build
3110 export MAKEALL_LOGDIR=/tmp/log
3111 CROSS_COMPILE=ppc_8xx- MAKEALL
3112
Wolfgang Denk218ca722008-03-26 10:40:12 +01003113With the above settings build objects are saved in the /tmp/build,
3114log files are saved in the /tmp/log and the source tree remains clean
3115during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003116
3117
wdenk2729af92004-05-03 20:45:30 +00003118See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003119
wdenkc6097192002-11-03 00:24:07 +00003120
wdenk2729af92004-05-03 20:45:30 +00003121Monitor Commands - Overview:
3122============================
wdenkc6097192002-11-03 00:24:07 +00003123
wdenk2729af92004-05-03 20:45:30 +00003124go - start application at address 'addr'
3125run - run commands in an environment variable
3126bootm - boot application image from memory
3127bootp - boot image via network using BootP/TFTP protocol
3128tftpboot- boot image via network using TFTP protocol
3129 and env variables "ipaddr" and "serverip"
3130 (and eventually "gatewayip")
3131rarpboot- boot image via network using RARP/TFTP protocol
3132diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3133loads - load S-Record file over serial line
3134loadb - load binary file over serial line (kermit mode)
3135md - memory display
3136mm - memory modify (auto-incrementing)
3137nm - memory modify (constant address)
3138mw - memory write (fill)
3139cp - memory copy
3140cmp - memory compare
3141crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003142i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003143sspi - SPI utility commands
3144base - print or set address offset
3145printenv- print environment variables
3146setenv - set environment variables
3147saveenv - save environment variables to persistent storage
3148protect - enable or disable FLASH write protection
3149erase - erase FLASH memory
3150flinfo - print FLASH memory information
3151bdinfo - print Board Info structure
3152iminfo - print header information for application image
3153coninfo - print console devices and informations
3154ide - IDE sub-system
3155loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003156loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003157mtest - simple RAM test
3158icache - enable or disable instruction cache
3159dcache - enable or disable data cache
3160reset - Perform RESET of the CPU
3161echo - echo args to console
3162version - print monitor version
3163help - print online help
3164? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003165
wdenkc6097192002-11-03 00:24:07 +00003166
wdenk2729af92004-05-03 20:45:30 +00003167Monitor Commands - Detailed Description:
3168========================================
wdenkc6097192002-11-03 00:24:07 +00003169
wdenk2729af92004-05-03 20:45:30 +00003170TODO.
wdenkc6097192002-11-03 00:24:07 +00003171
wdenk2729af92004-05-03 20:45:30 +00003172For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003173
3174
wdenk2729af92004-05-03 20:45:30 +00003175Environment Variables:
3176======================
wdenkc6097192002-11-03 00:24:07 +00003177
wdenk2729af92004-05-03 20:45:30 +00003178U-Boot supports user configuration using Environment Variables which
3179can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003180
wdenk2729af92004-05-03 20:45:30 +00003181Environment Variables are set using "setenv", printed using
3182"printenv", and saved to Flash using "saveenv". Using "setenv"
3183without a value can be used to delete a variable from the
3184environment. As long as you don't save the environment you are
3185working with an in-memory copy. In case the Flash area containing the
3186environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003187
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003188Some configuration options can be set using Environment Variables.
3189
3190List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003191
wdenk2729af92004-05-03 20:45:30 +00003192 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003193
wdenk2729af92004-05-03 20:45:30 +00003194 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003195
wdenk2729af92004-05-03 20:45:30 +00003196 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003197
wdenk2729af92004-05-03 20:45:30 +00003198 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk2729af92004-05-03 20:45:30 +00003200 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003201
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003202 bootm_low - Memory range available for image processing in the bootm
3203 command can be restricted. This variable is given as
3204 a hexadecimal number and defines lowest address allowed
3205 for use by the bootm command. See also "bootm_size"
3206 environment variable. Address defined by "bootm_low" is
3207 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003208 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3209 bootm_mapsize.
3210
3211 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3212 This variable is given as a hexadecimal number and it
3213 defines the size of the memory region starting at base
3214 address bootm_low that is accessible by the Linux kernel
3215 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3216 as the default value if it is defined, and bootm_size is
3217 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003218
3219 bootm_size - Memory range available for image processing in the bootm
3220 command can be restricted. This variable is given as
3221 a hexadecimal number and defines the size of the region
3222 allowed for use by the bootm command. See also "bootm_low"
3223 environment variable.
3224
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003225 updatefile - Location of the software update file on a TFTP server, used
3226 by the automatic software update feature. Please refer to
3227 documentation in doc/README.update for more details.
3228
wdenk2729af92004-05-03 20:45:30 +00003229 autoload - if set to "no" (any string beginning with 'n'),
3230 "bootp" will just load perform a lookup of the
3231 configuration from the BOOTP server, but not try to
3232 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003233
wdenk2729af92004-05-03 20:45:30 +00003234 autostart - if set to "yes", an image loaded using the "bootp",
3235 "rarpboot", "tftpboot" or "diskboot" commands will
3236 be automatically started (by internally calling
3237 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003238
wdenk2729af92004-05-03 20:45:30 +00003239 If set to "no", a standalone image passed to the
3240 "bootm" command will be copied to the load address
3241 (and eventually uncompressed), but NOT be started.
3242 This can be used to load and uncompress arbitrary
3243 data.
wdenkc6097192002-11-03 00:24:07 +00003244
wdenk17ea1172004-06-06 21:51:03 +00003245 i2cfast - (PPC405GP|PPC405EP only)
3246 if set to 'y' configures Linux I2C driver for fast
3247 mode (400kHZ). This environment variable is used in
3248 initialization code. So, for changes to be effective
3249 it must be saved and board must be reset.
3250
wdenk2729af92004-05-03 20:45:30 +00003251 initrd_high - restrict positioning of initrd images:
3252 If this variable is not set, initrd images will be
3253 copied to the highest possible address in RAM; this
3254 is usually what you want since it allows for
3255 maximum initrd size. If for some reason you want to
3256 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003257 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003258 variable to a value of "no" or "off" or "0".
3259 Alternatively, you can set it to a maximum upper
3260 address to use (U-Boot will still check that it
3261 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003262
wdenk2729af92004-05-03 20:45:30 +00003263 For instance, when you have a system with 16 MB
3264 RAM, and want to reserve 4 MB from use by Linux,
3265 you can do this by adding "mem=12M" to the value of
3266 the "bootargs" variable. However, now you must make
3267 sure that the initrd image is placed in the first
3268 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003269
wdenk2729af92004-05-03 20:45:30 +00003270 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003271
wdenk2729af92004-05-03 20:45:30 +00003272 If you set initrd_high to 0xFFFFFFFF, this is an
3273 indication to U-Boot that all addresses are legal
3274 for the Linux kernel, including addresses in flash
3275 memory. In this case U-Boot will NOT COPY the
3276 ramdisk at all. This may be useful to reduce the
3277 boot time on your system, but requires that this
3278 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003279
wdenk2729af92004-05-03 20:45:30 +00003280 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk2729af92004-05-03 20:45:30 +00003282 loadaddr - Default load address for commands like "bootp",
3283 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003284
wdenk2729af92004-05-03 20:45:30 +00003285 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003286
wdenk2729af92004-05-03 20:45:30 +00003287 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003288
wdenk2729af92004-05-03 20:45:30 +00003289 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003290
wdenk2729af92004-05-03 20:45:30 +00003291 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk2729af92004-05-03 20:45:30 +00003293 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003294
wdenk2729af92004-05-03 20:45:30 +00003295 ethprime - When CONFIG_NET_MULTI is enabled controls which
3296 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003297
wdenk2729af92004-05-03 20:45:30 +00003298 ethact - When CONFIG_NET_MULTI is enabled controls which
3299 interface is currently active. For example you
3300 can do the following
wdenkc6097192002-11-03 00:24:07 +00003301
Heiko Schocher48690d82010-07-20 17:45:02 +02003302 => setenv ethact FEC
3303 => ping 192.168.0.1 # traffic sent on FEC
3304 => setenv ethact SCC
3305 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003306
Matthias Fuchse1692572008-01-17 07:45:05 +01003307 ethrotate - When set to "no" U-Boot does not go through all
3308 available network interfaces.
3309 It just stays at the currently selected interface.
3310
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003311 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003312 either succeed or fail without retrying.
3313 When set to "once" the network operation will
3314 fail when all the available network interfaces
3315 are tried once without success.
3316 Useful on scripts which control the retry operation
3317 themselves.
wdenkc6097192002-11-03 00:24:07 +00003318
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003319 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003320
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003321 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003322 UDP source port.
3323
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003324 tftpdstport - If this is set, the value is used for TFTP's UDP
3325 destination port instead of the Well Know Port 69.
3326
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003327 tftpblocksize - Block size to use for TFTP transfers; if not set,
3328 we use the TFTP server's default block size
3329
3330 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3331 seconds, minimum value is 1000 = 1 second). Defines
3332 when a packet is considered to be lost so it has to
3333 be retransmitted. The default is 5000 = 5 seconds.
3334 Lowering this value may make downloads succeed
3335 faster in networks with high packet loss rates or
3336 with unreliable TFTP servers.
3337
3338 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003339 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003340 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003341
wdenk2729af92004-05-03 20:45:30 +00003342The following environment variables may be used and automatically
3343updated by the network boot commands ("bootp" and "rarpboot"),
3344depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003345
wdenk2729af92004-05-03 20:45:30 +00003346 bootfile - see above
3347 dnsip - IP address of your Domain Name Server
3348 dnsip2 - IP address of your secondary Domain Name Server
3349 gatewayip - IP address of the Gateway (Router) to use
3350 hostname - Target hostname
3351 ipaddr - see above
3352 netmask - Subnet Mask
3353 rootpath - Pathname of the root filesystem on the NFS server
3354 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003355
wdenka3d991b2004-04-15 21:48:45 +00003356
wdenk2729af92004-05-03 20:45:30 +00003357There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003358
wdenk2729af92004-05-03 20:45:30 +00003359 serial# - contains hardware identification information such
3360 as type string and/or serial number
3361 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003362
wdenk2729af92004-05-03 20:45:30 +00003363These variables can be set only once (usually during manufacturing of
3364the board). U-Boot refuses to delete or overwrite these variables
3365once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003366
3367
wdenk2729af92004-05-03 20:45:30 +00003368Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003369
wdenk2729af92004-05-03 20:45:30 +00003370 ver - Contains the U-Boot version string as printed
3371 with the "version" command. This variable is
3372 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003373
wdenkc6097192002-11-03 00:24:07 +00003374
wdenk2729af92004-05-03 20:45:30 +00003375Please note that changes to some configuration parameters may take
3376only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003377
stroesec1551ea2003-04-04 15:53:41 +00003378
wdenk2729af92004-05-03 20:45:30 +00003379Command Line Parsing:
3380=====================
stroesec1551ea2003-04-04 15:53:41 +00003381
wdenk2729af92004-05-03 20:45:30 +00003382There are two different command line parsers available with U-Boot:
3383the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003384
wdenk2729af92004-05-03 20:45:30 +00003385Old, simple command line parser:
3386--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003387
wdenk2729af92004-05-03 20:45:30 +00003388- supports environment variables (through setenv / saveenv commands)
3389- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003390- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003391- special characters ('$', ';') can be escaped by prefixing with '\',
3392 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003393 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003394- You can also escape text by enclosing in single apostrophes, for example:
3395 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003396
wdenk2729af92004-05-03 20:45:30 +00003397Hush shell:
3398-----------
wdenkf07771c2003-05-28 08:06:31 +00003399
wdenk2729af92004-05-03 20:45:30 +00003400- similar to Bourne shell, with control structures like
3401 if...then...else...fi, for...do...done; while...do...done,
3402 until...do...done, ...
3403- supports environment ("global") variables (through setenv / saveenv
3404 commands) and local shell variables (through standard shell syntax
3405 "name=value"); only environment variables can be used with "run"
3406 command
wdenkf07771c2003-05-28 08:06:31 +00003407
wdenk2729af92004-05-03 20:45:30 +00003408General rules:
3409--------------
wdenkf07771c2003-05-28 08:06:31 +00003410
wdenk2729af92004-05-03 20:45:30 +00003411(1) If a command line (or an environment variable executed by a "run"
3412 command) contains several commands separated by semicolon, and
3413 one of these commands fails, then the remaining commands will be
3414 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003415
wdenk2729af92004-05-03 20:45:30 +00003416(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003417 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003418 command will cause "run" to terminate, i. e. the remaining
3419 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003420
wdenk2729af92004-05-03 20:45:30 +00003421Note for Redundant Ethernet Interfaces:
3422=======================================
wdenkf07771c2003-05-28 08:06:31 +00003423
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003424Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003425such configurations and is capable of automatic selection of a
3426"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003427
wdenk2729af92004-05-03 20:45:30 +00003428Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3429MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3430"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003431
wdenk2729af92004-05-03 20:45:30 +00003432If the network interface stores some valid MAC address (for instance
3433in SROM), this is used as default address if there is NO correspon-
3434ding setting in the environment; if the corresponding environment
3435variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003436
wdenk2729af92004-05-03 20:45:30 +00003437o If the SROM has a valid MAC address, and there is no address in the
3438 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003439
wdenk2729af92004-05-03 20:45:30 +00003440o If there is no valid address in the SROM, and a definition in the
3441 environment exists, then the value from the environment variable is
3442 used.
wdenkc6097192002-11-03 00:24:07 +00003443
wdenk2729af92004-05-03 20:45:30 +00003444o If both the SROM and the environment contain a MAC address, and
3445 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003446
wdenk2729af92004-05-03 20:45:30 +00003447o If both the SROM and the environment contain a MAC address, and the
3448 addresses differ, the value from the environment is used and a
3449 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003450
wdenk2729af92004-05-03 20:45:30 +00003451o If neither SROM nor the environment contain a MAC address, an error
3452 is raised.
wdenkc6097192002-11-03 00:24:07 +00003453
Ben Warrenecee9322010-04-26 11:11:46 -07003454If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3455will be programmed into hardware as part of the initialization process. This
3456may be skipped by setting the appropriate 'ethmacskip' environment variable.
3457The naming convention is as follows:
3458"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003459
wdenk2729af92004-05-03 20:45:30 +00003460Image Formats:
3461==============
wdenkc6097192002-11-03 00:24:07 +00003462
Marian Balakowicz3310c542008-03-12 12:13:13 +01003463U-Boot is capable of booting (and performing other auxiliary operations on)
3464images in two formats:
3465
3466New uImage format (FIT)
3467-----------------------
3468
3469Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3470to Flattened Device Tree). It allows the use of images with multiple
3471components (several kernels, ramdisks, etc.), with contents protected by
3472SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3473
3474
3475Old uImage format
3476-----------------
3477
3478Old image format is based on binary files which can be basically anything,
3479preceded by a special header; see the definitions in include/image.h for
3480details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk2729af92004-05-03 20:45:30 +00003482* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3483 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003484 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3485 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3486 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003487* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003488 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3489 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003490* Compression Type (uncompressed, gzip, bzip2)
3491* Load Address
3492* Entry Point
3493* Image Name
3494* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003495
wdenk2729af92004-05-03 20:45:30 +00003496The header is marked by a special Magic Number, and both the header
3497and the data portions of the image are secured against corruption by
3498CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003499
wdenkc6097192002-11-03 00:24:07 +00003500
wdenk2729af92004-05-03 20:45:30 +00003501Linux Support:
3502==============
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504Although U-Boot should support any OS or standalone application
3505easily, the main focus has always been on Linux during the design of
3506U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk2729af92004-05-03 20:45:30 +00003508U-Boot includes many features that so far have been part of some
3509special "boot loader" code within the Linux kernel. Also, any
3510"initrd" images to be used are no longer part of one big Linux image;
3511instead, kernel and "initrd" are separate images. This implementation
3512serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003513
wdenk2729af92004-05-03 20:45:30 +00003514- the same features can be used for other OS or standalone
3515 applications (for instance: using compressed images to reduce the
3516 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003517
wdenk2729af92004-05-03 20:45:30 +00003518- it becomes much easier to port new Linux kernel versions because
3519 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003520
wdenk2729af92004-05-03 20:45:30 +00003521- the same Linux kernel image can now be used with different "initrd"
3522 images; of course this also means that different kernel images can
3523 be run with the same "initrd". This makes testing easier (you don't
3524 have to build a new "zImage.initrd" Linux image when you just
3525 change a file in your "initrd"). Also, a field-upgrade of the
3526 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003527
wdenkc6097192002-11-03 00:24:07 +00003528
wdenk2729af92004-05-03 20:45:30 +00003529Linux HOWTO:
3530============
wdenkc6097192002-11-03 00:24:07 +00003531
wdenk2729af92004-05-03 20:45:30 +00003532Porting Linux to U-Boot based systems:
3533---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003534
wdenk2729af92004-05-03 20:45:30 +00003535U-Boot cannot save you from doing all the necessary modifications to
3536configure the Linux device drivers for use with your target hardware
3537(no, we don't intend to provide a full virtual machine interface to
3538Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003539
Stefan Roesea47a12b2010-04-15 16:07:28 +02003540But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003541
wdenk2729af92004-05-03 20:45:30 +00003542Just make sure your machine specific header file (for instance
3543include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003544Information structure as we define in include/asm-<arch>/u-boot.h,
3545and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003546as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003547
wdenkc6097192002-11-03 00:24:07 +00003548
wdenk2729af92004-05-03 20:45:30 +00003549Configuring the Linux kernel:
3550-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003551
wdenk2729af92004-05-03 20:45:30 +00003552No specific requirements for U-Boot. Make sure you have some root
3553device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003554
wdenkc6097192002-11-03 00:24:07 +00003555
wdenk2729af92004-05-03 20:45:30 +00003556Building a Linux Image:
3557-----------------------
wdenkc6097192002-11-03 00:24:07 +00003558
wdenk2729af92004-05-03 20:45:30 +00003559With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3560not used. If you use recent kernel source, a new build target
3561"uImage" will exist which automatically builds an image usable by
3562U-Boot. Most older kernels also have support for a "pImage" target,
3563which was introduced for our predecessor project PPCBoot and uses a
3564100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003565
wdenk2729af92004-05-03 20:45:30 +00003566Example:
wdenkc6097192002-11-03 00:24:07 +00003567
wdenk2729af92004-05-03 20:45:30 +00003568 make TQM850L_config
3569 make oldconfig
3570 make dep
3571 make uImage
wdenkc6097192002-11-03 00:24:07 +00003572
wdenk2729af92004-05-03 20:45:30 +00003573The "uImage" build target uses a special tool (in 'tools/mkimage') to
3574encapsulate a compressed Linux kernel image with header information,
3575CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003576
wdenk2729af92004-05-03 20:45:30 +00003577* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003578
wdenk2729af92004-05-03 20:45:30 +00003579* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003580
wdenk2729af92004-05-03 20:45:30 +00003581 ${CROSS_COMPILE}-objcopy -O binary \
3582 -R .note -R .comment \
3583 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003584
wdenk2729af92004-05-03 20:45:30 +00003585* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk2729af92004-05-03 20:45:30 +00003587 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591 mkimage -A ppc -O linux -T kernel -C gzip \
3592 -a 0 -e 0 -n "Linux Kernel Image" \
3593 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003594
wdenk24ee89b2002-11-03 17:56:27 +00003595
wdenk2729af92004-05-03 20:45:30 +00003596The "mkimage" tool can also be used to create ramdisk images for use
3597with U-Boot, either separated from the Linux kernel image, or
3598combined into one file. "mkimage" encapsulates the images with a 64
3599byte header containing information about target architecture,
3600operating system, image type, compression method, entry points, time
3601stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003602
wdenk2729af92004-05-03 20:45:30 +00003603"mkimage" can be called in two ways: to verify existing images and
3604print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003605
wdenk2729af92004-05-03 20:45:30 +00003606In the first form (with "-l" option) mkimage lists the information
3607contained in the header of an existing U-Boot image; this includes
3608checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003609
wdenk2729af92004-05-03 20:45:30 +00003610 tools/mkimage -l image
3611 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003612
wdenk2729af92004-05-03 20:45:30 +00003613The second form (with "-d" option) is used to build a U-Boot image
3614from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003615
wdenk2729af92004-05-03 20:45:30 +00003616 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3617 -n name -d data_file image
3618 -A ==> set architecture to 'arch'
3619 -O ==> set operating system to 'os'
3620 -T ==> set image type to 'type'
3621 -C ==> set compression type 'comp'
3622 -a ==> set load address to 'addr' (hex)
3623 -e ==> set entry point to 'ep' (hex)
3624 -n ==> set image name to 'name'
3625 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003626
wdenk69459792004-05-29 16:53:29 +00003627Right now, all Linux kernels for PowerPC systems use the same load
3628address (0x00000000), but the entry point address depends on the
3629kernel version:
wdenkc6097192002-11-03 00:24:07 +00003630
wdenk2729af92004-05-03 20:45:30 +00003631- 2.2.x kernels have the entry point at 0x0000000C,
3632- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003633
wdenk2729af92004-05-03 20:45:30 +00003634So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003635
wdenk2729af92004-05-03 20:45:30 +00003636 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3637 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003638 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003639 > examples/uImage.TQM850L
3640 Image Name: 2.4.4 kernel for TQM850L
3641 Created: Wed Jul 19 02:34:59 2000
3642 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3643 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3644 Load Address: 0x00000000
3645 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003646
wdenk2729af92004-05-03 20:45:30 +00003647To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003648
wdenk2729af92004-05-03 20:45:30 +00003649 -> tools/mkimage -l 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 +00003657NOTE: for embedded systems where boot time is critical you can trade
3658speed for memory and install an UNCOMPRESSED image instead: this
3659needs more space in Flash, but boots much faster since it does not
3660need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003661
Stefan Roesea47a12b2010-04-15 16:07:28 +02003662 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003663 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3664 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003665 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003666 > examples/uImage.TQM850L-uncompressed
3667 Image Name: 2.4.4 kernel for TQM850L
3668 Created: Wed Jul 19 02:34:59 2000
3669 Image Type: PowerPC Linux Kernel Image (uncompressed)
3670 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3671 Load Address: 0x00000000
3672 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003673
wdenkc6097192002-11-03 00:24:07 +00003674
wdenk2729af92004-05-03 20:45:30 +00003675Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3676when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003677
wdenk2729af92004-05-03 20:45:30 +00003678 -> tools/mkimage -n 'Simple Ramdisk Image' \
3679 > -A ppc -O linux -T ramdisk -C gzip \
3680 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3681 Image Name: Simple Ramdisk Image
3682 Created: Wed Jan 12 14:01:50 2000
3683 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3684 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3685 Load Address: 0x00000000
3686 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003687
wdenkdb01a2e2004-04-15 23:14:49 +00003688
wdenk2729af92004-05-03 20:45:30 +00003689Installing a Linux Image:
3690-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003691
wdenk2729af92004-05-03 20:45:30 +00003692To downloading a U-Boot image over the serial (console) interface,
3693you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003694
wdenk2729af92004-05-03 20:45:30 +00003695 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697The 'objcopy' does not understand the information in the U-Boot
3698image header, so the resulting S-Record file will be relative to
3699address 0x00000000. To load it to a given address, you need to
3700specify the target address as 'offset' parameter with the 'loads'
3701command.
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk2729af92004-05-03 20:45:30 +00003703Example: install the image to address 0x40100000 (which on the
3704TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003705
wdenk2729af92004-05-03 20:45:30 +00003706 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003707
wdenk2729af92004-05-03 20:45:30 +00003708 .......... done
3709 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003710
wdenk2729af92004-05-03 20:45:30 +00003711 => loads 40100000
3712 ## Ready for S-Record download ...
3713 ~>examples/image.srec
3714 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3715 ...
3716 15989 15990 15991 15992
3717 [file transfer complete]
3718 [connected]
3719 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003720
3721
wdenk2729af92004-05-03 20:45:30 +00003722You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003723this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003724corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003725
wdenk2729af92004-05-03 20:45:30 +00003726 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk2729af92004-05-03 20:45:30 +00003728 ## Checking Image at 40100000 ...
3729 Image Name: 2.2.13 for initrd on TQM850L
3730 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3731 Data Size: 335725 Bytes = 327 kB = 0 MB
3732 Load Address: 00000000
3733 Entry Point: 0000000c
3734 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003735
3736
wdenk2729af92004-05-03 20:45:30 +00003737Boot Linux:
3738-----------
wdenkc6097192002-11-03 00:24:07 +00003739
wdenk2729af92004-05-03 20:45:30 +00003740The "bootm" command is used to boot an application that is stored in
3741memory (RAM or Flash). In case of a Linux kernel image, the contents
3742of the "bootargs" environment variable is passed to the kernel as
3743parameters. You can check and modify this variable using the
3744"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003745
3746
wdenk2729af92004-05-03 20:45:30 +00003747 => printenv bootargs
3748 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003749
wdenk2729af92004-05-03 20:45:30 +00003750 => 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 +00003751
wdenk2729af92004-05-03 20:45:30 +00003752 => printenv bootargs
3753 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 +00003754
wdenk2729af92004-05-03 20:45:30 +00003755 => bootm 40020000
3756 ## Booting Linux kernel at 40020000 ...
3757 Image Name: 2.2.13 for NFS on TQM850L
3758 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3759 Data Size: 381681 Bytes = 372 kB = 0 MB
3760 Load Address: 00000000
3761 Entry Point: 0000000c
3762 Verifying Checksum ... OK
3763 Uncompressing Kernel Image ... OK
3764 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
3765 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3766 time_init: decrementer frequency = 187500000/60
3767 Calibrating delay loop... 49.77 BogoMIPS
3768 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3769 ...
wdenkc6097192002-11-03 00:24:07 +00003770
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003771If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003772the memory addresses of both the kernel and the initrd image (PPBCOOT
3773format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003774
wdenk2729af92004-05-03 20:45:30 +00003775 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003776
wdenk2729af92004-05-03 20:45:30 +00003777 ## Checking Image at 40100000 ...
3778 Image Name: 2.2.13 for initrd on TQM850L
3779 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3780 Data Size: 335725 Bytes = 327 kB = 0 MB
3781 Load Address: 00000000
3782 Entry Point: 0000000c
3783 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003784
wdenk2729af92004-05-03 20:45:30 +00003785 ## Checking Image at 40200000 ...
3786 Image Name: Simple Ramdisk Image
3787 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3788 Data Size: 566530 Bytes = 553 kB = 0 MB
3789 Load Address: 00000000
3790 Entry Point: 00000000
3791 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003792
wdenk2729af92004-05-03 20:45:30 +00003793 => bootm 40100000 40200000
3794 ## Booting Linux kernel at 40100000 ...
3795 Image Name: 2.2.13 for initrd on TQM850L
3796 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3797 Data Size: 335725 Bytes = 327 kB = 0 MB
3798 Load Address: 00000000
3799 Entry Point: 0000000c
3800 Verifying Checksum ... OK
3801 Uncompressing Kernel Image ... OK
3802 ## Loading RAMDisk Image at 40200000 ...
3803 Image Name: Simple Ramdisk Image
3804 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3805 Data Size: 566530 Bytes = 553 kB = 0 MB
3806 Load Address: 00000000
3807 Entry Point: 00000000
3808 Verifying Checksum ... OK
3809 Loading Ramdisk ... OK
3810 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
3811 Boot arguments: root=/dev/ram
3812 time_init: decrementer frequency = 187500000/60
3813 Calibrating delay loop... 49.77 BogoMIPS
3814 ...
3815 RAMDISK: Compressed image found at block 0
3816 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003817
wdenk2729af92004-05-03 20:45:30 +00003818 bash#
wdenkc6097192002-11-03 00:24:07 +00003819
Matthew McClintock02677682006-06-28 10:41:37 -05003820Boot Linux and pass a flat device tree:
3821-----------
3822
3823First, U-Boot must be compiled with the appropriate defines. See the section
3824titled "Linux Kernel Interface" above for a more in depth explanation. The
3825following is an example of how to start a kernel and pass an updated
3826flat device tree:
3827
3828=> print oftaddr
3829oftaddr=0x300000
3830=> print oft
3831oft=oftrees/mpc8540ads.dtb
3832=> tftp $oftaddr $oft
3833Speed: 1000, full duplex
3834Using TSEC0 device
3835TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3836Filename 'oftrees/mpc8540ads.dtb'.
3837Load address: 0x300000
3838Loading: #
3839done
3840Bytes transferred = 4106 (100a hex)
3841=> tftp $loadaddr $bootfile
3842Speed: 1000, full duplex
3843Using TSEC0 device
3844TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3845Filename 'uImage'.
3846Load address: 0x200000
3847Loading:############
3848done
3849Bytes transferred = 1029407 (fb51f hex)
3850=> print loadaddr
3851loadaddr=200000
3852=> print oftaddr
3853oftaddr=0x300000
3854=> bootm $loadaddr - $oftaddr
3855## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003856 Image Name: Linux-2.6.17-dirty
3857 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3858 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003859 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003860 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003861 Verifying Checksum ... OK
3862 Uncompressing Kernel Image ... OK
3863Booting using flat device tree at 0x300000
3864Using MPC85xx ADS machine description
3865Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3866[snip]
3867
3868
wdenk2729af92004-05-03 20:45:30 +00003869More About U-Boot Image Types:
3870------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003871
wdenk2729af92004-05-03 20:45:30 +00003872U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874 "Standalone Programs" are directly runnable in the environment
3875 provided by U-Boot; it is expected that (if they behave
3876 well) you can continue to work in U-Boot after return from
3877 the Standalone Program.
3878 "OS Kernel Images" are usually images of some Embedded OS which
3879 will take over control completely. Usually these programs
3880 will install their own set of exception handlers, device
3881 drivers, set up the MMU, etc. - this means, that you cannot
3882 expect to re-enter U-Boot except by resetting the CPU.
3883 "RAMDisk Images" are more or less just data blocks, and their
3884 parameters (address, size) are passed to an OS kernel that is
3885 being started.
3886 "Multi-File Images" contain several images, typically an OS
3887 (Linux) kernel image and one or more data images like
3888 RAMDisks. This construct is useful for instance when you want
3889 to boot over the network using BOOTP etc., where the boot
3890 server provides just a single image file, but you want to get
3891 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893 "Multi-File Images" start with a list of image sizes, each
3894 image size (in bytes) specified by an "uint32_t" in network
3895 byte order. This list is terminated by an "(uint32_t)0".
3896 Immediately after the terminating 0 follow the images, one by
3897 one, all aligned on "uint32_t" boundaries (size rounded up to
3898 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003899
wdenk2729af92004-05-03 20:45:30 +00003900 "Firmware Images" are binary images containing firmware (like
3901 U-Boot or FPGA images) which usually will be programmed to
3902 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003903
wdenk2729af92004-05-03 20:45:30 +00003904 "Script files" are command sequences that will be executed by
3905 U-Boot's command interpreter; this feature is especially
3906 useful when you configure U-Boot to use a real shell (hush)
3907 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003908
wdenkc6097192002-11-03 00:24:07 +00003909
wdenk2729af92004-05-03 20:45:30 +00003910Standalone HOWTO:
3911=================
wdenkc6097192002-11-03 00:24:07 +00003912
wdenk2729af92004-05-03 20:45:30 +00003913One of the features of U-Boot is that you can dynamically load and
3914run "standalone" applications, which can use some resources of
3915U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003916
wdenk2729af92004-05-03 20:45:30 +00003917Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003918
wdenk2729af92004-05-03 20:45:30 +00003919"Hello World" Demo:
3920-------------------
wdenkc6097192002-11-03 00:24:07 +00003921
wdenk2729af92004-05-03 20:45:30 +00003922'examples/hello_world.c' contains a small "Hello World" Demo
3923application; it is automatically compiled when you build U-Boot.
3924It's configured to run at address 0x00040004, so you can play with it
3925like that:
wdenkc6097192002-11-03 00:24:07 +00003926
wdenk2729af92004-05-03 20:45:30 +00003927 => loads
3928 ## Ready for S-Record download ...
3929 ~>examples/hello_world.srec
3930 1 2 3 4 5 6 7 8 9 10 11 ...
3931 [file transfer complete]
3932 [connected]
3933 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003934
wdenk2729af92004-05-03 20:45:30 +00003935 => go 40004 Hello World! This is a test.
3936 ## Starting application at 0x00040004 ...
3937 Hello World
3938 argc = 7
3939 argv[0] = "40004"
3940 argv[1] = "Hello"
3941 argv[2] = "World!"
3942 argv[3] = "This"
3943 argv[4] = "is"
3944 argv[5] = "a"
3945 argv[6] = "test."
3946 argv[7] = "<NULL>"
3947 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003948
wdenk2729af92004-05-03 20:45:30 +00003949 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951Another example, which demonstrates how to register a CPM interrupt
3952handler with the U-Boot code, can be found in 'examples/timer.c'.
3953Here, a CPM timer is set up to generate an interrupt every second.
3954The interrupt service routine is trivial, just printing a '.'
3955character, but this is just a demo program. The application can be
3956controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003957
wdenk2729af92004-05-03 20:45:30 +00003958 ? - print current values og the CPM Timer registers
3959 b - enable interrupts and start timer
3960 e - stop timer and disable interrupts
3961 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk2729af92004-05-03 20:45:30 +00003963 => loads
3964 ## Ready for S-Record download ...
3965 ~>examples/timer.srec
3966 1 2 3 4 5 6 7 8 9 10 11 ...
3967 [file transfer complete]
3968 [connected]
3969 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003970
wdenk2729af92004-05-03 20:45:30 +00003971 => go 40004
3972 ## Starting application at 0x00040004 ...
3973 TIMERS=0xfff00980
3974 Using timer 1
3975 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003976
wdenk2729af92004-05-03 20:45:30 +00003977Hit 'b':
3978 [q, b, e, ?] Set interval 1000000 us
3979 Enabling timer
3980Hit '?':
3981 [q, b, e, ?] ........
3982 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3983Hit '?':
3984 [q, b, e, ?] .
3985 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3986Hit '?':
3987 [q, b, e, ?] .
3988 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3989Hit '?':
3990 [q, b, e, ?] .
3991 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3992Hit 'e':
3993 [q, b, e, ?] ...Stopping timer
3994Hit 'q':
3995 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003996
3997
wdenk2729af92004-05-03 20:45:30 +00003998Minicom warning:
3999================
wdenk85ec0bc2003-03-31 16:34:49 +00004000
wdenk2729af92004-05-03 20:45:30 +00004001Over time, many people have reported problems when trying to use the
4002"minicom" terminal emulation program for serial download. I (wd)
4003consider minicom to be broken, and recommend not to use it. Under
4004Unix, I recommend to use C-Kermit for general purpose use (and
4005especially for kermit binary protocol download ("loadb" command), and
4006use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004007
wdenk2729af92004-05-03 20:45:30 +00004008Nevertheless, if you absolutely want to use it try adding this
4009configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004010
wdenk2729af92004-05-03 20:45:30 +00004011 Name Program Name U/D FullScr IO-Red. Multi
4012 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4013 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004014
4015
wdenk2729af92004-05-03 20:45:30 +00004016NetBSD Notes:
4017=============
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk2729af92004-05-03 20:45:30 +00004019Starting at version 0.9.2, U-Boot supports NetBSD both as host
4020(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022Building requires a cross environment; it is known to work on
4023NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4024need gmake since the Makefiles are not compatible with BSD make).
4025Note that the cross-powerpc package does not install include files;
4026attempting to build U-Boot will fail because <machine/ansi.h> is
4027missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004028
wdenk2729af92004-05-03 20:45:30 +00004029 # cd /usr/pkg/cross/powerpc-netbsd/include
4030 # mkdir powerpc
4031 # ln -s powerpc machine
4032 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4033 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk2729af92004-05-03 20:45:30 +00004035Native builds *don't* work due to incompatibilities between native
4036and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004037
wdenk2729af92004-05-03 20:45:30 +00004038Booting assumes that (the first part of) the image booted is a
4039stage-2 loader which in turn loads and then invokes the kernel
4040proper. Loader sources will eventually appear in the NetBSD source
4041tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004042meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004043
4044
wdenk2729af92004-05-03 20:45:30 +00004045Implementation Internals:
4046=========================
wdenkc6097192002-11-03 00:24:07 +00004047
wdenk2729af92004-05-03 20:45:30 +00004048The following is not intended to be a complete description of every
4049implementation detail. However, it should help to understand the
4050inner workings of U-Boot and make it easier to port it to custom
4051hardware.
wdenkc6097192002-11-03 00:24:07 +00004052
4053
wdenk2729af92004-05-03 20:45:30 +00004054Initial Stack, Global Data:
4055---------------------------
wdenkc6097192002-11-03 00:24:07 +00004056
wdenk2729af92004-05-03 20:45:30 +00004057The implementation of U-Boot is complicated by the fact that U-Boot
4058starts running out of ROM (flash memory), usually without access to
4059system RAM (because the memory controller is not initialized yet).
4060This means that we don't have writable Data or BSS segments, and BSS
4061is not initialized as zero. To be able to get a C environment working
4062at all, we have to allocate at least a minimal stack. Implementation
4063options for this are defined and restricted by the CPU used: Some CPU
4064models provide on-chip memory (like the IMMR area on MPC8xx and
4065MPC826x processors), on others (parts of) the data cache can be
4066locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004067
Wolfgang Denk218ca722008-03-26 10:40:12 +01004068 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004069 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4072 From: "Chris Hallinan" <clh@net1plus.com>
4073 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4074 ...
wdenk43d96162003-03-06 00:02:04 +00004075
wdenk2729af92004-05-03 20:45:30 +00004076 Correct me if I'm wrong, folks, but the way I understand it
4077 is this: Using DCACHE as initial RAM for Stack, etc, does not
4078 require any physical RAM backing up the cache. The cleverness
4079 is that the cache is being used as a temporary supply of
4080 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004081 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004082 can see how this works by studying the cache architecture and
4083 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004084
wdenk2729af92004-05-03 20:45:30 +00004085 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4086 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004087 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004088 option should work for you. Using CS 4 should be fine if your
4089 board designers haven't used it for something that would
4090 cause you grief during the initial boot! It is frequently not
4091 used.
wdenk43d96162003-03-06 00:02:04 +00004092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004093 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004094 with your processor/board/system design. The default value
4095 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004096 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004097 than your SDRAM module. If you have a 64MB SDRAM module, set
4098 it above 400_0000. Just make sure your board has no resources
4099 that are supposed to respond to that address! That code in
4100 start.S has been around a while and should work as is when
4101 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004102
wdenk2729af92004-05-03 20:45:30 +00004103 -Chris Hallinan
4104 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004105
wdenk2729af92004-05-03 20:45:30 +00004106It is essential to remember this, since it has some impact on the C
4107code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004108
wdenk2729af92004-05-03 20:45:30 +00004109* Initialized global data (data segment) is read-only. Do not attempt
4110 to write it.
wdenkc6097192002-11-03 00:24:07 +00004111
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004112* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004113 as zero data - BSS segment) at all - this is undefined, initiali-
4114 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004115
wdenk2729af92004-05-03 20:45:30 +00004116* Stack space is very limited. Avoid big data buffers or things like
4117 that.
wdenkc6097192002-11-03 00:24:07 +00004118
wdenk2729af92004-05-03 20:45:30 +00004119Having only the stack as writable memory limits means we cannot use
4120normal global data to share information beween the code. But it
4121turned out that the implementation of U-Boot can be greatly
4122simplified by making a global data structure (gd_t) available to all
4123functions. We could pass a pointer to this data as argument to _all_
4124functions, but this would bloat the code. Instead we use a feature of
4125the GCC compiler (Global Register Variables) to share the data: we
4126place a pointer (gd) to the global data into a register which we
4127reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004128
wdenk2729af92004-05-03 20:45:30 +00004129When choosing a register for such a purpose we are restricted by the
4130relevant (E)ABI specifications for the current architecture, and by
4131GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk2729af92004-05-03 20:45:30 +00004133For PowerPC, the following registers have specific use:
4134 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004135 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004136 R3-R4: parameter passing and return values
4137 R5-R10: parameter passing
4138 R13: small data area pointer
4139 R30: GOT pointer
4140 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004141
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004142 (U-Boot also uses R12 as internal GOT pointer. r12
4143 is a volatile register so r12 needs to be reset when
4144 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004145
Wolfgang Denke7670f62008-02-14 22:43:22 +01004146 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004147
wdenk2729af92004-05-03 20:45:30 +00004148 Note: on PPC, we could use a static initializer (since the
4149 address of the global data structure is known at compile time),
4150 but it turned out that reserving a register results in somewhat
4151 smaller code - although the code savings are not that big (on
4152 average for all boards 752 bytes for the whole U-Boot image,
4153 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004154
Robin Getzc4db3352009-08-17 15:23:02 +00004155On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004156 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4157
Robin Getzc4db3352009-08-17 15:23:02 +00004158 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004159
wdenk2729af92004-05-03 20:45:30 +00004160On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162 R0: function argument word/integer result
4163 R1-R3: function argument word
4164 R9: GOT pointer
4165 R10: stack limit (used only if stack checking if enabled)
4166 R11: argument (frame) pointer
4167 R12: temporary workspace
4168 R13: stack pointer
4169 R14: link register
4170 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004171
wdenk2729af92004-05-03 20:45:30 +00004172 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004173
Thomas Chou0df01fd2010-05-21 11:08:03 +08004174On Nios II, the ABI is documented here:
4175 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4176
4177 ==> U-Boot will use gp to hold a pointer to the global data
4178
4179 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4180 to access small data sections, so gp is free.
4181
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004182NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4183or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004184
wdenk2729af92004-05-03 20:45:30 +00004185Memory Management:
4186------------------
wdenkc6097192002-11-03 00:24:07 +00004187
wdenk2729af92004-05-03 20:45:30 +00004188U-Boot runs in system state and uses physical addresses, i.e. the
4189MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004190
wdenk2729af92004-05-03 20:45:30 +00004191The available memory is mapped to fixed addresses using the memory
4192controller. In this process, a contiguous block is formed for each
4193memory type (Flash, SDRAM, SRAM), even when it consists of several
4194physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004195
wdenk2729af92004-05-03 20:45:30 +00004196U-Boot is installed in the first 128 kB of the first Flash bank (on
4197TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4198booting and sizing and initializing DRAM, the code relocates itself
4199to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004200memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004201configuration setting]. Below that, a structure with global Board
4202Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004203
wdenk2729af92004-05-03 20:45:30 +00004204Additionally, some exception handler code is copied to the low 8 kB
4205of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004206
wdenk2729af92004-05-03 20:45:30 +00004207So a typical memory configuration with 16 MB of DRAM could look like
4208this:
wdenkc6097192002-11-03 00:24:07 +00004209
wdenk2729af92004-05-03 20:45:30 +00004210 0x0000 0000 Exception Vector code
4211 :
4212 0x0000 1FFF
4213 0x0000 2000 Free for Application Use
4214 :
4215 :
wdenkc6097192002-11-03 00:24:07 +00004216
wdenk2729af92004-05-03 20:45:30 +00004217 :
4218 :
4219 0x00FB FF20 Monitor Stack (Growing downward)
4220 0x00FB FFAC Board Info Data and permanent copy of global data
4221 0x00FC 0000 Malloc Arena
4222 :
4223 0x00FD FFFF
4224 0x00FE 0000 RAM Copy of Monitor Code
4225 ... eventually: LCD or video framebuffer
4226 ... eventually: pRAM (Protected RAM - unchanged by reset)
4227 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004228
4229
wdenk2729af92004-05-03 20:45:30 +00004230System Initialization:
4231----------------------
wdenkc6097192002-11-03 00:24:07 +00004232
wdenk2729af92004-05-03 20:45:30 +00004233In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004234(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004235configuration for CS0# this is a mirror of the onboard Flash memory.
4236To be able to re-map memory U-Boot then jumps to its link address.
4237To be able to implement the initialization code in C, a (small!)
4238initial stack is set up in the internal Dual Ported RAM (in case CPUs
4239which provide such a feature like MPC8xx or MPC8260), or in a locked
4240part of the data cache. After that, U-Boot initializes the CPU core,
4241the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243Next, all (potentially) available memory banks are mapped using a
4244preliminary mapping. For example, we put them on 512 MB boundaries
4245(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4246on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4247programmed for SDRAM access. Using the temporary configuration, a
4248simple memory test is run that determines the size of the SDRAM
4249banks.
wdenkc6097192002-11-03 00:24:07 +00004250
wdenk2729af92004-05-03 20:45:30 +00004251When there is more than one SDRAM bank, and the banks are of
4252different size, the largest is mapped first. For equal size, the first
4253bank (CS2#) is mapped first. The first mapping is always for address
42540x00000000, with any additional banks following immediately to create
4255contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk2729af92004-05-03 20:45:30 +00004257Then, the monitor installs itself at the upper end of the SDRAM area
4258and allocates memory for use by malloc() and for the global Board
4259Info data; also, the exception vector code is copied to the low RAM
4260pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004261
wdenk2729af92004-05-03 20:45:30 +00004262Only after this relocation will you have a "normal" C environment;
4263until that you are restricted in several ways, mostly because you are
4264running from ROM, and because the code will have to be relocated to a
4265new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004266
4267
wdenk2729af92004-05-03 20:45:30 +00004268U-Boot Porting Guide:
4269----------------------
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk2729af92004-05-03 20:45:30 +00004271[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4272list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004273
4274
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004275int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004276{
4277 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004278
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004279 signal(SIGALRM, no_more_time);
4280 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004281
wdenk2729af92004-05-03 20:45:30 +00004282 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004283 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004284 return 0;
4285 }
4286
wdenk2729af92004-05-03 20:45:30 +00004287 Download latest U-Boot source;
4288
Wolfgang Denk06682362008-12-30 22:56:11 +01004289 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004290
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004291 if (clueless)
4292 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004293
wdenk2729af92004-05-03 20:45:30 +00004294 while (learning) {
4295 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004296 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4297 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004298 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004299 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004300 }
wdenkc6097192002-11-03 00:24:07 +00004301
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004302 if (available_money > toLocalCurrency ($2500))
4303 Buy a BDI3000;
4304 else
wdenk2729af92004-05-03 20:45:30 +00004305 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004306
4307 if (a similar board exists) { /* hopefully... */
4308 cp -a board/<similar> board/<myboard>
4309 cp include/configs/<similar>.h include/configs/<myboard>.h
4310 } else {
4311 Create your own board support subdirectory;
4312 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004313 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004314 Edit new board/<myboard> files
4315 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004316
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004317 while (!accepted) {
4318 while (!running) {
4319 do {
4320 Add / modify source code;
4321 } until (compiles);
4322 Debug;
4323 if (clueless)
4324 email("Hi, I am having problems...");
4325 }
4326 Send patch file to the U-Boot email list;
4327 if (reasonable critiques)
4328 Incorporate improvements from email list code review;
4329 else
4330 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004331 }
wdenkc6097192002-11-03 00:24:07 +00004332
wdenk2729af92004-05-03 20:45:30 +00004333 return 0;
4334}
4335
4336void no_more_time (int sig)
4337{
4338 hire_a_guru();
4339}
wdenkc6097192002-11-03 00:24:07 +00004340
4341
wdenk2729af92004-05-03 20:45:30 +00004342Coding Standards:
4343-----------------
wdenkc6097192002-11-03 00:24:07 +00004344
wdenk2729af92004-05-03 20:45:30 +00004345All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004346coding style; see the file "Documentation/CodingStyle" and the script
4347"scripts/Lindent" in your Linux kernel source directory. In sources
4348originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4349spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004350
Detlev Zundel2c051652006-09-01 15:39:02 +02004351Source files originating from a different project (for example the
4352MTD subsystem) are generally exempt from these guidelines and are not
4353reformated to ease subsequent migration to newer versions of those
4354sources.
4355
4356Please note that U-Boot is implemented in C (and to some small parts in
4357Assembler); no C++ is used, so please do not use C++ style comments (//)
4358in your code.
wdenk2729af92004-05-03 20:45:30 +00004359
4360Please also stick to the following formatting rules:
4361- remove any trailing white space
4362- use TAB characters for indentation, not spaces
4363- make sure NOT to use DOS '\r\n' line feeds
4364- do not add more than 2 empty lines to source files
4365- do not add trailing empty lines to source files
4366
4367Submissions which do not conform to the standards may be returned
4368with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004369
4370
wdenk2729af92004-05-03 20:45:30 +00004371Submitting Patches:
4372-------------------
wdenkc6097192002-11-03 00:24:07 +00004373
wdenk2729af92004-05-03 20:45:30 +00004374Since the number of patches for U-Boot is growing, we need to
4375establish some rules. Submissions which do not conform to these rules
4376may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004377
Magnus Lilja0d28f342008-08-06 19:32:33 +02004378Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004379
Wolfgang Denk06682362008-12-30 22:56:11 +01004380Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4381see http://lists.denx.de/mailman/listinfo/u-boot
4382
wdenk2729af92004-05-03 20:45:30 +00004383When you send a patch, please include the following information with
4384it:
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386* For bug fixes: a description of the bug and how your patch fixes
4387 this bug. Please try to include a way of demonstrating that the
4388 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004389
wdenk2729af92004-05-03 20:45:30 +00004390* For new features: a description of the feature and your
4391 implementation.
wdenkc6097192002-11-03 00:24:07 +00004392
wdenk2729af92004-05-03 20:45:30 +00004393* A CHANGELOG entry as plaintext (separate from the patch)
4394
4395* For major contributions, your entry to the CREDITS file
4396
4397* When you add support for a new board, don't forget to add this
4398 board to the MAKEALL script, too.
4399
4400* If your patch adds new configuration options, don't forget to
4401 document these in the README file.
4402
Wolfgang Denk218ca722008-03-26 10:40:12 +01004403* The patch itself. If you are using git (which is *strongly*
4404 recommended) you can easily generate the patch using the
4405 "git-format-patch". If you then use "git-send-email" to send it to
4406 the U-Boot mailing list, you will avoid most of the common problems
4407 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004408
Wolfgang Denk218ca722008-03-26 10:40:12 +01004409 If you cannot use git, use "diff -purN OLD NEW". If your version of
4410 diff does not support these options, then get the latest version of
4411 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004412
Wolfgang Denk218ca722008-03-26 10:40:12 +01004413 The current directory when running this command shall be the parent
4414 directory of the U-Boot source tree (i. e. please make sure that
4415 your patch includes sufficient directory information for the
4416 affected files).
4417
4418 We prefer patches as plain text. MIME attachments are discouraged,
4419 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004420
4421* If one logical set of modifications affects or creates several
4422 files, all these changes shall be submitted in a SINGLE patch file.
4423
4424* Changesets that contain different, unrelated modifications shall be
4425 submitted as SEPARATE patches, one patch per changeset.
4426
4427
4428Notes:
4429
4430* Before sending the patch, run the MAKEALL script on your patched
4431 source tree and make sure that no errors or warnings are reported
4432 for any of the boards.
4433
4434* Keep your modifications to the necessary minimum: A patch
4435 containing several unrelated changes or arbitrary reformats will be
4436 returned with a request to re-formatting / split it.
4437
4438* If you modify existing code, make sure that your new code does not
4439 add to the memory footprint of the code ;-) Small is beautiful!
4440 When adding new features, these should compile conditionally only
4441 (using #ifdef), and the resulting code with the new feature
4442 disabled must not need more memory than the old code without your
4443 modification.
wdenk90dc6702005-05-03 14:12:25 +00004444
Wolfgang Denk06682362008-12-30 22:56:11 +01004445* Remember that there is a size limit of 100 kB per message on the
4446 u-boot mailing list. Bigger patches will be moderated. If they are
4447 reasonable and not too big, they will be acknowledged. But patches
4448 bigger than the size limit should be avoided.