blob: cdbb9de02c68c8ef8ec94be2d2748463b00d2486 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002# (C) Copyright 2000 - 2009
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Wolfgang Denka9046b92010-06-13 17:48:15 +0200150 /at91rm9200 Files specific to Atmel AT91RM9200 CPU
151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
183 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /nios2 Files generic to Altera NIOS2 architecture
185 /cpu CPU specific files
186 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200187 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /cpu CPU specific files
189 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
190 /mpc5xx Files specific to Freescale MPC5xx CPUs
191 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
192 /mpc8xx Files specific to Freescale MPC8xx CPUs
193 /mpc8220 Files specific to Freescale MPC8220 CPUs
194 /mpc824x Files specific to Freescale MPC824x CPUs
195 /mpc8260 Files specific to Freescale MPC8260 CPUs
196 /mpc85xx Files specific to Freescale MPC85xx CPUs
197 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
198 /lib Architecture specific library files
199 /sh Files generic to SH architecture
200 /cpu CPU specific files
201 /sh2 Files specific to sh2 CPUs
202 /sh3 Files specific to sh3 CPUs
203 /sh4 Files specific to sh4 CPUs
204 /lib Architecture specific library files
205 /sparc Files generic to SPARC architecture
206 /cpu CPU specific files
207 /leon2 Files specific to Gaisler LEON2 SPARC CPU
208 /leon3 Files specific to Gaisler LEON3 SPARC CPU
209 /lib Architecture specific library files
210/api Machine/arch independent API for external apps
211/board Board dependent files
212/common Misc architecture independent functions
213/disk Code for disk drive partition handling
214/doc Documentation (don't expect too much)
215/drivers Commonly used device drivers
216/examples Example code for standalone applications, etc.
217/fs Filesystem code (cramfs, ext2, jffs2, etc.)
218/include Header Files
219/lib Files generic to all architectures
220 /libfdt Library files to support flattened device trees
221 /lzma Library files to support LZMA decompression
222 /lzo Library files to support LZO decompression
223/net Networking code
224/post Power On Self Test
225/rtc Real Time Clock drivers
226/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000227
wdenkc6097192002-11-03 00:24:07 +0000228Software Configuration:
229=======================
230
231Configuration is usually done using C preprocessor defines; the
232rationale behind that is to avoid dead code whenever possible.
233
234There are two classes of configuration variables:
235
236* Configuration _OPTIONS_:
237 These are selectable by the user and have names beginning with
238 "CONFIG_".
239
240* Configuration _SETTINGS_:
241 These depend on the hardware etc. and should not be meddled with if
242 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200243 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000244
245Later we will add a configuration tool - probably similar to or even
246identical to what's used for the Linux kernel. Right now, we have to
247do the configuration by hand, which means creating some symbolic
248links and editing some configuration files. We use the TQM8xxL boards
249as an example here.
250
251
252Selection of Processor Architecture and Board Type:
253---------------------------------------------------
254
255For all supported boards there are ready-to-use default
256configurations available; just type "make <board_name>_config".
257
258Example: For a TQM823L module type:
259
260 cd u-boot
261 make TQM823L_config
262
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200263For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000264e.g. "make cogent_mpc8xx_config". And also configure the cogent
265directory according to the instructions in cogent/README.
266
267
268Configuration Options:
269----------------------
270
271Configuration depends on the combination of board and CPU type; all
272such information is kept in a configuration file
273"include/configs/<board_name>.h".
274
275Example: For a TQM823L module, all configuration settings are in
276"include/configs/TQM823L.h".
277
278
wdenk7f6c2cb2002-11-10 22:06:23 +0000279Many of the options are named exactly as the corresponding Linux
280kernel configuration options. The intention is to make it easier to
281build a config tool - later.
282
283
wdenkc6097192002-11-03 00:24:07 +0000284The following options need to be configured:
285
Kim Phillips26281142007-08-10 13:28:25 -0500286- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000287
Kim Phillips26281142007-08-10 13:28:25 -0500288- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200289
290- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100291 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000292
293- CPU Module Type: (if CONFIG_COGENT is defined)
294 Define exactly one of
295 CONFIG_CMA286_60_OLD
296--- FIXME --- not tested yet:
297 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298 CONFIG_CMA287_23, CONFIG_CMA287_50
299
300- Motherboard Type: (if CONFIG_COGENT is defined)
301 Define exactly one of
302 CONFIG_CMA101, CONFIG_CMA102
303
304- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305 Define one or more of
306 CONFIG_CMA302
307
308- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309 Define one or more of
310 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200311 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000312 a "rotator" |\-/|\-/
313
wdenk2535d602003-07-17 23:16:40 +0000314- Board flavour: (if CONFIG_MPC8260ADS is defined)
315 CONFIG_ADSTYPE
316 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200317 CONFIG_SYS_8260ADS - original MPC8260ADS
318 CONFIG_SYS_8266ADS - MPC8266ADS
319 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
320 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
wdenkc6097192002-11-03 00:24:07 +0000327- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000328 Define exactly one of
329 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200331- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
333 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000334 e.g. if there is no 32KHz
335 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
337 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000338
wdenk66ca92a2004-09-28 17:59:53 +0000339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_8xx_CPUCLK_MIN
341 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000343 See doc/README.MPC866
344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200345 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000346
wdenkba56f622004-02-06 23:19:44 +0000347 Define this to measure the actual CPU clock instead
348 of relying on the correctness of the configured
349 values. Mostly useful for board bringup to make sure
350 the PLL is locked at the intended frequency. Note
351 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200352 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000353
Heiko Schocher506f3912009-03-12 07:37:15 +0100354 CONFIG_SYS_DELAYED_ICACHE
355
356 Define this option if you want to enable the
357 ICache only when Code runs from RAM.
358
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100359- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200360 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100361
362 Defines the Monahans run mode to oscillator
363 ratio. Valid values are 8, 16, 24, 31. The core
364 frequency is this value multiplied by 13 MHz.
365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200366 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200367
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100368 Defines the Monahans turbo mode to oscillator
369 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200370 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100371 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200372
wdenk5da627a2003-10-09 20:09:04 +0000373- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000374 CONFIG_CLOCKS_IN_MHZ
375
376 U-Boot stores all clock information in Hz
377 internally. For binary compatibility with older Linux
378 kernels (which expect the clocks passed in the
379 bd_info data to be in MHz) the environment variable
380 "clocks_in_mhz" can be defined so that U-Boot
381 converts clock data to MHZ before passing it to the
382 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000383 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100384 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000385 default environment.
386
wdenk5da627a2003-10-09 20:09:04 +0000387 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
388
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200389 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000390 expect it to be in bytes, others in MB.
391 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
392
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400393 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200394
395 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400396 passed using flattened device trees (based on open firmware
397 concepts).
398
399 CONFIG_OF_LIBFDT
400 * New libfdt-based support
401 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500402 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400403
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200404 OF_CPU - The proper name of the cpus node (only required for
405 MPC512X and MPC5xxx based boards).
406 OF_SOC - The proper name of the soc node (only required for
407 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200408 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600409 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200410
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200411 boards with QUICC Engines require OF_QE to set UCC MAC
412 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500413
Kumar Gala4e253132006-01-11 13:54:17 -0600414 CONFIG_OF_BOARD_SETUP
415
416 Board code has addition modification that it wants to make
417 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000418
Matthew McClintock02677682006-06-28 10:41:37 -0500419 CONFIG_OF_BOOT_CPU
420
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200421 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500422 param header, the default value is zero if undefined.
423
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200424 CONFIG_OF_IDE_FIXUP
425
426 U-Boot can detect if an IDE device is present or not.
427 If not, and this new config option is activated, U-Boot
428 removes the ATA node from the DTS before booting Linux,
429 so the Linux IDE driver does not probe the device and
430 crash. This is needed for buggy hardware (uc101) where
431 no pull down resistor is connected to the signal IDE5V_DD7.
432
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100433- vxWorks boot parameters:
434
435 bootvx constructs a valid bootline using the following
436 environments variables: bootfile, ipaddr, serverip, hostname.
437 It loads the vxWorks image pointed bootfile.
438
439 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
440 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
441 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
442 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
443
444 CONFIG_SYS_VXWORKS_ADD_PARAMS
445
446 Add it at the end of the bootline. E.g "u=username pw=secret"
447
448 Note: If a "bootargs" environment is defined, it will overwride
449 the defaults discussed just above.
450
wdenk6705d812004-08-02 23:22:59 +0000451- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200452 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000453
454 Define this if you want support for Amba PrimeCell PL010 UARTs.
455
Andreas Engel48d01922008-09-08 14:30:53 +0200456 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000457
458 Define this if you want support for Amba PrimeCell PL011 UARTs.
459
460 CONFIG_PL011_CLOCK
461
462 If you have Amba PrimeCell PL011 UARTs, set this variable to
463 the clock speed of the UARTs.
464
465 CONFIG_PL01x_PORTS
466
467 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
468 define this to a list of base addresses for each (supported)
469 port. See e.g. include/configs/versatile.h
470
471
wdenkc6097192002-11-03 00:24:07 +0000472- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000473 Depending on board, define exactly one serial port
474 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
475 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
476 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000477
478 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
479 port routines must be defined elsewhere
480 (i.e. serial_init(), serial_getc(), ...)
481
482 CONFIG_CFB_CONSOLE
483 Enables console device for a color framebuffer. Needs following
484 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
485 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
486 (default big endian)
487 VIDEO_HW_RECTFILL graphic chip supports
488 rectangle fill
489 (cf. smiLynxEM)
490 VIDEO_HW_BITBLT graphic chip supports
491 bit-blit (cf. smiLynxEM)
492 VIDEO_VISIBLE_COLS visible pixel columns
493 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000494 VIDEO_VISIBLE_ROWS visible pixel rows
495 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000496 VIDEO_DATA_FORMAT graphic data format
497 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000498 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000499 VIDEO_KBD_INIT_FCT keyboard int fct
500 (i.e. i8042_kbd_init())
501 VIDEO_TSTC_FCT test char fct
502 (i.e. i8042_tstc)
503 VIDEO_GETC_FCT get char fct
504 (i.e. i8042_getc)
505 CONFIG_CONSOLE_CURSOR cursor drawing on/off
506 (requires blink timer
507 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200508 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000509 CONFIG_CONSOLE_TIME display time/date info in
510 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500511 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000512 CONFIG_VIDEO_LOGO display Linux logo in
513 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000514 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
515 linux_logo.h for logo.
516 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000517 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200518 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000519 the logo
520
wdenk43d96162003-03-06 00:02:04 +0000521 When CONFIG_CFB_CONSOLE is defined, video console is
522 default i/o. Serial console can be forced with
523 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000524
wdenkd4ca31c2004-01-02 14:00:00 +0000525 When CONFIG_SILENT_CONSOLE is defined, all console
526 messages (by U-Boot and Linux!) can be silenced with
527 the "silent" environment variable. See
528 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000529
wdenkc6097192002-11-03 00:24:07 +0000530- Console Baudrate:
531 CONFIG_BAUDRATE - in bps
532 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200533 CONFIG_SYS_BAUDRATE_TABLE, see below.
534 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000535
Heiko Schocherc92fac92009-01-30 12:55:38 +0100536- Console Rx buffer length
537 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
538 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100539 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100540 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
541 must be defined, to setup the maximum idle timeout for
542 the SMC.
543
wdenkc6097192002-11-03 00:24:07 +0000544- Boot Delay: CONFIG_BOOTDELAY - in seconds
545 Delay before automatically booting the default image;
546 set to -1 to disable autoboot.
547
548 See doc/README.autoboot for these options that
549 work with CONFIG_BOOTDELAY. None are required.
550 CONFIG_BOOT_RETRY_TIME
551 CONFIG_BOOT_RETRY_MIN
552 CONFIG_AUTOBOOT_KEYED
553 CONFIG_AUTOBOOT_PROMPT
554 CONFIG_AUTOBOOT_DELAY_STR
555 CONFIG_AUTOBOOT_STOP_STR
556 CONFIG_AUTOBOOT_DELAY_STR2
557 CONFIG_AUTOBOOT_STOP_STR2
558 CONFIG_ZERO_BOOTDELAY_CHECK
559 CONFIG_RESET_TO_RETRY
560
561- Autoboot Command:
562 CONFIG_BOOTCOMMAND
563 Only needed when CONFIG_BOOTDELAY is enabled;
564 define a command string that is automatically executed
565 when no character is read on the console interface
566 within "Boot Delay" after reset.
567
568 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000569 This can be used to pass arguments to the bootm
570 command. The value of CONFIG_BOOTARGS goes into the
571 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000572
573 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000574 The value of these goes into the environment as
575 "ramboot" and "nfsboot" respectively, and can be used
576 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200577 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000578
579- Pre-Boot Commands:
580 CONFIG_PREBOOT
581
582 When this option is #defined, the existence of the
583 environment variable "preboot" will be checked
584 immediately before starting the CONFIG_BOOTDELAY
585 countdown and/or running the auto-boot command resp.
586 entering interactive mode.
587
588 This feature is especially useful when "preboot" is
589 automatically generated or modified. For an example
590 see the LWMON board specific code: here "preboot" is
591 modified when the user holds down a certain
592 combination of keys on the (special) keyboard when
593 booting the systems
594
595- Serial Download Echo Mode:
596 CONFIG_LOADS_ECHO
597 If defined to 1, all characters received during a
598 serial download (using the "loads" command) are
599 echoed back. This might be needed by some terminal
600 emulations (like "cu"), but may as well just take
601 time on others. This setting #define's the initial
602 value of the "loads_echo" environment variable.
603
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500604- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000605 CONFIG_KGDB_BAUDRATE
606 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200607 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000608
609- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500610 Monitor commands can be included or excluded
611 from the build by using the #include files
612 "config_cmd_all.h" and #undef'ing unwanted
613 commands, or using "config_cmd_default.h"
614 and augmenting with additional #define's
615 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000616
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500617 The default command configuration includes all commands
618 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000619
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500620 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500621 CONFIG_CMD_BDI bdinfo
622 CONFIG_CMD_BEDBUG * Include BedBug Debugger
623 CONFIG_CMD_BMP * BMP support
624 CONFIG_CMD_BSP * Board specific commands
625 CONFIG_CMD_BOOTD bootd
626 CONFIG_CMD_CACHE * icache, dcache
627 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500628 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500629 CONFIG_CMD_DATE * support for RTC, date/time...
630 CONFIG_CMD_DHCP * DHCP support
631 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600632 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
633 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
634 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
635 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500636 CONFIG_CMD_DTT * Digital Therm and Thermostat
637 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500638 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500639 CONFIG_CMD_EEPROM * EEPROM read/write support
640 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500641 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500642 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500643 CONFIG_CMD_FDC * Floppy Disk Support
644 CONFIG_CMD_FAT * FAT partition support
645 CONFIG_CMD_FDOS * Dos diskette Support
646 CONFIG_CMD_FLASH flinfo, erase, protect
647 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500648 CONFIG_CMD_GO * the 'go' command (exec code)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500649 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
650 CONFIG_CMD_I2C * I2C serial bus support
651 CONFIG_CMD_IDE * IDE harddisk support
652 CONFIG_CMD_IMI iminfo
653 CONFIG_CMD_IMLS List all found images
654 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500655 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500656 CONFIG_CMD_IRQ * irqinfo
657 CONFIG_CMD_ITEST Integer/string test of 2 values
658 CONFIG_CMD_JFFS2 * JFFS2 Support
659 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500660 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500661 CONFIG_CMD_LOADB loadb
662 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400663 CONFIG_CMD_MD5SUM print md5 message digest
664 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500665 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
666 loop, loopw, mtest
667 CONFIG_CMD_MISC Misc functions like sleep etc
668 CONFIG_CMD_MMC * MMC memory mapped support
669 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100670 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500671 CONFIG_CMD_NAND * NAND support
672 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600673 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
674 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500675 CONFIG_CMD_PCI * pciinfo
676 CONFIG_CMD_PCMCIA * PCMCIA support
677 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
678 host
679 CONFIG_CMD_PORTIO * Port I/O
680 CONFIG_CMD_REGINFO * Register dump
681 CONFIG_CMD_RUN run command in env variable
682 CONFIG_CMD_SAVES * save S record dump
683 CONFIG_CMD_SCSI * SCSI Support
684 CONFIG_CMD_SDRAM * print SDRAM configuration information
685 (requires CONFIG_CMD_I2C)
686 CONFIG_CMD_SETGETDCR Support for DCR Register access
687 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100688 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400689 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200690 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500691 CONFIG_CMD_SPI * SPI serial bus support
692 CONFIG_CMD_USB * USB support
693 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500694 CONFIG_CMD_CDP * Cisco Discover Protocol support
695 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000696
wdenkc6097192002-11-03 00:24:07 +0000697
698 EXAMPLE: If you want all functions except of network
699 support you can write:
700
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500701 #include "config_cmd_all.h"
702 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000703
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400704 Other Commands:
705 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000706
707 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500708 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000709 what you (and your U-Boot users) are doing. Data
710 cache cannot be enabled on systems like the 8xx or
711 8260 (where accesses to the IMMR region must be
712 uncached), and it cannot be disabled on all other
713 systems where we (mis-) use the data cache to hold an
714 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000715
716
717 XXX - this list needs to get updated!
718
719- Watchdog:
720 CONFIG_WATCHDOG
721 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000722 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000723 code for a watchdog. For the 8xx and 8260 CPUs, the
724 SIU Watchdog feature is enabled in the SYPCR
725 register.
726
stroesec1551ea2003-04-04 15:53:41 +0000727- U-Boot Version:
728 CONFIG_VERSION_VARIABLE
729 If this variable is defined, an environment variable
730 named "ver" is created by U-Boot showing the U-Boot
731 version as printed by the "version" command.
732 This variable is readonly.
733
wdenkc6097192002-11-03 00:24:07 +0000734- Real-Time Clock:
735
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500736 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000737 has to be selected, too. Define exactly one of the
738 following options:
739
740 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
741 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200742 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000743 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000744 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000745 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000746 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000747 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100748 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000749 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200750 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200751 CONFIG_SYS_RV3029_TCR - enable trickle charger on
752 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000753
wdenkb37c7e52003-06-30 16:24:52 +0000754 Note that if the RTC uses I2C, then the I2C interface
755 must also be configured. See I2C Support, below.
756
Peter Tysere92739d2008-12-17 16:36:21 -0600757- GPIO Support:
758 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
759 CONFIG_PCA953X_INFO - enable pca953x info command
760
Chris Packham5dec49c2010-12-19 10:12:13 +0000761 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
762 chip-ngpio pairs that tell the PCA953X driver the number of
763 pins supported by a particular chip.
764
Peter Tysere92739d2008-12-17 16:36:21 -0600765 Note that if the GPIO device uses I2C, then the I2C interface
766 must also be configured. See I2C Support, below.
767
wdenkc6097192002-11-03 00:24:07 +0000768- Timestamp Support:
769
wdenk43d96162003-03-06 00:02:04 +0000770 When CONFIG_TIMESTAMP is selected, the timestamp
771 (date and time) of an image is printed by image
772 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500773 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000774
775- Partition Support:
776 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400777 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000778
Wolfgang Denk218ca722008-03-26 10:40:12 +0100779 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
780 CONFIG_CMD_SCSI) you must configure support for at
781 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000782
783- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000784 CONFIG_IDE_RESET_ROUTINE - this is defined in several
785 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000786
wdenk4d13cba2004-03-14 14:09:05 +0000787 CONFIG_IDE_RESET - is this is defined, IDE Reset will
788 be performed by calling the function
789 ide_set_reset(int reset)
790 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000791
792- ATAPI Support:
793 CONFIG_ATAPI
794
795 Set this to enable ATAPI support.
796
wdenkc40b2952004-03-13 23:29:43 +0000797- LBA48 Support
798 CONFIG_LBA48
799
800 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100801 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000802 Whithout these , LBA48 support uses 32bit variables and will 'only'
803 support disks up to 2.1TB.
804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200805 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000806 When enabled, makes the IDE subsystem use 64bit sector addresses.
807 Default is 32bit.
808
wdenkc6097192002-11-03 00:24:07 +0000809- SCSI Support:
810 At the moment only there is only support for the
811 SYM53C8XX SCSI controller; define
812 CONFIG_SCSI_SYM53C8XX to enable it.
813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200814 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
815 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
816 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000817 maximum numbers of LUNs, SCSI ID's and target
818 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200819 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000820
821- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000822 CONFIG_E1000
823 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000824
Andre Schwarzac3315c2008-03-06 16:45:44 +0100825 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200826 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100827
wdenkc6097192002-11-03 00:24:07 +0000828 CONFIG_EEPRO100
829 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200830 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000831 write routine for first time initialisation.
832
833 CONFIG_TULIP
834 Support for Digital 2114x chips.
835 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
836 modem chip initialisation (KS8761/QS6611).
837
838 CONFIG_NATSEMI
839 Support for National dp83815 chips.
840
841 CONFIG_NS8382X
842 Support for National dp8382[01] gigabit chips.
843
wdenk45219c42003-05-12 21:50:16 +0000844- NETWORK Support (other):
845
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100846 CONFIG_DRIVER_AT91EMAC
847 Support for AT91RM9200 EMAC.
848
849 CONFIG_RMII
850 Define this to use reduced MII inteface
851
852 CONFIG_DRIVER_AT91EMAC_QUIET
853 If this defined, the driver is quiet.
854 The driver doen't show link status messages.
855
wdenk45219c42003-05-12 21:50:16 +0000856 CONFIG_DRIVER_LAN91C96
857 Support for SMSC's LAN91C96 chips.
858
859 CONFIG_LAN91C96_BASE
860 Define this to hold the physical address
861 of the LAN91C96's I/O space
862
863 CONFIG_LAN91C96_USE_32_BIT
864 Define this to enable 32 bit addressing
865
wdenkf39748a2004-06-09 13:37:52 +0000866 CONFIG_DRIVER_SMC91111
867 Support for SMSC's LAN91C111 chip
868
869 CONFIG_SMC91111_BASE
870 Define this to hold the physical address
871 of the device (I/O space)
872
873 CONFIG_SMC_USE_32_BIT
874 Define this if data bus is 32 bits
875
876 CONFIG_SMC_USE_IOFUNCS
877 Define this to use i/o functions instead of macros
878 (some hardware wont work with macros)
879
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800880 CONFIG_FTGMAC100
881 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
882
883 CONFIG_FTGMAC100_EGIGA
884 Define this to use GE link update with gigabit PHY.
885 Define this if FTGMAC100 is connected to gigabit PHY.
886 If your system has 10/100 PHY only, it might not occur
887 wrong behavior. Because PHY usually return timeout or
888 useless data when polling gigabit status and gigabit
889 control registers. This behavior won't affect the
890 correctnessof 10/100 link speed update.
891
Mike Rapoportc2fff332009-11-11 10:03:03 +0200892 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200893 Support for SMSC's LAN911x and LAN921x chips
894
Mike Rapoportc2fff332009-11-11 10:03:03 +0200895 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200896 Define this to hold the physical address
897 of the device (I/O space)
898
Mike Rapoportc2fff332009-11-11 10:03:03 +0200899 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200900 Define this if data bus is 32 bits
901
Mike Rapoportc2fff332009-11-11 10:03:03 +0200902 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200903 Define this if data bus is 16 bits. If your processor
904 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200905 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200906
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900907 CONFIG_SH_ETHER
908 Support for Renesas on-chip Ethernet controller
909
910 CONFIG_SH_ETHER_USE_PORT
911 Define the number of ports to be used
912
913 CONFIG_SH_ETHER_PHY_ADDR
914 Define the ETH PHY's address
915
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900916 CONFIG_SH_ETHER_CACHE_WRITEBACK
917 If this option is set, the driver enables cache flush.
918
wdenkc6097192002-11-03 00:24:07 +0000919- USB Support:
920 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000921 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000922 CONFIG_USB_UHCI to enable it.
923 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000924 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000925 storage devices.
926 Note:
927 Supported are USB Keyboards and USB Floppy drives
928 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000929 MPC5200 USB requires additional defines:
930 CONFIG_USB_CLOCK
931 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500932 CONFIG_PSC3_USB
933 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000934 CONFIG_USB_CONFIG
935 for differential drivers: 0x00001000
936 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500937 for differential drivers on PSC3: 0x00000100
938 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200939 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200940 May be defined to allow interrupt polling
941 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000942
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200943- USB Device:
944 Define the below if you wish to use the USB console.
945 Once firmware is rebuilt from a serial console issue the
946 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200947 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200948 it has found a new device. The environment variable usbtty
949 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200950 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200951 Common Device Class Abstract Control Model serial device.
952 If you select usbtty = gserial you should be able to enumerate
953 a Linux host by
954 # modprobe usbserial vendor=0xVendorID product=0xProductID
955 else if using cdc_acm, simply setting the environment
956 variable usbtty to be cdc_acm should suffice. The following
957 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200958
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200959 CONFIG_USB_DEVICE
960 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000961
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200962 CONFIG_USB_TTY
963 Define this to have a tty type of device available to
964 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200965
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200966 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200967 Define this if you want stdin, stdout &/or stderr to
968 be set to usbtty.
969
970 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200971 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200972 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200973 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200975 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200976 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200977 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200978
Wolfgang Denk386eda02006-06-14 18:14:56 +0200979 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200980 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200981 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200982 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
983 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
984 should pretend to be a Linux device to it's target host.
985
986 CONFIG_USBD_MANUFACTURER
987 Define this string as the name of your company for
988 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200989
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200990 CONFIG_USBD_PRODUCT_NAME
991 Define this string as the name of your product
992 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
993
994 CONFIG_USBD_VENDORID
995 Define this as your assigned Vendor ID from the USB
996 Implementors Forum. This *must* be a genuine Vendor ID
997 to avoid polluting the USB namespace.
998 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200999
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001000 CONFIG_USBD_PRODUCTID
1001 Define this as the unique Product ID
1002 for your device
1003 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001004
1005
1006- MMC Support:
1007 The MMC controller on the Intel PXA is supported. To
1008 enable this define CONFIG_MMC. The MMC can be
1009 accessed from the boot prompt by mapping the device
1010 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001011 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1012 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001013
wdenk6705d812004-08-02 23:22:59 +00001014- Journaling Flash filesystem support:
1015 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1016 CONFIG_JFFS2_NAND_DEV
1017 Define these for a default partition on a NAND device
1018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001019 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1020 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001021 Define these for a default partition on a NOR device
1022
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001023 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001024 Define this to create an own partition. You have to provide a
1025 function struct part_info* jffs2_part_info(int part_num)
1026
1027 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001028 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001029 to disable the command chpart. This is the default when you
1030 have not defined a custom partition
1031
wdenkc6097192002-11-03 00:24:07 +00001032- Keyboard Support:
1033 CONFIG_ISA_KEYBOARD
1034
1035 Define this to enable standard (PC-Style) keyboard
1036 support
1037
1038 CONFIG_I8042_KBD
1039 Standard PC keyboard driver with US (is default) and
1040 GERMAN key layout (switch via environment 'keymap=de') support.
1041 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1042 for cfb_console. Supports cursor blinking.
1043
1044- Video support:
1045 CONFIG_VIDEO
1046
1047 Define this to enable video support (for output to
1048 video).
1049
1050 CONFIG_VIDEO_CT69000
1051
1052 Enable Chips & Technologies 69000 Video chip
1053
1054 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001055 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001056 video output is selected via environment 'videoout'
1057 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1058 assumed.
wdenkc6097192002-11-03 00:24:07 +00001059
wdenkb79a11c2004-03-25 15:14:43 +00001060 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001061 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001062 are possible:
1063 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001064 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001065
1066 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1067 -------------+---------------------------------------------
1068 8 bits | 0x301* 0x303 0x305 0x161 0x307
1069 15 bits | 0x310 0x313 0x316 0x162 0x319
1070 16 bits | 0x311 0x314 0x317 0x163 0x31A
1071 24 bits | 0x312 0x315 0x318 ? 0x31B
1072 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001073 (i.e. setenv videomode 317; saveenv; reset;)
1074
wdenkb79a11c2004-03-25 15:14:43 +00001075 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001076 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001077
1078
stroesec1551ea2003-04-04 15:53:41 +00001079 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001080 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001081 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1082 or CONFIG_VIDEO_SED13806_16BPP
1083
Timur Tabi7d3053f2011-02-15 17:09:19 -06001084 CONFIG_FSL_DIU_FB
1085 Enable the Freescale DIU video driver. Reference boards for
1086 SOCs that have a DIU should define this macro to enable DIU
1087 support, and should also define these other macros:
1088
1089 CONFIG_SYS_DIU_ADDR
1090 CONFIG_VIDEO
1091 CONFIG_CMD_BMP
1092 CONFIG_CFB_CONSOLE
1093 CONFIG_VIDEO_SW_CURSOR
1094 CONFIG_VGA_AS_SINGLE_DEVICE
1095 CONFIG_VIDEO_LOGO
1096 CONFIG_VIDEO_BMP_LOGO
1097
1098 The DIU driver will look for the 'monitor' environment variable,
1099 and if defined, enable the DIU as a console during boot. This
1100 variable should be set to one of these values:
1101
1102 '0' Output video to the DVI connector
1103 '1' Output video to the LVDS connector
1104 '2' Output video to the Dual-Link LVDS connector
1105
wdenk682011f2003-06-03 23:54:09 +00001106- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001107 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001108
wdenk8bde7f72003-06-27 21:31:46 +00001109 Define this to enable a custom keyboard support.
1110 This simply calls drv_keyboard_init() which must be
1111 defined in your board-specific files.
1112 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001113
wdenkc6097192002-11-03 00:24:07 +00001114- LCD Support: CONFIG_LCD
1115
1116 Define this to enable LCD support (for output to LCD
1117 display); also select one of the supported displays
1118 by defining one of these:
1119
Stelian Pop39cf4802008-05-09 21:57:18 +02001120 CONFIG_ATMEL_LCD:
1121
1122 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1123
wdenkfd3103b2003-11-25 16:55:19 +00001124 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001125
wdenkfd3103b2003-11-25 16:55:19 +00001126 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001127
wdenkfd3103b2003-11-25 16:55:19 +00001128 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001129
wdenkfd3103b2003-11-25 16:55:19 +00001130 NEC NL6448BC20-08. 6.5", 640x480.
1131 Active, color, single scan.
1132
1133 CONFIG_NEC_NL6448BC33_54
1134
1135 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001136 Active, color, single scan.
1137
1138 CONFIG_SHARP_16x9
1139
1140 Sharp 320x240. Active, color, single scan.
1141 It isn't 16x9, and I am not sure what it is.
1142
1143 CONFIG_SHARP_LQ64D341
1144
1145 Sharp LQ64D341 display, 640x480.
1146 Active, color, single scan.
1147
1148 CONFIG_HLD1045
1149
1150 HLD1045 display, 640x480.
1151 Active, color, single scan.
1152
1153 CONFIG_OPTREX_BW
1154
1155 Optrex CBL50840-2 NF-FW 99 22 M5
1156 or
1157 Hitachi LMG6912RPFC-00T
1158 or
1159 Hitachi SP14Q002
1160
1161 320x240. Black & white.
1162
1163 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001164 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001165
wdenk7152b1d2003-09-05 23:19:14 +00001166- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001167
wdenk8bde7f72003-06-27 21:31:46 +00001168 If this option is set, the environment is checked for
1169 a variable "splashimage". If found, the usual display
1170 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001171 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001172 specified in "splashimage" is loaded instead. The
1173 console is redirected to the "nulldev", too. This
1174 allows for a "silent" boot where a splash screen is
1175 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001176
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001177 CONFIG_SPLASH_SCREEN_ALIGN
1178
1179 If this option is set the splash image can be freely positioned
1180 on the screen. Environment variable "splashpos" specifies the
1181 position as "x,y". If a positive number is given it is used as
1182 number of pixel from left/top. If a negative number is given it
1183 is used as number of pixel from right/bottom. You can also
1184 specify 'm' for centering the image.
1185
1186 Example:
1187 setenv splashpos m,m
1188 => image at center of screen
1189
1190 setenv splashpos 30,20
1191 => image at x = 30 and y = 20
1192
1193 setenv splashpos -10,m
1194 => vertically centered image
1195 at x = dspWidth - bmpWidth - 9
1196
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001197- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1198
1199 If this option is set, additionally to standard BMP
1200 images, gzipped BMP images can be displayed via the
1201 splashscreen support or the bmp command.
1202
Anatolij Gustschind5011762010-03-15 14:50:25 +01001203- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1204
1205 If this option is set, 8-bit RLE compressed BMP images
1206 can be displayed via the splashscreen support or the
1207 bmp command.
1208
wdenkc29fdfc2003-08-29 20:57:53 +00001209- Compression support:
1210 CONFIG_BZIP2
1211
1212 If this option is set, support for bzip2 compressed
1213 images is included. If not, only uncompressed and gzip
1214 compressed images are supported.
1215
wdenk42d1f032003-10-15 23:53:47 +00001216 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001217 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001218 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001219
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001220 CONFIG_LZMA
1221
1222 If this option is set, support for lzma compressed
1223 images is included.
1224
1225 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1226 requires an amount of dynamic memory that is given by the
1227 formula:
1228
1229 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1230
1231 Where lc and lp stand for, respectively, Literal context bits
1232 and Literal pos bits.
1233
1234 This value is upper-bounded by 14MB in the worst case. Anyway,
1235 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1236 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1237 a very small buffer.
1238
1239 Use the lzmainfo tool to determinate the lc and lp values and
1240 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001241 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001242
wdenk17ea1172004-06-06 21:51:03 +00001243- MII/PHY support:
1244 CONFIG_PHY_ADDR
1245
1246 The address of PHY on MII bus.
1247
1248 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1249
1250 The clock frequency of the MII bus
1251
1252 CONFIG_PHY_GIGE
1253
1254 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001255 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001256
1257 CONFIG_PHY_RESET_DELAY
1258
1259 Some PHY like Intel LXT971A need extra delay after
1260 reset before any MII register access is possible.
1261 For such PHY, set this option to the usec delay
1262 required. (minimum 300usec for LXT971A)
1263
1264 CONFIG_PHY_CMD_DELAY (ppc4xx)
1265
1266 Some PHY like Intel LXT971A need extra delay after
1267 command issued before MII status register can be read
1268
wdenkc6097192002-11-03 00:24:07 +00001269- Ethernet address:
1270 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001271 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001272 CONFIG_ETH2ADDR
1273 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001274 CONFIG_ETH4ADDR
1275 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001276
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001277 Define a default value for Ethernet address to use
1278 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001279 is not determined automatically.
1280
1281- IP address:
1282 CONFIG_IPADDR
1283
1284 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001285 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001286 determined through e.g. bootp.
1287
1288- Server IP address:
1289 CONFIG_SERVERIP
1290
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001291 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001292 server to contact when using the "tftboot" command.
1293
Robin Getz97cfe862009-07-21 12:15:28 -04001294 CONFIG_KEEP_SERVERADDR
1295
1296 Keeps the server's MAC address, in the env 'serveraddr'
1297 for passing to bootargs (like Linux's netconsole option)
1298
David Updegraff53a5c422007-06-11 10:41:07 -05001299- Multicast TFTP Mode:
1300 CONFIG_MCAST_TFTP
1301
1302 Defines whether you want to support multicast TFTP as per
1303 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001304 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001305 driver in use must provide a function: mcast() to join/leave a
1306 multicast group.
1307
1308 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001309- BOOTP Recovery Mode:
1310 CONFIG_BOOTP_RANDOM_DELAY
1311
1312 If you have many targets in a network that try to
1313 boot using BOOTP, you may want to avoid that all
1314 systems send out BOOTP requests at precisely the same
1315 moment (which would happen for instance at recovery
1316 from a power failure, when all systems will try to
1317 boot, thus flooding the BOOTP server. Defining
1318 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1319 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001320 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001321
1322 1st BOOTP request: delay 0 ... 1 sec
1323 2nd BOOTP request: delay 0 ... 2 sec
1324 3rd BOOTP request: delay 0 ... 4 sec
1325 4th and following
1326 BOOTP requests: delay 0 ... 8 sec
1327
stroesefe389a82003-08-28 14:17:32 +00001328- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001329 You can fine tune the DHCP functionality by defining
1330 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001331
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001332 CONFIG_BOOTP_SUBNETMASK
1333 CONFIG_BOOTP_GATEWAY
1334 CONFIG_BOOTP_HOSTNAME
1335 CONFIG_BOOTP_NISDOMAIN
1336 CONFIG_BOOTP_BOOTPATH
1337 CONFIG_BOOTP_BOOTFILESIZE
1338 CONFIG_BOOTP_DNS
1339 CONFIG_BOOTP_DNS2
1340 CONFIG_BOOTP_SEND_HOSTNAME
1341 CONFIG_BOOTP_NTPSERVER
1342 CONFIG_BOOTP_TIMEOFFSET
1343 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001344
Wilson Callan5d110f02007-07-28 10:56:13 -04001345 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1346 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001347
1348 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1349 serverip from a DHCP server, it is possible that more
1350 than one DNS serverip is offered to the client.
1351 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1352 serverip will be stored in the additional environment
1353 variable "dnsip2". The first DNS serverip is always
1354 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001355 is defined.
stroesefe389a82003-08-28 14:17:32 +00001356
1357 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1358 to do a dynamic update of a DNS server. To do this, they
1359 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001360 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001361 of the "hostname" environment variable is passed as
1362 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001363
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001364 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1365
1366 A 32bit value in microseconds for a delay between
1367 receiving a "DHCP Offer" and sending the "DHCP Request".
1368 This fixes a problem with certain DHCP servers that don't
1369 respond 100% of the time to a "DHCP request". E.g. On an
1370 AT91RM9200 processor running at 180MHz, this delay needed
1371 to be *at least* 15,000 usec before a Windows Server 2003
1372 DHCP server would reply 100% of the time. I recommend at
1373 least 50,000 usec to be safe. The alternative is to hope
1374 that one of the retries will be successful but note that
1375 the DHCP timeout and retry process takes a longer than
1376 this delay.
1377
wdenka3d991b2004-04-15 21:48:45 +00001378 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001379 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001380
1381 The device id used in CDP trigger frames.
1382
1383 CONFIG_CDP_DEVICE_ID_PREFIX
1384
1385 A two character string which is prefixed to the MAC address
1386 of the device.
1387
1388 CONFIG_CDP_PORT_ID
1389
1390 A printf format string which contains the ascii name of
1391 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001392 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001393
1394 CONFIG_CDP_CAPABILITIES
1395
1396 A 32bit integer which indicates the device capabilities;
1397 0x00000010 for a normal host which does not forwards.
1398
1399 CONFIG_CDP_VERSION
1400
1401 An ascii string containing the version of the software.
1402
1403 CONFIG_CDP_PLATFORM
1404
1405 An ascii string containing the name of the platform.
1406
1407 CONFIG_CDP_TRIGGER
1408
1409 A 32bit integer sent on the trigger.
1410
1411 CONFIG_CDP_POWER_CONSUMPTION
1412
1413 A 16bit integer containing the power consumption of the
1414 device in .1 of milliwatts.
1415
1416 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1417
1418 A byte containing the id of the VLAN.
1419
wdenkc6097192002-11-03 00:24:07 +00001420- Status LED: CONFIG_STATUS_LED
1421
1422 Several configurations allow to display the current
1423 status using a LED. For instance, the LED will blink
1424 fast while running U-Boot code, stop blinking as
1425 soon as a reply to a BOOTP request was received, and
1426 start blinking slow once the Linux kernel is running
1427 (supported by a status LED driver in the Linux
1428 kernel). Defining CONFIG_STATUS_LED enables this
1429 feature in U-Boot.
1430
1431- CAN Support: CONFIG_CAN_DRIVER
1432
1433 Defining CONFIG_CAN_DRIVER enables CAN driver support
1434 on those systems that support this (optional)
1435 feature, like the TQM8xxL modules.
1436
1437- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1438
wdenkb37c7e52003-06-30 16:24:52 +00001439 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001440 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001441 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001442
wdenk945af8d2003-07-16 21:53:01 +00001443 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001444 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001445 CONFIG_COMMANDS) and communicate with i2c based realtime
1446 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001447 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001448
Ben Warrenbb99ad62006-09-07 16:50:54 -04001449 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001450
wdenk945af8d2003-07-16 21:53:01 +00001451 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001452 bit-banging) driver instead of CPM or similar hardware
1453 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001454
wdenk945af8d2003-07-16 21:53:01 +00001455 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001456 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001457
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001458 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001459 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001460 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001461 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001462
Peter Tyser8d321b82010-04-12 22:28:21 -05001463 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001464 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001465 and so its address should therefore be cleared to 0 (See,
1466 eg, MPC823e User's Manual p.16-473). So, set
1467 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001468
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001469 CONFIG_SYS_I2C_INIT_MPC5XXX
1470
1471 When a board is reset during an i2c bus transfer
1472 chips might think that the current transfer is still
1473 in progress. Reset the slave devices by sending start
1474 commands until the slave device responds.
1475
wdenk945af8d2003-07-16 21:53:01 +00001476 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001477
1478 If you use the software i2c interface (CONFIG_SOFT_I2C)
1479 then the following macros need to be defined (examples are
1480 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001481
1482 I2C_INIT
1483
wdenkb37c7e52003-06-30 16:24:52 +00001484 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001485 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001486
wdenkba56f622004-02-06 23:19:44 +00001487 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001488
wdenkc6097192002-11-03 00:24:07 +00001489 I2C_PORT
1490
wdenk43d96162003-03-06 00:02:04 +00001491 (Only for MPC8260 CPU). The I/O port to use (the code
1492 assumes both bits are on the same port). Valid values
1493 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001494
1495 I2C_ACTIVE
1496
1497 The code necessary to make the I2C data line active
1498 (driven). If the data line is open collector, this
1499 define can be null.
1500
wdenkb37c7e52003-06-30 16:24:52 +00001501 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1502
wdenkc6097192002-11-03 00:24:07 +00001503 I2C_TRISTATE
1504
1505 The code necessary to make the I2C data line tri-stated
1506 (inactive). If the data line is open collector, this
1507 define can be null.
1508
wdenkb37c7e52003-06-30 16:24:52 +00001509 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1510
wdenkc6097192002-11-03 00:24:07 +00001511 I2C_READ
1512
1513 Code that returns TRUE if the I2C data line is high,
1514 FALSE if it is low.
1515
wdenkb37c7e52003-06-30 16:24:52 +00001516 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1517
wdenkc6097192002-11-03 00:24:07 +00001518 I2C_SDA(bit)
1519
1520 If <bit> is TRUE, sets the I2C data line high. If it
1521 is FALSE, it clears it (low).
1522
wdenkb37c7e52003-06-30 16:24:52 +00001523 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001524 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001525 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001526
wdenkc6097192002-11-03 00:24:07 +00001527 I2C_SCL(bit)
1528
1529 If <bit> is TRUE, sets the I2C clock line high. If it
1530 is FALSE, it clears it (low).
1531
wdenkb37c7e52003-06-30 16:24:52 +00001532 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001533 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001534 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001535
wdenkc6097192002-11-03 00:24:07 +00001536 I2C_DELAY
1537
1538 This delay is invoked four times per clock cycle so this
1539 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001540 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001541 like:
1542
wdenkb37c7e52003-06-30 16:24:52 +00001543 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001544
Mike Frysinger793b5722010-07-21 13:38:02 -04001545 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1546
1547 If your arch supports the generic GPIO framework (asm/gpio.h),
1548 then you may alternatively define the two GPIOs that are to be
1549 used as SCL / SDA. Any of the previous I2C_xxx macros will
1550 have GPIO-based defaults assigned to them as appropriate.
1551
1552 You should define these to the GPIO value as given directly to
1553 the generic GPIO functions.
1554
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001555 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001556
wdenk8bde7f72003-06-27 21:31:46 +00001557 When a board is reset during an i2c bus transfer
1558 chips might think that the current transfer is still
1559 in progress. On some boards it is possible to access
1560 the i2c SCLK line directly, either by using the
1561 processor pin as a GPIO or by having a second pin
1562 connected to the bus. If this option is defined a
1563 custom i2c_init_board() routine in boards/xxx/board.c
1564 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001565
Richard Retanubun26a33502010-04-12 15:08:17 -04001566 CONFIG_SYS_I2C_BOARD_LATE_INIT
1567
1568 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1569 defined a custom i2c_board_late_init() routine in
1570 boards/xxx/board.c is run AFTER the operations in i2c_init()
1571 is completed. This callpoint can be used to unreset i2c bus
1572 using CPU i2c controller register accesses for CPUs whose i2c
1573 controller provide such a method. It is called at the end of
1574 i2c_init() to allow i2c_init operations to setup the i2c bus
1575 controller on the CPU (e.g. setting bus speed & slave address).
1576
wdenk17ea1172004-06-06 21:51:03 +00001577 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1578
1579 This option enables configuration of bi_iic_fast[] flags
1580 in u-boot bd_info structure based on u-boot environment
1581 variable "i2cfast". (see also i2cfast)
1582
Ben Warrenbb99ad62006-09-07 16:50:54 -04001583 CONFIG_I2C_MULTI_BUS
1584
1585 This option allows the use of multiple I2C buses, each of which
1586 must have a controller. At any point in time, only one bus is
1587 active. To switch to a different bus, use the 'i2c dev' command.
1588 Note that bus numbering is zero-based.
1589
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001590 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001591
1592 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001593 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1594 is set, specify a list of bus-device pairs. Otherwise, specify
1595 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001596
1597 e.g.
1598 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001599 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001600
1601 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1602
1603 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001604 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001605
1606 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1607
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001608 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001609
1610 If defined, then this indicates the I2C bus number for DDR SPD.
1611 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1612
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001613 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001614
1615 If defined, then this indicates the I2C bus number for the RTC.
1616 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1617
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001618 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001619
1620 If defined, then this indicates the I2C bus number for the DTT.
1621 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001623 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001624
1625 If defined, specifies the I2C address of the DTT device.
1626 If not defined, then U-Boot uses predefined value for
1627 specified DTT device.
1628
Timur Tabibe5e6182006-11-03 19:15:00 -06001629 CONFIG_FSL_I2C
1630
1631 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001632 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001633
Heiko Schocher67b23a32008-10-15 09:39:47 +02001634 CONFIG_I2C_MUX
1635
1636 Define this option if you have I2C devices reached over 1 .. n
1637 I2C Muxes like the pca9544a. This option addes a new I2C
1638 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1639 new I2C Bus to the existing I2C Busses. If you select the
1640 new Bus with "i2c dev", u-bbot sends first the commandos for
1641 the muxes to activate this new "bus".
1642
1643 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1644 feature!
1645
1646 Example:
1647 Adding a new I2C Bus reached over 2 pca9544a muxes
1648 The First mux with address 70 and channel 6
1649 The Second mux with address 71 and channel 4
1650
1651 => i2c bus pca9544a:70:6:pca9544a:71:4
1652
1653 Use the "i2c bus" command without parameter, to get a list
1654 of I2C Busses with muxes:
1655
1656 => i2c bus
1657 Busses reached over muxes:
1658 Bus ID: 2
1659 reached over Mux(es):
1660 pca9544a@70 ch: 4
1661 Bus ID: 3
1662 reached over Mux(es):
1663 pca9544a@70 ch: 6
1664 pca9544a@71 ch: 4
1665 =>
1666
1667 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1668 u-boot sends First the Commando to the mux@70 to enable
1669 channel 6, and then the Commando to the mux@71 to enable
1670 the channel 4.
1671
1672 After that, you can use the "normal" i2c commands as
1673 usual, to communicate with your I2C devices behind
1674 the 2 muxes.
1675
1676 This option is actually implemented for the bitbanging
1677 algorithm in common/soft_i2c.c and for the Hardware I2C
1678 Bus on the MPC8260. But it should be not so difficult
1679 to add this option to other architectures.
1680
Andrew Dyer2ac69852008-12-29 17:36:01 -06001681 CONFIG_SOFT_I2C_READ_REPEATED_START
1682
1683 defining this will force the i2c_read() function in
1684 the soft_i2c driver to perform an I2C repeated start
1685 between writing the address pointer and reading the
1686 data. If this define is omitted the default behaviour
1687 of doing a stop-start sequence will be used. Most I2C
1688 devices can use either method, but some require one or
1689 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001690
wdenkc6097192002-11-03 00:24:07 +00001691- SPI Support: CONFIG_SPI
1692
1693 Enables SPI driver (so far only tested with
1694 SPI EEPROM, also an instance works with Crystal A/D and
1695 D/As on the SACSng board)
1696
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001697 CONFIG_SH_SPI
1698
1699 Enables the driver for SPI controller on SuperH. Currently
1700 only SH7757 is supported.
1701
wdenkc6097192002-11-03 00:24:07 +00001702 CONFIG_SPI_X
1703
1704 Enables extended (16-bit) SPI EEPROM addressing.
1705 (symmetrical to CONFIG_I2C_X)
1706
1707 CONFIG_SOFT_SPI
1708
wdenk43d96162003-03-06 00:02:04 +00001709 Enables a software (bit-bang) SPI driver rather than
1710 using hardware support. This is a general purpose
1711 driver that only requires three general I/O port pins
1712 (two outputs, one input) to function. If this is
1713 defined, the board configuration must define several
1714 SPI configuration items (port pins to use, etc). For
1715 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001716
Ben Warren04a9e112008-01-16 22:37:35 -05001717 CONFIG_HARD_SPI
1718
1719 Enables a hardware SPI driver for general-purpose reads
1720 and writes. As with CONFIG_SOFT_SPI, the board configuration
1721 must define a list of chip-select function pointers.
1722 Currently supported on some MPC8xxx processors. For an
1723 example, see include/configs/mpc8349emds.h.
1724
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001725 CONFIG_MXC_SPI
1726
1727 Enables the driver for the SPI controllers on i.MX and MXC
1728 SoCs. Currently only i.MX31 is supported.
1729
Matthias Fuchs01335022007-12-27 17:12:34 +01001730- FPGA Support: CONFIG_FPGA
1731
1732 Enables FPGA subsystem.
1733
1734 CONFIG_FPGA_<vendor>
1735
1736 Enables support for specific chip vendors.
1737 (ALTERA, XILINX)
1738
1739 CONFIG_FPGA_<family>
1740
1741 Enables support for FPGA family.
1742 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1743
1744 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001745
wdenk43d96162003-03-06 00:02:04 +00001746 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001748 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001749
wdenk8bde7f72003-06-27 21:31:46 +00001750 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001752 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001753
wdenk43d96162003-03-06 00:02:04 +00001754 Enable checks on FPGA configuration interface busy
1755 status by the configuration function. This option
1756 will require a board or device specific function to
1757 be written.
wdenkc6097192002-11-03 00:24:07 +00001758
1759 CONFIG_FPGA_DELAY
1760
1761 If defined, a function that provides delays in the FPGA
1762 configuration driver.
1763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001764 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001765 Allow Control-C to interrupt FPGA configuration
1766
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001767 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001768
wdenk43d96162003-03-06 00:02:04 +00001769 Check for configuration errors during FPGA bitfile
1770 loading. For example, abort during Virtex II
1771 configuration if the INIT_B line goes low (which
1772 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001774 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001775
wdenk43d96162003-03-06 00:02:04 +00001776 Maximum time to wait for the INIT_B line to deassert
1777 after PROB_B has been deasserted during a Virtex II
1778 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001779 ms.
wdenkc6097192002-11-03 00:24:07 +00001780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001781 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001782
wdenk43d96162003-03-06 00:02:04 +00001783 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001784 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001786 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001787
wdenk43d96162003-03-06 00:02:04 +00001788 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001789 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001790
1791- Configuration Management:
1792 CONFIG_IDENT_STRING
1793
wdenk43d96162003-03-06 00:02:04 +00001794 If defined, this string will be added to the U-Boot
1795 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001796
1797- Vendor Parameter Protection:
1798
wdenk43d96162003-03-06 00:02:04 +00001799 U-Boot considers the values of the environment
1800 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001801 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001802 are set once by the board vendor / manufacturer, and
1803 protects these variables from casual modification by
1804 the user. Once set, these variables are read-only,
1805 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001806 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001807
1808 If CONFIG_ENV_OVERWRITE is #defined in your config
1809 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001810 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001811 these parameters.
1812
1813 Alternatively, if you #define _both_ CONFIG_ETHADDR
1814 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001815 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001816 which can be changed exactly ONCE by the user. [The
1817 serial# is unaffected by this, i. e. it remains
1818 read-only.]
1819
1820- Protected RAM:
1821 CONFIG_PRAM
1822
1823 Define this variable to enable the reservation of
1824 "protected RAM", i. e. RAM which is not overwritten
1825 by U-Boot. Define CONFIG_PRAM to hold the number of
1826 kB you want to reserve for pRAM. You can overwrite
1827 this default value by defining an environment
1828 variable "pram" to the number of kB you want to
1829 reserve. Note that the board info structure will
1830 still show the full amount of RAM. If pRAM is
1831 reserved, a new environment variable "mem" will
1832 automatically be defined to hold the amount of
1833 remaining RAM in a form that can be passed as boot
1834 argument to Linux, for instance like that:
1835
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001836 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001837 saveenv
1838
1839 This way you can tell Linux not to use this memory,
1840 either, which results in a memory region that will
1841 not be affected by reboots.
1842
1843 *WARNING* If your board configuration uses automatic
1844 detection of the RAM size, you must make sure that
1845 this memory test is non-destructive. So far, the
1846 following board configurations are known to be
1847 "pRAM-clean":
1848
1849 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1850 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001851 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001852
1853- Error Recovery:
1854 CONFIG_PANIC_HANG
1855
1856 Define this variable to stop the system in case of a
1857 fatal error, so that you have to reset it manually.
1858 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001859 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001860 automatically as fast as possible, but it may be
1861 useful during development since you can try to debug
1862 the conditions that lead to the situation.
1863
1864 CONFIG_NET_RETRY_COUNT
1865
wdenk43d96162003-03-06 00:02:04 +00001866 This variable defines the number of retries for
1867 network operations like ARP, RARP, TFTP, or BOOTP
1868 before giving up the operation. If not defined, a
1869 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001870
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001871 CONFIG_ARP_TIMEOUT
1872
1873 Timeout waiting for an ARP reply in milliseconds.
1874
wdenkc6097192002-11-03 00:24:07 +00001875- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001876 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001877
1878 Enable auto completion of commands using TAB.
1879
Wolfgang Denka9398e02006-11-27 15:32:42 +01001880 Note that this feature has NOT been implemented yet
1881 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001882
1883
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001884 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001885
1886 Define this variable to enable the "hush" shell (from
1887 Busybox) as command line interpreter, thus enabling
1888 powerful command line syntax like
1889 if...then...else...fi conditionals or `&&' and '||'
1890 constructs ("shell scripts").
1891
1892 If undefined, you get the old, much simpler behaviour
1893 with a somewhat smaller memory footprint.
1894
1895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001896 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001897
1898 This defines the secondary prompt string, which is
1899 printed when the command interpreter needs more input
1900 to complete a command. Usually "> ".
1901
1902 Note:
1903
wdenk8bde7f72003-06-27 21:31:46 +00001904 In the current implementation, the local variables
1905 space and global environment variables space are
1906 separated. Local variables are those you define by
1907 simply typing `name=value'. To access a local
1908 variable later on, you have write `$name' or
1909 `${name}'; to execute the contents of a variable
1910 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001911
wdenk43d96162003-03-06 00:02:04 +00001912 Global environment variables are those you use
1913 setenv/printenv to work with. To run a command stored
1914 in such a variable, you need to use the run command,
1915 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001916
1917 To store commands and special characters in a
1918 variable, please use double quotation marks
1919 surrounding the whole text of the variable, instead
1920 of the backslashes before semicolons and special
1921 symbols.
1922
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001923- Commandline Editing and History:
1924 CONFIG_CMDLINE_EDITING
1925
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001926 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001927 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001928
wdenka8c7c702003-12-06 19:49:23 +00001929- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001930 CONFIG_EXTRA_ENV_SETTINGS
1931
wdenk43d96162003-03-06 00:02:04 +00001932 Define this to contain any number of null terminated
1933 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001934 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001935
wdenk43d96162003-03-06 00:02:04 +00001936 For example, place something like this in your
1937 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001938
1939 #define CONFIG_EXTRA_ENV_SETTINGS \
1940 "myvar1=value1\0" \
1941 "myvar2=value2\0"
1942
wdenk43d96162003-03-06 00:02:04 +00001943 Warning: This method is based on knowledge about the
1944 internal format how the environment is stored by the
1945 U-Boot code. This is NOT an official, exported
1946 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001947 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001948 You better know what you are doing here.
1949
wdenk43d96162003-03-06 00:02:04 +00001950 Note: overly (ab)use of the default environment is
1951 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001952 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001953 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001954
wdenka8c7c702003-12-06 19:49:23 +00001955- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001956 CONFIG_HAS_DATAFLASH
1957
wdenk8bde7f72003-06-27 21:31:46 +00001958 Defining this option enables DataFlash features and
1959 allows to read/write in Dataflash via the standard
1960 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001961
wdenk3f85ce22004-02-23 16:11:30 +00001962- SystemACE Support:
1963 CONFIG_SYSTEMACE
1964
1965 Adding this option adds support for Xilinx SystemACE
1966 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001967 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001968 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001969
1970 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001971 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001972
1973 When SystemACE support is added, the "ace" device type
1974 becomes available to the fat commands, i.e. fatls.
1975
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001976- TFTP Fixed UDP Port:
1977 CONFIG_TFTP_PORT
1978
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001979 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001980 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001981 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001982 number generator is used.
1983
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001984 Also, the environment variable tftpdstp is used to supply
1985 the TFTP UDP destination port value. If tftpdstp isn't
1986 defined, the normal port 69 is used.
1987
1988 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001989 blindly start the TFTP transfer using the pre-configured
1990 target IP address and UDP port. This has the effect of
1991 "punching through" the (Windows XP) firewall, allowing
1992 the remainder of the TFTP transfer to proceed normally.
1993 A better solution is to properly configure the firewall,
1994 but sometimes that is not allowed.
1995
wdenka8c7c702003-12-06 19:49:23 +00001996- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001997 CONFIG_SHOW_BOOT_PROGRESS
1998
wdenk43d96162003-03-06 00:02:04 +00001999 Defining this option allows to add some board-
2000 specific code (calling a user-provided function
2001 "show_boot_progress(int)") that enables you to show
2002 the system's boot progress on some display (for
2003 example, some LED's) on your board. At the moment,
2004 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002005
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002006- Standalone program support:
2007 CONFIG_STANDALONE_LOAD_ADDR
2008
2009 This option allows to define board specific values
2010 for the address where standalone program gets loaded,
2011 thus overwriting the architecutre dependent default
2012 settings.
2013
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002014Legacy uImage format:
2015
wdenkc6097192002-11-03 00:24:07 +00002016 Arg Where When
2017 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002018 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002019 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002020 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002021 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002022 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002023 4 common/cmd_bootm.c Image data has correct checksum
2024 -4 common/cmd_bootm.c Image is for unsupported architecture
2025 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002026 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002027 6 common/cmd_bootm.c Image Type check OK
2028 -6 common/cmd_bootm.c gunzip uncompression error
2029 -7 common/cmd_bootm.c Unimplemented compression type
2030 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002031 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002032 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002033
2034 9 common/image.c Start initial ramdisk verification
2035 -10 common/image.c Ramdisk header has bad magic number
2036 -11 common/image.c Ramdisk header has bad checksum
2037 10 common/image.c Ramdisk header is OK
2038 -12 common/image.c Ramdisk data has bad checksum
2039 11 common/image.c Ramdisk data has correct checksum
2040 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002041 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002042 13 common/image.c Start multifile image verification
2043 14 common/image.c No initial ramdisk, no multifile, continue.
2044
Peter Tyserea0364f2010-04-12 22:28:04 -05002045 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002046
Stefan Roesea47a12b2010-04-15 16:07:28 +02002047 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002048 -31 post/post.c POST test failed, detected by post_output_backlog()
2049 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002050
Heiko Schocher566a4942007-06-22 19:11:54 +02002051 34 common/cmd_doc.c before loading a Image from a DOC device
2052 -35 common/cmd_doc.c Bad usage of "doc" command
2053 35 common/cmd_doc.c correct usage of "doc" command
2054 -36 common/cmd_doc.c No boot device
2055 36 common/cmd_doc.c correct boot device
2056 -37 common/cmd_doc.c Unknown Chip ID on boot device
2057 37 common/cmd_doc.c correct chip ID found, device available
2058 -38 common/cmd_doc.c Read Error on boot device
2059 38 common/cmd_doc.c reading Image header from DOC device OK
2060 -39 common/cmd_doc.c Image header has bad magic number
2061 39 common/cmd_doc.c Image header has correct magic number
2062 -40 common/cmd_doc.c Error reading Image from DOC device
2063 40 common/cmd_doc.c Image header has correct magic number
2064 41 common/cmd_ide.c before loading a Image from a IDE device
2065 -42 common/cmd_ide.c Bad usage of "ide" command
2066 42 common/cmd_ide.c correct usage of "ide" command
2067 -43 common/cmd_ide.c No boot device
2068 43 common/cmd_ide.c boot device found
2069 -44 common/cmd_ide.c Device not available
2070 44 common/cmd_ide.c Device available
2071 -45 common/cmd_ide.c wrong partition selected
2072 45 common/cmd_ide.c partition selected
2073 -46 common/cmd_ide.c Unknown partition table
2074 46 common/cmd_ide.c valid partition table found
2075 -47 common/cmd_ide.c Invalid partition type
2076 47 common/cmd_ide.c correct partition type
2077 -48 common/cmd_ide.c Error reading Image Header on boot device
2078 48 common/cmd_ide.c reading Image Header from IDE device OK
2079 -49 common/cmd_ide.c Image header has bad magic number
2080 49 common/cmd_ide.c Image header has correct magic number
2081 -50 common/cmd_ide.c Image header has bad checksum
2082 50 common/cmd_ide.c Image header has correct checksum
2083 -51 common/cmd_ide.c Error reading Image from IDE device
2084 51 common/cmd_ide.c reading Image from IDE device OK
2085 52 common/cmd_nand.c before loading a Image from a NAND device
2086 -53 common/cmd_nand.c Bad usage of "nand" command
2087 53 common/cmd_nand.c correct usage of "nand" command
2088 -54 common/cmd_nand.c No boot device
2089 54 common/cmd_nand.c boot device found
2090 -55 common/cmd_nand.c Unknown Chip ID on boot device
2091 55 common/cmd_nand.c correct chip ID found, device available
2092 -56 common/cmd_nand.c Error reading Image Header on boot device
2093 56 common/cmd_nand.c reading Image Header from NAND device OK
2094 -57 common/cmd_nand.c Image header has bad magic number
2095 57 common/cmd_nand.c Image header has correct magic number
2096 -58 common/cmd_nand.c Error reading Image from NAND device
2097 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002098
Heiko Schocher566a4942007-06-22 19:11:54 +02002099 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002100
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002101 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002102 -64 net/eth.c no Ethernet found.
2103 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002104
Heiko Schocher566a4942007-06-22 19:11:54 +02002105 -80 common/cmd_net.c usage wrong
2106 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002107 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002108 81 common/cmd_net.c NetLoop() back without error
2109 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2110 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002111 83 common/cmd_net.c running "source" command
2112 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002113 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002114
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002115FIT uImage format:
2116
2117 Arg Where When
2118 100 common/cmd_bootm.c Kernel FIT Image has correct format
2119 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2120 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2121 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2122 102 common/cmd_bootm.c Kernel unit name specified
2123 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002124 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002125 104 common/cmd_bootm.c Got kernel subimage node offset
2126 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2127 105 common/cmd_bootm.c Kernel subimage hash verification OK
2128 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2129 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002130 -106 common/cmd_bootm.c Kernel subimage has wrong type
2131 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002132 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2133 108 common/cmd_bootm.c Got kernel subimage data/size
2134 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2135 -109 common/cmd_bootm.c Can't get kernel subimage type
2136 -110 common/cmd_bootm.c Can't get kernel subimage comp
2137 -111 common/cmd_bootm.c Can't get kernel subimage os
2138 -112 common/cmd_bootm.c Can't get kernel subimage load address
2139 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2140
2141 120 common/image.c Start initial ramdisk verification
2142 -120 common/image.c Ramdisk FIT image has incorrect format
2143 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002144 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002145 -122 common/image.c Can't get configuration for ramdisk subimage
2146 123 common/image.c Ramdisk unit name specified
2147 -124 common/image.c Can't get ramdisk subimage node offset
2148 125 common/image.c Got ramdisk subimage node offset
2149 -125 common/image.c Ramdisk subimage hash verification failed
2150 126 common/image.c Ramdisk subimage hash verification OK
2151 -126 common/image.c Ramdisk subimage for unsupported architecture
2152 127 common/image.c Architecture check OK
2153 -127 common/image.c Can't get ramdisk subimage data/size
2154 128 common/image.c Got ramdisk subimage data/size
2155 129 common/image.c Can't get ramdisk load address
2156 -129 common/image.c Got ramdisk load address
2157
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002158 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002159 131 common/cmd_doc.c FIT image format OK
2160
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002161 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002162 141 common/cmd_ide.c FIT image format OK
2163
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002164 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002165 151 common/cmd_nand.c FIT image format OK
2166
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002167- Automatic software updates via TFTP server
2168 CONFIG_UPDATE_TFTP
2169 CONFIG_UPDATE_TFTP_CNT_MAX
2170 CONFIG_UPDATE_TFTP_MSEC_MAX
2171
2172 These options enable and control the auto-update feature;
2173 for a more detailed description refer to doc/README.update.
2174
2175- MTD Support (mtdparts command, UBI support)
2176 CONFIG_MTD_DEVICE
2177
2178 Adds the MTD device infrastructure from the Linux kernel.
2179 Needed for mtdparts command support.
2180
2181 CONFIG_MTD_PARTITIONS
2182
2183 Adds the MTD partitioning infrastructure from the Linux
2184 kernel. Needed for UBI support.
2185
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002186
wdenkc6097192002-11-03 00:24:07 +00002187Modem Support:
2188--------------
2189
wdenk85ec0bc2003-03-31 16:34:49 +00002190[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002191
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002192- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002193 CONFIG_MODEM_SUPPORT
2194
2195- RTS/CTS Flow control enable:
2196 CONFIG_HWFLOW
2197
2198- Modem debug support:
2199 CONFIG_MODEM_SUPPORT_DEBUG
2200
wdenk43d96162003-03-06 00:02:04 +00002201 Enables debugging stuff (char screen[1024], dbg())
2202 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002203
wdenka8c7c702003-12-06 19:49:23 +00002204- Interrupt support (PPC):
2205
wdenkd4ca31c2004-01-02 14:00:00 +00002206 There are common interrupt_init() and timer_interrupt()
2207 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002208 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002209 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002210 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002211 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002212 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002213 specific handling. If board has watchdog / status_led
2214 / other_activity_monitor it works automatically from
2215 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002216
wdenkc6097192002-11-03 00:24:07 +00002217- General:
2218
wdenk43d96162003-03-06 00:02:04 +00002219 In the target system modem support is enabled when a
2220 specific key (key combination) is pressed during
2221 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002222 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002223 board_init(). Currently key_pressed() is a dummy
2224 function, returning 1 and thus enabling modem
2225 initialization.
wdenkc6097192002-11-03 00:24:07 +00002226
wdenk43d96162003-03-06 00:02:04 +00002227 If there are no modem init strings in the
2228 environment, U-Boot proceed to autoboot; the
2229 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002230 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002231
2232 See also: doc/README.Modem
2233
2234
wdenkc6097192002-11-03 00:24:07 +00002235Configuration Settings:
2236-----------------------
2237
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002238- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002239 undefine this when you're short of memory.
2240
Peter Tyser2fb26042009-01-27 18:03:12 -06002241- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2242 width of the commands listed in the 'help' command output.
2243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002244- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002245 prompt for user input.
2246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002247- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002249- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002250
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002251- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002253- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002254 the application (usually a Linux kernel) when it is
2255 booted
2256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002257- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002258 List of legal baudrate settings for this board.
2259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002260- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002261 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002263- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002264 If the board specific function
2265 extern int overwrite_console (void);
2266 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002267 serial port, else the settings in the environment are used.
2268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002269- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002270 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002272- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002273 Enable overwrite of previous console environment settings.
2274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002275- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002276 Begin and End addresses of the area used by the
2277 simple memory test.
2278
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002279- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002280 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002282- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002283 Scratch address used by the alternate memory test
2284 You only need to set this if address zero isn't writeable
2285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002286- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2287 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002288 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002289 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002290 fixing up gd->ram_size the Linux kernel should gets passed
2291 the now "corrected" memory size and won't touch it either.
2292 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002293 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002294 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002295 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002296
2297 This option can be used as a workaround for the 440EPx/GRx
2298 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2299 be touched.
2300
2301 WARNING: Please make sure that this value is a multiple of
2302 the Linux page size (normally 4k). If this is not the case,
2303 then the end address of the Linux memory will be located at a
2304 non page size aligned address and this could cause major
2305 problems.
2306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002307- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002308 Default load address for network file downloads
2309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002310- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002311 Enable temporary baudrate change while serial download
2312
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002313- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002314 Physical start address of SDRAM. _Must_ be 0 here.
2315
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002316- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002317 Physical start address of Motherboard I/O (if using a
2318 Cogent motherboard)
2319
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002320- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002321 Physical start address of Flash memory.
2322
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002323- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002324 Physical start address of boot monitor code (set by
2325 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002326 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002327 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002328
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002329- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002330 Size of memory reserved for monitor code, used to
2331 determine _at_compile_time_ (!) if the environment is
2332 embedded within the U-Boot image, or in a separate
2333 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002335- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002336 Size of DRAM reserved for malloc() use.
2337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002338- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002339 Normally compressed uImages are limited to an
2340 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002341 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002342 to adjust this setting to your needs.
2343
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002344- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002345 Maximum size of memory mapped by the startup code of
2346 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002347 the Linux kernel (bd_info, boot arguments, FDT blob if
2348 used) must be put below this limit, unless "bootm_low"
2349 enviroment variable is defined and non-zero. In such case
2350 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002351 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002352
John Rigbyfca43cc2010-10-13 13:57:35 -06002353- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2354 Enable initrd_high functionality. If defined then the
2355 initrd_high feature is enabled and the bootm ramdisk subcommand
2356 is enabled.
2357
2358- CONFIG_SYS_BOOT_GET_CMDLINE:
2359 Enables allocating and saving kernel cmdline in space between
2360 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2361
2362- CONFIG_SYS_BOOT_GET_KBD:
2363 Enables allocating and saving a kernel copy of the bd_info in
2364 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002366- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002367 Max number of Flash memory banks
2368
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002369- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002370 Max number of sectors on a Flash chip
2371
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002372- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002373 Timeout for Flash erase operations (in ms)
2374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002375- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002376 Timeout for Flash write operations (in ms)
2377
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002378- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002379 Timeout for Flash set sector lock bit operation (in ms)
2380
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002381- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002382 Timeout for Flash clear lock bits operation (in ms)
2383
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002384- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002385 If defined, hardware flash sectors protection is used
2386 instead of U-Boot software protection.
2387
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002388- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002389
2390 Enable TFTP transfers directly to flash memory;
2391 without this option such a download has to be
2392 performed in two steps: (1) download to RAM, and (2)
2393 copy from RAM to flash.
2394
2395 The two-step approach is usually more reliable, since
2396 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002397 the flash, but in some situations (when system RAM is
2398 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002399 downloaded image) this option may be very useful.
2400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002401- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002402 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002403 common flash structure for storing flash geometry.
2404
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002405- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002406 This option also enables the building of the cfi_flash driver
2407 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002408
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002409- CONFIG_FLASH_CFI_MTD
2410 This option enables the building of the cfi_mtd driver
2411 in the drivers directory. The driver exports CFI flash
2412 to the MTD layer.
2413
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002414- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002415 Use buffered writes to flash.
2416
2417- CONFIG_FLASH_SPANSION_S29WS_N
2418 s29ws-n MirrorBit flash has non-standard addresses for buffered
2419 write commands.
2420
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002421- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002422 If this option is defined, the common CFI flash doesn't
2423 print it's warning upon not recognized FLASH banks. This
2424 is useful, if some of the configured banks are only
2425 optionally available.
2426
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002427- CONFIG_FLASH_SHOW_PROGRESS
2428 If defined (must be an integer), print out countdown
2429 digits and dots. Recommended value: 45 (9..1) for 80
2430 column displays, 15 (3..1) for 40 column displays.
2431
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002432- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002433 Defines the number of Ethernet receive buffers. On some
2434 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002435 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2436 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002437 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002438 Defaults to 4 if not defined.
2439
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002440- CONFIG_ENV_MAX_ENTRIES
2441
Wolfgang Denk071bc922010-10-27 22:48:30 +02002442 Maximum number of entries in the hash table that is used
2443 internally to store the environment settings. The default
2444 setting is supposed to be generous and should work in most
2445 cases. This setting can be used to tune behaviour; see
2446 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002447
wdenkc6097192002-11-03 00:24:07 +00002448The following definitions that deal with the placement and management
2449of environment data (variable area); in general, we support the
2450following configurations:
2451
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002452- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002453
2454 Define this if the environment is in flash memory.
2455
2456 a) The environment occupies one whole flash sector, which is
2457 "embedded" in the text segment with the U-Boot code. This
2458 happens usually with "bottom boot sector" or "top boot
2459 sector" type flash chips, which have several smaller
2460 sectors at the start or the end. For instance, such a
2461 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2462 such a case you would place the environment in one of the
2463 4 kB sectors - with U-Boot code before and after it. With
2464 "top boot sector" type flash chips, you would put the
2465 environment in one of the last sectors, leaving a gap
2466 between U-Boot and the environment.
2467
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002468 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002469
2470 Offset of environment data (variable area) to the
2471 beginning of flash memory; for instance, with bottom boot
2472 type flash chips the second sector can be used: the offset
2473 for this sector is given here.
2474
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002475 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002476
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002477 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002478
2479 This is just another way to specify the start address of
2480 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002481 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002482
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002483 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002484
2485 Size of the sector containing the environment.
2486
2487
2488 b) Sometimes flash chips have few, equal sized, BIG sectors.
2489 In such a case you don't want to spend a whole sector for
2490 the environment.
2491
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002492 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002493
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002494 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002495 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002496 of this flash sector for the environment. This saves
2497 memory for the RAM copy of the environment.
2498
2499 It may also save flash memory if you decide to use this
2500 when your environment is "embedded" within U-Boot code,
2501 since then the remainder of the flash sector could be used
2502 for U-Boot code. It should be pointed out that this is
2503 STRONGLY DISCOURAGED from a robustness point of view:
2504 updating the environment in flash makes it always
2505 necessary to erase the WHOLE sector. If something goes
2506 wrong before the contents has been restored from a copy in
2507 RAM, your target system will be dead.
2508
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002509 - CONFIG_ENV_ADDR_REDUND
2510 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002511
wdenk43d96162003-03-06 00:02:04 +00002512 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002513 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002514 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002515 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002516
2517BE CAREFUL! Any changes to the flash layout, and some changes to the
2518source code will make it necessary to adapt <board>/u-boot.lds*
2519accordingly!
2520
2521
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002522- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002523
2524 Define this if you have some non-volatile memory device
2525 (NVRAM, battery buffered SRAM) which you want to use for the
2526 environment.
2527
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002528 - CONFIG_ENV_ADDR:
2529 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002530
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002531 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002532 want to use for environment. It is assumed that this memory
2533 can just be read and written to, without any special
2534 provision.
2535
2536BE CAREFUL! The first access to the environment happens quite early
2537in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002538console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002539U-Boot will hang.
2540
2541Please note that even with NVRAM we still use a copy of the
2542environment in RAM: we could work on NVRAM directly, but we want to
2543keep settings there always unmodified except somebody uses "saveenv"
2544to save the current settings.
2545
2546
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002547- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002548
2549 Use this if you have an EEPROM or similar serial access
2550 device and a driver for it.
2551
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002552 - CONFIG_ENV_OFFSET:
2553 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002554
2555 These two #defines specify the offset and size of the
2556 environment area within the total memory of your EEPROM.
2557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002558 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002559 If defined, specified the chip address of the EEPROM device.
2560 The default address is zero.
2561
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002562 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002563 If defined, the number of bits used to address bytes in a
2564 single page in the EEPROM device. A 64 byte page, for example
2565 would require six bits.
2566
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002567 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002568 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002569 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002570
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002571 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002572 The length in bytes of the EEPROM memory array address. Note
2573 that this is NOT the chip address length!
2574
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002575 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002576 EEPROM chips that implement "address overflow" are ones
2577 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2578 address and the extra bits end up in the "chip address" bit
2579 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2580 byte chips.
2581
2582 Note that we consider the length of the address field to
2583 still be one byte because the extra address bits are hidden
2584 in the chip address.
2585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002586 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002587 The size in bytes of the EEPROM device.
2588
Heiko Schocher548738b2010-01-07 08:55:40 +01002589 - CONFIG_ENV_EEPROM_IS_ON_I2C
2590 define this, if you have I2C and SPI activated, and your
2591 EEPROM, which holds the environment, is on the I2C bus.
2592
2593 - CONFIG_I2C_ENV_EEPROM_BUS
2594 if you have an Environment on an EEPROM reached over
2595 I2C muxes, you can define here, how to reach this
2596 EEPROM. For example:
2597
Wolfgang Denka9046b92010-06-13 17:48:15 +02002598 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002599
2600 EEPROM which holds the environment, is reached over
2601 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002602
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002603- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002604
wdenkd4ca31c2004-01-02 14:00:00 +00002605 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002606 want to use for the environment.
2607
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002608 - CONFIG_ENV_OFFSET:
2609 - CONFIG_ENV_ADDR:
2610 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002611
2612 These three #defines specify the offset and size of the
2613 environment area within the total memory of your DataFlash placed
2614 at the specified address.
2615
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002616- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002617
2618 Define this if you have a NAND device which you want to use
2619 for the environment.
2620
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002621 - CONFIG_ENV_OFFSET:
2622 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002623
2624 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002625 area within the first NAND device. CONFIG_ENV_OFFSET must be
2626 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002627
Scott Woodfdd813d2010-09-17 14:38:37 -05002628 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002629
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002630 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002631 size used to hold a redundant copy of the environment data, so
2632 that there is a valid backup copy in case there is a power failure
2633 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2634 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002635
Scott Woodfdd813d2010-09-17 14:38:37 -05002636 - CONFIG_ENV_RANGE (optional):
2637
2638 Specifies the length of the region in which the environment
2639 can be written. This should be a multiple of the NAND device's
2640 block size. Specifying a range with more erase blocks than
2641 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2642 the range to be avoided.
2643
2644 - CONFIG_ENV_OFFSET_OOB (optional):
2645
2646 Enables support for dynamically retrieving the offset of the
2647 environment from block zero's out-of-band data. The
2648 "nand env.oob" command can be used to record this offset.
2649 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2650 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002651
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002652- CONFIG_NAND_ENV_DST
2653
2654 Defines address in RAM to which the nand_spl code should copy the
2655 environment. If redundant environment is used, it will be copied to
2656 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2657
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002658- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002659
2660 Defines offset to the initial SPI buffer area in DPRAM. The
2661 area is used at an early stage (ROM part) if the environment
2662 is configured to reside in the SPI EEPROM: We need a 520 byte
2663 scratch DPRAM area. It is used between the two initialization
2664 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2665 to be a good choice since it makes it far enough from the
2666 start of the data area as well as from the stack pointer.
2667
Bruce Adlere881cb52007-11-02 13:15:42 -07002668Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002669has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002670created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002671until then to read environment variables.
2672
wdenk85ec0bc2003-03-31 16:34:49 +00002673The environment is protected by a CRC32 checksum. Before the monitor
2674is relocated into RAM, as a result of a bad CRC you will be working
2675with the compiled-in default environment - *silently*!!! [This is
2676necessary, because the first environment variable we need is the
2677"baudrate" setting for the console - if we have a bad CRC, we don't
2678have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002679
2680Note: once the monitor has been relocated, then it will complain if
2681the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002682use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002683
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002684- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002685 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002686
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002687 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002688 also needs to be defined.
2689
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002690- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002691 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002692
Ron Madridf5675aa2009-02-18 14:30:44 -08002693- CONFIG_NS16550_MIN_FUNCTIONS:
2694 Define this if you desire to only have use of the NS16550_init
2695 and NS16550_putc functions for the serial driver located at
2696 drivers/serial/ns16550.c. This option is useful for saving
2697 space for already greatly restricted images, including but not
2698 limited to NAND_SPL configurations.
2699
wdenkc6097192002-11-03 00:24:07 +00002700Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002701---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002702
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002703- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002704 Cache Line Size of the CPU.
2705
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002706- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002707 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002708
wdenk42d1f032003-10-15 23:53:47 +00002709 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2710 and RPXsuper) to be able to adjust the position of
2711 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002712
wdenk7f6c2cb2002-11-10 22:06:23 +00002713- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002714 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002715
2716 the default drive number (default value 0)
2717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002718 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002719
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002720 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002721 (default value 1)
2722
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002723 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002724
wdenk43d96162003-03-06 00:02:04 +00002725 defines the offset of register from address. It
2726 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002727 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002729 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2730 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002731 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002734 fdc_hw_init() is called at the beginning of the FDC
2735 setup. fdc_hw_init() must be provided by the board
2736 source code. It is used to make hardware dependant
2737 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002739- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002740 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002741 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002743- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002744
wdenk7152b1d2003-09-05 23:19:14 +00002745 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002746 initial data and stack; please note that this must be
2747 writable memory that is working WITHOUT special
2748 initialization, i. e. you CANNOT use normal RAM which
2749 will become available only after programming the
2750 memory controller and running certain initialization
2751 sequences.
2752
2753 U-Boot uses the following memory types:
2754 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2755 - MPC824X: data cache
2756 - PPC4xx: data cache
2757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002758- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002759
2760 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002761 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2762 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002763 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002764 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002765 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2766 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2767 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002768
2769 Note:
2770 On the MPC824X (or other systems that use the data
2771 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002772 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002773 point to an otherwise UNUSED address space between
2774 the top of RAM and the start of the PCI space.
2775
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002776- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002778- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002779
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002780- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002782- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002784- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002786- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002787
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002788- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002789 SDRAM timing
2790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002791- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002792 periodic timer for refresh
2793
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002794- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002796- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2797 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2798 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2799 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002800 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2801
2802- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2804 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002805 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002807- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2808 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002809 Machine Mode Register and Memory Periodic Timer
2810 Prescaler definitions (SDRAM timing)
2811
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002812- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002813 enable I2C microcode relocation patch (MPC8xx);
2814 define relocation offset in DPRAM [DSP2]
2815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002816- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002817 enable SMC microcode relocation patch (MPC8xx);
2818 define relocation offset in DPRAM [SMC1]
2819
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002820- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002821 enable SPI microcode relocation patch (MPC8xx);
2822 define relocation offset in DPRAM [SCC4]
2823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002824- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002825 Use OSCM clock mode on MBX8xx board. Be careful,
2826 wrong setting might damage your board. Read
2827 doc/README.MBX before setting this variable!
2828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002829- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002830 Offset of the bootmode word in DPRAM used by post
2831 (Power On Self Tests). This definition overrides
2832 #define'd default value in commproc.h resp.
2833 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002834
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002835- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2836 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2837 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2838 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2839 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2840 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2841 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2842 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002843 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002844
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002845- CONFIG_PCI_DISABLE_PCIE:
2846 Disable PCI-Express on systems where it is supported but not
2847 required.
2848
Kumar Galaa09b9b62010-12-30 12:09:53 -06002849- CONFIG_SYS_SRIO:
2850 Chip has SRIO or not
2851
2852- CONFIG_SRIO1:
2853 Board has SRIO 1 port available
2854
2855- CONFIG_SRIO2:
2856 Board has SRIO 2 port available
2857
2858- CONFIG_SYS_SRIOn_MEM_VIRT:
2859 Virtual Address of SRIO port 'n' memory region
2860
2861- CONFIG_SYS_SRIOn_MEM_PHYS:
2862 Physical Address of SRIO port 'n' memory region
2863
2864- CONFIG_SYS_SRIOn_MEM_SIZE:
2865 Size of SRIO port 'n' memory region
2866
Ben Warrenbb99ad62006-09-07 16:50:54 -04002867- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002868 Get DDR timing information from an I2C EEPROM. Common
2869 with pluggable memory modules such as SODIMMs
2870
Ben Warrenbb99ad62006-09-07 16:50:54 -04002871 SPD_EEPROM_ADDRESS
2872 I2C address of the SPD EEPROM
2873
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002874- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002875 If SPD EEPROM is on an I2C bus other than the first
2876 one, specify here. Note that the value must resolve
2877 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002878
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002879- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002880 Only for 83xx systems. If specified, then DDR should
2881 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002882
wdenkc26e4542004-04-18 10:13:26 +00002883- CONFIG_ETHER_ON_FEC[12]
2884 Define to enable FEC[12] on a 8xx series processor.
2885
2886- CONFIG_FEC[12]_PHY
2887 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002888 to the given FEC; i. e.
2889 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002890 means that the PHY with address 4 is connected to FEC1
2891
2892 When set to -1, means to probe for first available.
2893
2894- CONFIG_FEC[12]_PHY_NORXERR
2895 The PHY does not have a RXERR line (RMII only).
2896 (so program the FEC to ignore it).
2897
2898- CONFIG_RMII
2899 Enable RMII mode for all FECs.
2900 Note that this is a global option, we can't
2901 have one FEC in standard MII mode and another in RMII mode.
2902
wdenk5cf91d62004-04-23 20:32:05 +00002903- CONFIG_CRC32_VERIFY
2904 Add a verify option to the crc32 command.
2905 The syntax is:
2906
2907 => crc32 -v <address> <count> <crc32>
2908
2909 Where address/count indicate a memory area
2910 and crc32 is the correct crc32 which the
2911 area should have.
2912
wdenk56523f12004-07-11 17:40:54 +00002913- CONFIG_LOOPW
2914 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002915 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002916
stroese7b466642004-12-16 18:46:55 +00002917- CONFIG_MX_CYCLIC
2918 Add the "mdc" and "mwc" memory commands. These are cyclic
2919 "md/mw" commands.
2920 Examples:
2921
wdenkefe2a4d2004-12-16 21:44:03 +00002922 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002923 This command will print 4 bytes (10,11,12,13) each 500 ms.
2924
wdenkefe2a4d2004-12-16 21:44:03 +00002925 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002926 This command will write 12345678 to address 100 all 10 ms.
2927
wdenkefe2a4d2004-12-16 21:44:03 +00002928 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002929 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002930
wdenk8aa1a2d2005-04-04 12:44:11 +00002931- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002932 [ARM only] If this variable is defined, then certain
2933 low level initializations (like setting up the memory
2934 controller) are omitted and/or U-Boot does not
2935 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002936
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002937 Normally this variable MUST NOT be defined. The only
2938 exception is when U-Boot is loaded (to RAM) by some
2939 other boot loader or by a debugger which performs
2940 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002941
Magnus Liljadf812382009-06-13 20:50:00 +02002942- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02002943 Modifies the behaviour of start.S when compiling a loader
2944 that is executed before the actual U-Boot. E.g. when
2945 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002946
wdenkc6097192002-11-03 00:24:07 +00002947Building the Software:
2948======================
2949
Wolfgang Denk218ca722008-03-26 10:40:12 +01002950Building U-Boot has been tested in several native build environments
2951and in many different cross environments. Of course we cannot support
2952all possibly existing versions of cross development tools in all
2953(potentially obsolete) versions. In case of tool chain problems we
2954recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2955which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002956
Wolfgang Denk218ca722008-03-26 10:40:12 +01002957If you are not using a native environment, it is assumed that you
2958have GNU cross compiling tools available in your path. In this case,
2959you must set the environment variable CROSS_COMPILE in your shell.
2960Note that no changes to the Makefile or any other source files are
2961necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002962
Wolfgang Denk218ca722008-03-26 10:40:12 +01002963 $ CROSS_COMPILE=ppc_4xx-
2964 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002965
Peter Tyser2f8d3962009-03-13 18:54:51 -05002966Note: If you wish to generate Windows versions of the utilities in
2967 the tools directory you can use the MinGW toolchain
2968 (http://www.mingw.org). Set your HOST tools to the MinGW
2969 toolchain and execute 'make tools'. For example:
2970
2971 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2972
2973 Binaries such as tools/mkimage.exe will be created which can
2974 be executed on computers running Windows.
2975
Wolfgang Denk218ca722008-03-26 10:40:12 +01002976U-Boot is intended to be simple to build. After installing the
2977sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002978is done by typing:
2979
2980 make NAME_config
2981
Wolfgang Denk218ca722008-03-26 10:40:12 +01002982where "NAME_config" is the name of one of the existing configu-
2983rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002984
wdenk2729af92004-05-03 20:45:30 +00002985Note: for some board special configuration names may exist; check if
2986 additional information is available from the board vendor; for
2987 instance, the TQM823L systems are available without (standard)
2988 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002989 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002990
wdenk2729af92004-05-03 20:45:30 +00002991 make TQM823L_config
2992 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002993
wdenk2729af92004-05-03 20:45:30 +00002994 make TQM823L_LCD_config
2995 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002996
wdenk2729af92004-05-03 20:45:30 +00002997 etc.
wdenkc6097192002-11-03 00:24:07 +00002998
wdenkc6097192002-11-03 00:24:07 +00002999
wdenk2729af92004-05-03 20:45:30 +00003000Finally, type "make all", and you should get some working U-Boot
3001images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003002
wdenk2729af92004-05-03 20:45:30 +00003003- "u-boot.bin" is a raw binary image
3004- "u-boot" is an image in ELF binary format
3005- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003006
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003007By default the build is performed locally and the objects are saved
3008in the source directory. One of the two methods can be used to change
3009this behavior and build U-Boot to some external directory:
3010
30111. Add O= to the make command line invocations:
3012
3013 make O=/tmp/build distclean
3014 make O=/tmp/build NAME_config
3015 make O=/tmp/build all
3016
30172. Set environment variable BUILD_DIR to point to the desired location:
3018
3019 export BUILD_DIR=/tmp/build
3020 make distclean
3021 make NAME_config
3022 make all
3023
3024Note that the command line "O=" setting overrides the BUILD_DIR environment
3025variable.
3026
wdenkc6097192002-11-03 00:24:07 +00003027
wdenk2729af92004-05-03 20:45:30 +00003028Please be aware that the Makefiles assume you are using GNU make, so
3029for instance on NetBSD you might need to use "gmake" instead of
3030native "make".
wdenkc6097192002-11-03 00:24:07 +00003031
wdenkc6097192002-11-03 00:24:07 +00003032
wdenk2729af92004-05-03 20:45:30 +00003033If the system board that you have is not listed, then you will need
3034to port U-Boot to your hardware platform. To do this, follow these
3035steps:
wdenkc6097192002-11-03 00:24:07 +00003036
wdenk2729af92004-05-03 20:45:30 +000030371. Add a new configuration option for your board to the toplevel
3038 "Makefile" and to the "MAKEALL" script, using the existing
3039 entries as examples. Note that here and at many other places
3040 boards and other names are listed in alphabetical sort order. Please
3041 keep this order.
30422. Create a new directory to hold your board specific code. Add any
3043 files you need. In your board directory, you will need at least
3044 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
30453. Create a new configuration file "include/configs/<board>.h" for
3046 your board
30473. If you're porting U-Boot to a new CPU, then also create a new
3048 directory to hold your CPU specific code. Add any files you need.
30494. Run "make <board>_config" with your new name.
30505. Type "make", and you should get a working "u-boot.srec" file
3051 to be installed on your target system.
30526. Debug and solve any problems that might arise.
3053 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003054
wdenkc6097192002-11-03 00:24:07 +00003055
wdenk2729af92004-05-03 20:45:30 +00003056Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3057==============================================================
wdenkc6097192002-11-03 00:24:07 +00003058
Wolfgang Denk218ca722008-03-26 10:40:12 +01003059If you have modified U-Boot sources (for instance added a new board
3060or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003061provide feedback to the other developers. The feedback normally takes
3062the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003063official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003064
Wolfgang Denk218ca722008-03-26 10:40:12 +01003065But before you submit such a patch, please verify that your modifi-
3066cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003067the supported boards compile WITHOUT ANY compiler warnings. To do so,
3068just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003069for ALL supported system. Be warned, this will take a while. You can
3070select which (cross) compiler to use by passing a `CROSS_COMPILE'
3071environment variable to the script, i. e. to use the ELDK cross tools
3072you can type
wdenkc6097192002-11-03 00:24:07 +00003073
wdenk2729af92004-05-03 20:45:30 +00003074 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003075
wdenk2729af92004-05-03 20:45:30 +00003076or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003077
wdenk2729af92004-05-03 20:45:30 +00003078 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003079
Wolfgang Denk218ca722008-03-26 10:40:12 +01003080When using the MAKEALL script, the default behaviour is to build
3081U-Boot in the source directory. This location can be changed by
3082setting the BUILD_DIR environment variable. Also, for each target
3083built, the MAKEALL script saves two log files (<target>.ERR and
3084<target>.MAKEALL) in the <source dir>/LOG directory. This default
3085location can be changed by setting the MAKEALL_LOGDIR environment
3086variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003087
3088 export BUILD_DIR=/tmp/build
3089 export MAKEALL_LOGDIR=/tmp/log
3090 CROSS_COMPILE=ppc_8xx- MAKEALL
3091
Wolfgang Denk218ca722008-03-26 10:40:12 +01003092With the above settings build objects are saved in the /tmp/build,
3093log files are saved in the /tmp/log and the source tree remains clean
3094during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003095
3096
wdenk2729af92004-05-03 20:45:30 +00003097See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003098
wdenkc6097192002-11-03 00:24:07 +00003099
wdenk2729af92004-05-03 20:45:30 +00003100Monitor Commands - Overview:
3101============================
wdenkc6097192002-11-03 00:24:07 +00003102
wdenk2729af92004-05-03 20:45:30 +00003103go - start application at address 'addr'
3104run - run commands in an environment variable
3105bootm - boot application image from memory
3106bootp - boot image via network using BootP/TFTP protocol
3107tftpboot- boot image via network using TFTP protocol
3108 and env variables "ipaddr" and "serverip"
3109 (and eventually "gatewayip")
3110rarpboot- boot image via network using RARP/TFTP protocol
3111diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3112loads - load S-Record file over serial line
3113loadb - load binary file over serial line (kermit mode)
3114md - memory display
3115mm - memory modify (auto-incrementing)
3116nm - memory modify (constant address)
3117mw - memory write (fill)
3118cp - memory copy
3119cmp - memory compare
3120crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003121i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003122sspi - SPI utility commands
3123base - print or set address offset
3124printenv- print environment variables
3125setenv - set environment variables
3126saveenv - save environment variables to persistent storage
3127protect - enable or disable FLASH write protection
3128erase - erase FLASH memory
3129flinfo - print FLASH memory information
3130bdinfo - print Board Info structure
3131iminfo - print header information for application image
3132coninfo - print console devices and informations
3133ide - IDE sub-system
3134loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003135loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003136mtest - simple RAM test
3137icache - enable or disable instruction cache
3138dcache - enable or disable data cache
3139reset - Perform RESET of the CPU
3140echo - echo args to console
3141version - print monitor version
3142help - print online help
3143? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003144
wdenkc6097192002-11-03 00:24:07 +00003145
wdenk2729af92004-05-03 20:45:30 +00003146Monitor Commands - Detailed Description:
3147========================================
wdenkc6097192002-11-03 00:24:07 +00003148
wdenk2729af92004-05-03 20:45:30 +00003149TODO.
wdenkc6097192002-11-03 00:24:07 +00003150
wdenk2729af92004-05-03 20:45:30 +00003151For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003152
3153
wdenk2729af92004-05-03 20:45:30 +00003154Environment Variables:
3155======================
wdenkc6097192002-11-03 00:24:07 +00003156
wdenk2729af92004-05-03 20:45:30 +00003157U-Boot supports user configuration using Environment Variables which
3158can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003159
wdenk2729af92004-05-03 20:45:30 +00003160Environment Variables are set using "setenv", printed using
3161"printenv", and saved to Flash using "saveenv". Using "setenv"
3162without a value can be used to delete a variable from the
3163environment. As long as you don't save the environment you are
3164working with an in-memory copy. In case the Flash area containing the
3165environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003166
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003167Some configuration options can be set using Environment Variables.
3168
3169List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003170
wdenk2729af92004-05-03 20:45:30 +00003171 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003172
wdenk2729af92004-05-03 20:45:30 +00003173 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003174
wdenk2729af92004-05-03 20:45:30 +00003175 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003176
wdenk2729af92004-05-03 20:45:30 +00003177 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003178
wdenk2729af92004-05-03 20:45:30 +00003179 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003180
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003181 bootm_low - Memory range available for image processing in the bootm
3182 command can be restricted. This variable is given as
3183 a hexadecimal number and defines lowest address allowed
3184 for use by the bootm command. See also "bootm_size"
3185 environment variable. Address defined by "bootm_low" is
3186 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003187 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003188
3189 bootm_size - Memory range available for image processing in the bootm
3190 command can be restricted. This variable is given as
3191 a hexadecimal number and defines the size of the region
3192 allowed for use by the bootm command. See also "bootm_low"
3193 environment variable.
3194
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003195 updatefile - Location of the software update file on a TFTP server, used
3196 by the automatic software update feature. Please refer to
3197 documentation in doc/README.update for more details.
3198
wdenk2729af92004-05-03 20:45:30 +00003199 autoload - if set to "no" (any string beginning with 'n'),
3200 "bootp" will just load perform a lookup of the
3201 configuration from the BOOTP server, but not try to
3202 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003203
wdenk2729af92004-05-03 20:45:30 +00003204 autostart - if set to "yes", an image loaded using the "bootp",
3205 "rarpboot", "tftpboot" or "diskboot" commands will
3206 be automatically started (by internally calling
3207 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003208
wdenk2729af92004-05-03 20:45:30 +00003209 If set to "no", a standalone image passed to the
3210 "bootm" command will be copied to the load address
3211 (and eventually uncompressed), but NOT be started.
3212 This can be used to load and uncompress arbitrary
3213 data.
wdenkc6097192002-11-03 00:24:07 +00003214
wdenk17ea1172004-06-06 21:51:03 +00003215 i2cfast - (PPC405GP|PPC405EP only)
3216 if set to 'y' configures Linux I2C driver for fast
3217 mode (400kHZ). This environment variable is used in
3218 initialization code. So, for changes to be effective
3219 it must be saved and board must be reset.
3220
wdenk2729af92004-05-03 20:45:30 +00003221 initrd_high - restrict positioning of initrd images:
3222 If this variable is not set, initrd images will be
3223 copied to the highest possible address in RAM; this
3224 is usually what you want since it allows for
3225 maximum initrd size. If for some reason you want to
3226 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003227 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003228 variable to a value of "no" or "off" or "0".
3229 Alternatively, you can set it to a maximum upper
3230 address to use (U-Boot will still check that it
3231 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003232
wdenk2729af92004-05-03 20:45:30 +00003233 For instance, when you have a system with 16 MB
3234 RAM, and want to reserve 4 MB from use by Linux,
3235 you can do this by adding "mem=12M" to the value of
3236 the "bootargs" variable. However, now you must make
3237 sure that the initrd image is placed in the first
3238 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003239
wdenk2729af92004-05-03 20:45:30 +00003240 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003241
wdenk2729af92004-05-03 20:45:30 +00003242 If you set initrd_high to 0xFFFFFFFF, this is an
3243 indication to U-Boot that all addresses are legal
3244 for the Linux kernel, including addresses in flash
3245 memory. In this case U-Boot will NOT COPY the
3246 ramdisk at all. This may be useful to reduce the
3247 boot time on your system, but requires that this
3248 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003249
wdenk2729af92004-05-03 20:45:30 +00003250 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003251
wdenk2729af92004-05-03 20:45:30 +00003252 loadaddr - Default load address for commands like "bootp",
3253 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003254
wdenk2729af92004-05-03 20:45:30 +00003255 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003256
wdenk2729af92004-05-03 20:45:30 +00003257 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003258
wdenk2729af92004-05-03 20:45:30 +00003259 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003260
wdenk2729af92004-05-03 20:45:30 +00003261 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003262
wdenk2729af92004-05-03 20:45:30 +00003263 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003264
wdenk2729af92004-05-03 20:45:30 +00003265 ethprime - When CONFIG_NET_MULTI is enabled controls which
3266 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003267
wdenk2729af92004-05-03 20:45:30 +00003268 ethact - When CONFIG_NET_MULTI is enabled controls which
3269 interface is currently active. For example you
3270 can do the following
wdenkc6097192002-11-03 00:24:07 +00003271
Heiko Schocher48690d82010-07-20 17:45:02 +02003272 => setenv ethact FEC
3273 => ping 192.168.0.1 # traffic sent on FEC
3274 => setenv ethact SCC
3275 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003276
Matthias Fuchse1692572008-01-17 07:45:05 +01003277 ethrotate - When set to "no" U-Boot does not go through all
3278 available network interfaces.
3279 It just stays at the currently selected interface.
3280
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003281 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003282 either succeed or fail without retrying.
3283 When set to "once" the network operation will
3284 fail when all the available network interfaces
3285 are tried once without success.
3286 Useful on scripts which control the retry operation
3287 themselves.
wdenkc6097192002-11-03 00:24:07 +00003288
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003289 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003290
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003291 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003292 UDP source port.
3293
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003294 tftpdstport - If this is set, the value is used for TFTP's UDP
3295 destination port instead of the Well Know Port 69.
3296
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003297 tftpblocksize - Block size to use for TFTP transfers; if not set,
3298 we use the TFTP server's default block size
3299
3300 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3301 seconds, minimum value is 1000 = 1 second). Defines
3302 when a packet is considered to be lost so it has to
3303 be retransmitted. The default is 5000 = 5 seconds.
3304 Lowering this value may make downloads succeed
3305 faster in networks with high packet loss rates or
3306 with unreliable TFTP servers.
3307
3308 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003309 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003310 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003311
wdenk2729af92004-05-03 20:45:30 +00003312The following environment variables may be used and automatically
3313updated by the network boot commands ("bootp" and "rarpboot"),
3314depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003315
wdenk2729af92004-05-03 20:45:30 +00003316 bootfile - see above
3317 dnsip - IP address of your Domain Name Server
3318 dnsip2 - IP address of your secondary Domain Name Server
3319 gatewayip - IP address of the Gateway (Router) to use
3320 hostname - Target hostname
3321 ipaddr - see above
3322 netmask - Subnet Mask
3323 rootpath - Pathname of the root filesystem on the NFS server
3324 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003325
wdenka3d991b2004-04-15 21:48:45 +00003326
wdenk2729af92004-05-03 20:45:30 +00003327There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329 serial# - contains hardware identification information such
3330 as type string and/or serial number
3331 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk2729af92004-05-03 20:45:30 +00003333These variables can be set only once (usually during manufacturing of
3334the board). U-Boot refuses to delete or overwrite these variables
3335once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003336
3337
wdenk2729af92004-05-03 20:45:30 +00003338Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003339
wdenk2729af92004-05-03 20:45:30 +00003340 ver - Contains the U-Boot version string as printed
3341 with the "version" command. This variable is
3342 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003343
wdenkc6097192002-11-03 00:24:07 +00003344
wdenk2729af92004-05-03 20:45:30 +00003345Please note that changes to some configuration parameters may take
3346only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003347
stroesec1551ea2003-04-04 15:53:41 +00003348
wdenk2729af92004-05-03 20:45:30 +00003349Command Line Parsing:
3350=====================
stroesec1551ea2003-04-04 15:53:41 +00003351
wdenk2729af92004-05-03 20:45:30 +00003352There are two different command line parsers available with U-Boot:
3353the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003354
wdenk2729af92004-05-03 20:45:30 +00003355Old, simple command line parser:
3356--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003357
wdenk2729af92004-05-03 20:45:30 +00003358- supports environment variables (through setenv / saveenv commands)
3359- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003360- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003361- special characters ('$', ';') can be escaped by prefixing with '\',
3362 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003363 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003364- You can also escape text by enclosing in single apostrophes, for example:
3365 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003366
wdenk2729af92004-05-03 20:45:30 +00003367Hush shell:
3368-----------
wdenkf07771c2003-05-28 08:06:31 +00003369
wdenk2729af92004-05-03 20:45:30 +00003370- similar to Bourne shell, with control structures like
3371 if...then...else...fi, for...do...done; while...do...done,
3372 until...do...done, ...
3373- supports environment ("global") variables (through setenv / saveenv
3374 commands) and local shell variables (through standard shell syntax
3375 "name=value"); only environment variables can be used with "run"
3376 command
wdenkf07771c2003-05-28 08:06:31 +00003377
wdenk2729af92004-05-03 20:45:30 +00003378General rules:
3379--------------
wdenkf07771c2003-05-28 08:06:31 +00003380
wdenk2729af92004-05-03 20:45:30 +00003381(1) If a command line (or an environment variable executed by a "run"
3382 command) contains several commands separated by semicolon, and
3383 one of these commands fails, then the remaining commands will be
3384 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003385
wdenk2729af92004-05-03 20:45:30 +00003386(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003387 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003388 command will cause "run" to terminate, i. e. the remaining
3389 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003390
wdenk2729af92004-05-03 20:45:30 +00003391Note for Redundant Ethernet Interfaces:
3392=======================================
wdenkf07771c2003-05-28 08:06:31 +00003393
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003394Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003395such configurations and is capable of automatic selection of a
3396"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003397
wdenk2729af92004-05-03 20:45:30 +00003398Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3399MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3400"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003401
wdenk2729af92004-05-03 20:45:30 +00003402If the network interface stores some valid MAC address (for instance
3403in SROM), this is used as default address if there is NO correspon-
3404ding setting in the environment; if the corresponding environment
3405variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003406
wdenk2729af92004-05-03 20:45:30 +00003407o If the SROM has a valid MAC address, and there is no address in the
3408 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003409
wdenk2729af92004-05-03 20:45:30 +00003410o If there is no valid address in the SROM, and a definition in the
3411 environment exists, then the value from the environment variable is
3412 used.
wdenkc6097192002-11-03 00:24:07 +00003413
wdenk2729af92004-05-03 20:45:30 +00003414o If both the SROM and the environment contain a MAC address, and
3415 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003416
wdenk2729af92004-05-03 20:45:30 +00003417o If both the SROM and the environment contain a MAC address, and the
3418 addresses differ, the value from the environment is used and a
3419 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003420
wdenk2729af92004-05-03 20:45:30 +00003421o If neither SROM nor the environment contain a MAC address, an error
3422 is raised.
wdenkc6097192002-11-03 00:24:07 +00003423
Ben Warrenecee9322010-04-26 11:11:46 -07003424If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3425will be programmed into hardware as part of the initialization process. This
3426may be skipped by setting the appropriate 'ethmacskip' environment variable.
3427The naming convention is as follows:
3428"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003429
wdenk2729af92004-05-03 20:45:30 +00003430Image Formats:
3431==============
wdenkc6097192002-11-03 00:24:07 +00003432
Marian Balakowicz3310c542008-03-12 12:13:13 +01003433U-Boot is capable of booting (and performing other auxiliary operations on)
3434images in two formats:
3435
3436New uImage format (FIT)
3437-----------------------
3438
3439Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3440to Flattened Device Tree). It allows the use of images with multiple
3441components (several kernels, ramdisks, etc.), with contents protected by
3442SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3443
3444
3445Old uImage format
3446-----------------
3447
3448Old image format is based on binary files which can be basically anything,
3449preceded by a special header; see the definitions in include/image.h for
3450details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003451
wdenk2729af92004-05-03 20:45:30 +00003452* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3453 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003454 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3455 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3456 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003457* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003458 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3459 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003460* Compression Type (uncompressed, gzip, bzip2)
3461* Load Address
3462* Entry Point
3463* Image Name
3464* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003465
wdenk2729af92004-05-03 20:45:30 +00003466The header is marked by a special Magic Number, and both the header
3467and the data portions of the image are secured against corruption by
3468CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003469
wdenkc6097192002-11-03 00:24:07 +00003470
wdenk2729af92004-05-03 20:45:30 +00003471Linux Support:
3472==============
wdenkc6097192002-11-03 00:24:07 +00003473
wdenk2729af92004-05-03 20:45:30 +00003474Although U-Boot should support any OS or standalone application
3475easily, the main focus has always been on Linux during the design of
3476U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003477
wdenk2729af92004-05-03 20:45:30 +00003478U-Boot includes many features that so far have been part of some
3479special "boot loader" code within the Linux kernel. Also, any
3480"initrd" images to be used are no longer part of one big Linux image;
3481instead, kernel and "initrd" are separate images. This implementation
3482serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484- the same features can be used for other OS or standalone
3485 applications (for instance: using compressed images to reduce the
3486 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003487
wdenk2729af92004-05-03 20:45:30 +00003488- it becomes much easier to port new Linux kernel versions because
3489 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003490
wdenk2729af92004-05-03 20:45:30 +00003491- the same Linux kernel image can now be used with different "initrd"
3492 images; of course this also means that different kernel images can
3493 be run with the same "initrd". This makes testing easier (you don't
3494 have to build a new "zImage.initrd" Linux image when you just
3495 change a file in your "initrd"). Also, a field-upgrade of the
3496 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003497
wdenkc6097192002-11-03 00:24:07 +00003498
wdenk2729af92004-05-03 20:45:30 +00003499Linux HOWTO:
3500============
wdenkc6097192002-11-03 00:24:07 +00003501
wdenk2729af92004-05-03 20:45:30 +00003502Porting Linux to U-Boot based systems:
3503---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003504
wdenk2729af92004-05-03 20:45:30 +00003505U-Boot cannot save you from doing all the necessary modifications to
3506configure the Linux device drivers for use with your target hardware
3507(no, we don't intend to provide a full virtual machine interface to
3508Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003509
Stefan Roesea47a12b2010-04-15 16:07:28 +02003510But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003511
wdenk2729af92004-05-03 20:45:30 +00003512Just make sure your machine specific header file (for instance
3513include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003514Information structure as we define in include/asm-<arch>/u-boot.h,
3515and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003516as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003517
wdenkc6097192002-11-03 00:24:07 +00003518
wdenk2729af92004-05-03 20:45:30 +00003519Configuring the Linux kernel:
3520-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003521
wdenk2729af92004-05-03 20:45:30 +00003522No specific requirements for U-Boot. Make sure you have some root
3523device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003524
wdenkc6097192002-11-03 00:24:07 +00003525
wdenk2729af92004-05-03 20:45:30 +00003526Building a Linux Image:
3527-----------------------
wdenkc6097192002-11-03 00:24:07 +00003528
wdenk2729af92004-05-03 20:45:30 +00003529With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3530not used. If you use recent kernel source, a new build target
3531"uImage" will exist which automatically builds an image usable by
3532U-Boot. Most older kernels also have support for a "pImage" target,
3533which was introduced for our predecessor project PPCBoot and uses a
3534100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003535
wdenk2729af92004-05-03 20:45:30 +00003536Example:
wdenkc6097192002-11-03 00:24:07 +00003537
wdenk2729af92004-05-03 20:45:30 +00003538 make TQM850L_config
3539 make oldconfig
3540 make dep
3541 make uImage
wdenkc6097192002-11-03 00:24:07 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543The "uImage" build target uses a special tool (in 'tools/mkimage') to
3544encapsulate a compressed Linux kernel image with header information,
3545CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003546
wdenk2729af92004-05-03 20:45:30 +00003547* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003548
wdenk2729af92004-05-03 20:45:30 +00003549* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003550
wdenk2729af92004-05-03 20:45:30 +00003551 ${CROSS_COMPILE}-objcopy -O binary \
3552 -R .note -R .comment \
3553 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003554
wdenk2729af92004-05-03 20:45:30 +00003555* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003556
wdenk2729af92004-05-03 20:45:30 +00003557 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003558
wdenk2729af92004-05-03 20:45:30 +00003559* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003560
wdenk2729af92004-05-03 20:45:30 +00003561 mkimage -A ppc -O linux -T kernel -C gzip \
3562 -a 0 -e 0 -n "Linux Kernel Image" \
3563 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003564
wdenk24ee89b2002-11-03 17:56:27 +00003565
wdenk2729af92004-05-03 20:45:30 +00003566The "mkimage" tool can also be used to create ramdisk images for use
3567with U-Boot, either separated from the Linux kernel image, or
3568combined into one file. "mkimage" encapsulates the images with a 64
3569byte header containing information about target architecture,
3570operating system, image type, compression method, entry points, time
3571stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003572
wdenk2729af92004-05-03 20:45:30 +00003573"mkimage" can be called in two ways: to verify existing images and
3574print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003575
wdenk2729af92004-05-03 20:45:30 +00003576In the first form (with "-l" option) mkimage lists the information
3577contained in the header of an existing U-Boot image; this includes
3578checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003579
wdenk2729af92004-05-03 20:45:30 +00003580 tools/mkimage -l image
3581 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003582
wdenk2729af92004-05-03 20:45:30 +00003583The second form (with "-d" option) is used to build a U-Boot image
3584from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003585
wdenk2729af92004-05-03 20:45:30 +00003586 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3587 -n name -d data_file image
3588 -A ==> set architecture to 'arch'
3589 -O ==> set operating system to 'os'
3590 -T ==> set image type to 'type'
3591 -C ==> set compression type 'comp'
3592 -a ==> set load address to 'addr' (hex)
3593 -e ==> set entry point to 'ep' (hex)
3594 -n ==> set image name to 'name'
3595 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003596
wdenk69459792004-05-29 16:53:29 +00003597Right now, all Linux kernels for PowerPC systems use the same load
3598address (0x00000000), but the entry point address depends on the
3599kernel version:
wdenkc6097192002-11-03 00:24:07 +00003600
wdenk2729af92004-05-03 20:45:30 +00003601- 2.2.x kernels have the entry point at 0x0000000C,
3602- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003603
wdenk2729af92004-05-03 20:45:30 +00003604So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003605
wdenk2729af92004-05-03 20:45:30 +00003606 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3607 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003608 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003609 > examples/uImage.TQM850L
3610 Image Name: 2.4.4 kernel for TQM850L
3611 Created: Wed Jul 19 02:34:59 2000
3612 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3613 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3614 Load Address: 0x00000000
3615 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003616
wdenk2729af92004-05-03 20:45:30 +00003617To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003618
wdenk2729af92004-05-03 20:45:30 +00003619 -> tools/mkimage -l examples/uImage.TQM850L
3620 Image Name: 2.4.4 kernel for TQM850L
3621 Created: Wed Jul 19 02:34:59 2000
3622 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3623 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3624 Load Address: 0x00000000
3625 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003626
wdenk2729af92004-05-03 20:45:30 +00003627NOTE: for embedded systems where boot time is critical you can trade
3628speed for memory and install an UNCOMPRESSED image instead: this
3629needs more space in Flash, but boots much faster since it does not
3630need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003631
Stefan Roesea47a12b2010-04-15 16:07:28 +02003632 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003633 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3634 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003635 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003636 > examples/uImage.TQM850L-uncompressed
3637 Image Name: 2.4.4 kernel for TQM850L
3638 Created: Wed Jul 19 02:34:59 2000
3639 Image Type: PowerPC Linux Kernel Image (uncompressed)
3640 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3641 Load Address: 0x00000000
3642 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003643
wdenkc6097192002-11-03 00:24:07 +00003644
wdenk2729af92004-05-03 20:45:30 +00003645Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3646when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003647
wdenk2729af92004-05-03 20:45:30 +00003648 -> tools/mkimage -n 'Simple Ramdisk Image' \
3649 > -A ppc -O linux -T ramdisk -C gzip \
3650 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3651 Image Name: Simple Ramdisk Image
3652 Created: Wed Jan 12 14:01:50 2000
3653 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3654 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3655 Load Address: 0x00000000
3656 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003657
wdenkdb01a2e2004-04-15 23:14:49 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659Installing a Linux Image:
3660-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662To downloading a U-Boot image over the serial (console) interface,
3663you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003664
wdenk2729af92004-05-03 20:45:30 +00003665 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667The 'objcopy' does not understand the information in the U-Boot
3668image header, so the resulting S-Record file will be relative to
3669address 0x00000000. To load it to a given address, you need to
3670specify the target address as 'offset' parameter with the 'loads'
3671command.
wdenkc6097192002-11-03 00:24:07 +00003672
wdenk2729af92004-05-03 20:45:30 +00003673Example: install the image to address 0x40100000 (which on the
3674TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003675
wdenk2729af92004-05-03 20:45:30 +00003676 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003677
wdenk2729af92004-05-03 20:45:30 +00003678 .......... done
3679 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003680
wdenk2729af92004-05-03 20:45:30 +00003681 => loads 40100000
3682 ## Ready for S-Record download ...
3683 ~>examples/image.srec
3684 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3685 ...
3686 15989 15990 15991 15992
3687 [file transfer complete]
3688 [connected]
3689 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003690
3691
wdenk2729af92004-05-03 20:45:30 +00003692You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003693this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003694corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003695
wdenk2729af92004-05-03 20:45:30 +00003696 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003697
wdenk2729af92004-05-03 20:45:30 +00003698 ## Checking Image at 40100000 ...
3699 Image Name: 2.2.13 for initrd on TQM850L
3700 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3701 Data Size: 335725 Bytes = 327 kB = 0 MB
3702 Load Address: 00000000
3703 Entry Point: 0000000c
3704 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003705
3706
wdenk2729af92004-05-03 20:45:30 +00003707Boot Linux:
3708-----------
wdenkc6097192002-11-03 00:24:07 +00003709
wdenk2729af92004-05-03 20:45:30 +00003710The "bootm" command is used to boot an application that is stored in
3711memory (RAM or Flash). In case of a Linux kernel image, the contents
3712of the "bootargs" environment variable is passed to the kernel as
3713parameters. You can check and modify this variable using the
3714"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003715
3716
wdenk2729af92004-05-03 20:45:30 +00003717 => printenv bootargs
3718 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003719
wdenk2729af92004-05-03 20:45:30 +00003720 => 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 +00003721
wdenk2729af92004-05-03 20:45:30 +00003722 => printenv bootargs
3723 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 +00003724
wdenk2729af92004-05-03 20:45:30 +00003725 => bootm 40020000
3726 ## Booting Linux kernel at 40020000 ...
3727 Image Name: 2.2.13 for NFS on TQM850L
3728 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3729 Data Size: 381681 Bytes = 372 kB = 0 MB
3730 Load Address: 00000000
3731 Entry Point: 0000000c
3732 Verifying Checksum ... OK
3733 Uncompressing Kernel Image ... OK
3734 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
3735 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3736 time_init: decrementer frequency = 187500000/60
3737 Calibrating delay loop... 49.77 BogoMIPS
3738 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3739 ...
wdenkc6097192002-11-03 00:24:07 +00003740
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003741If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003742the memory addresses of both the kernel and the initrd image (PPBCOOT
3743format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003744
wdenk2729af92004-05-03 20:45:30 +00003745 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003746
wdenk2729af92004-05-03 20:45:30 +00003747 ## Checking Image at 40100000 ...
3748 Image Name: 2.2.13 for initrd on TQM850L
3749 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3750 Data Size: 335725 Bytes = 327 kB = 0 MB
3751 Load Address: 00000000
3752 Entry Point: 0000000c
3753 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003754
wdenk2729af92004-05-03 20:45:30 +00003755 ## Checking Image at 40200000 ...
3756 Image Name: Simple Ramdisk Image
3757 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3758 Data Size: 566530 Bytes = 553 kB = 0 MB
3759 Load Address: 00000000
3760 Entry Point: 00000000
3761 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003762
wdenk2729af92004-05-03 20:45:30 +00003763 => bootm 40100000 40200000
3764 ## Booting Linux kernel at 40100000 ...
3765 Image Name: 2.2.13 for initrd on TQM850L
3766 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3767 Data Size: 335725 Bytes = 327 kB = 0 MB
3768 Load Address: 00000000
3769 Entry Point: 0000000c
3770 Verifying Checksum ... OK
3771 Uncompressing Kernel Image ... OK
3772 ## Loading RAMDisk Image at 40200000 ...
3773 Image Name: Simple Ramdisk Image
3774 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3775 Data Size: 566530 Bytes = 553 kB = 0 MB
3776 Load Address: 00000000
3777 Entry Point: 00000000
3778 Verifying Checksum ... OK
3779 Loading Ramdisk ... OK
3780 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
3781 Boot arguments: root=/dev/ram
3782 time_init: decrementer frequency = 187500000/60
3783 Calibrating delay loop... 49.77 BogoMIPS
3784 ...
3785 RAMDISK: Compressed image found at block 0
3786 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003787
wdenk2729af92004-05-03 20:45:30 +00003788 bash#
wdenkc6097192002-11-03 00:24:07 +00003789
Matthew McClintock02677682006-06-28 10:41:37 -05003790Boot Linux and pass a flat device tree:
3791-----------
3792
3793First, U-Boot must be compiled with the appropriate defines. See the section
3794titled "Linux Kernel Interface" above for a more in depth explanation. The
3795following is an example of how to start a kernel and pass an updated
3796flat device tree:
3797
3798=> print oftaddr
3799oftaddr=0x300000
3800=> print oft
3801oft=oftrees/mpc8540ads.dtb
3802=> tftp $oftaddr $oft
3803Speed: 1000, full duplex
3804Using TSEC0 device
3805TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3806Filename 'oftrees/mpc8540ads.dtb'.
3807Load address: 0x300000
3808Loading: #
3809done
3810Bytes transferred = 4106 (100a hex)
3811=> tftp $loadaddr $bootfile
3812Speed: 1000, full duplex
3813Using TSEC0 device
3814TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3815Filename 'uImage'.
3816Load address: 0x200000
3817Loading:############
3818done
3819Bytes transferred = 1029407 (fb51f hex)
3820=> print loadaddr
3821loadaddr=200000
3822=> print oftaddr
3823oftaddr=0x300000
3824=> bootm $loadaddr - $oftaddr
3825## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003826 Image Name: Linux-2.6.17-dirty
3827 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3828 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003829 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003830 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003831 Verifying Checksum ... OK
3832 Uncompressing Kernel Image ... OK
3833Booting using flat device tree at 0x300000
3834Using MPC85xx ADS machine description
3835Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3836[snip]
3837
3838
wdenk2729af92004-05-03 20:45:30 +00003839More About U-Boot Image Types:
3840------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003841
wdenk2729af92004-05-03 20:45:30 +00003842U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003843
wdenk2729af92004-05-03 20:45:30 +00003844 "Standalone Programs" are directly runnable in the environment
3845 provided by U-Boot; it is expected that (if they behave
3846 well) you can continue to work in U-Boot after return from
3847 the Standalone Program.
3848 "OS Kernel Images" are usually images of some Embedded OS which
3849 will take over control completely. Usually these programs
3850 will install their own set of exception handlers, device
3851 drivers, set up the MMU, etc. - this means, that you cannot
3852 expect to re-enter U-Boot except by resetting the CPU.
3853 "RAMDisk Images" are more or less just data blocks, and their
3854 parameters (address, size) are passed to an OS kernel that is
3855 being started.
3856 "Multi-File Images" contain several images, typically an OS
3857 (Linux) kernel image and one or more data images like
3858 RAMDisks. This construct is useful for instance when you want
3859 to boot over the network using BOOTP etc., where the boot
3860 server provides just a single image file, but you want to get
3861 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003862
wdenk2729af92004-05-03 20:45:30 +00003863 "Multi-File Images" start with a list of image sizes, each
3864 image size (in bytes) specified by an "uint32_t" in network
3865 byte order. This list is terminated by an "(uint32_t)0".
3866 Immediately after the terminating 0 follow the images, one by
3867 one, all aligned on "uint32_t" boundaries (size rounded up to
3868 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003869
wdenk2729af92004-05-03 20:45:30 +00003870 "Firmware Images" are binary images containing firmware (like
3871 U-Boot or FPGA images) which usually will be programmed to
3872 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874 "Script files" are command sequences that will be executed by
3875 U-Boot's command interpreter; this feature is especially
3876 useful when you configure U-Boot to use a real shell (hush)
3877 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003878
wdenkc6097192002-11-03 00:24:07 +00003879
wdenk2729af92004-05-03 20:45:30 +00003880Standalone HOWTO:
3881=================
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk2729af92004-05-03 20:45:30 +00003883One of the features of U-Boot is that you can dynamically load and
3884run "standalone" applications, which can use some resources of
3885U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003886
wdenk2729af92004-05-03 20:45:30 +00003887Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003888
wdenk2729af92004-05-03 20:45:30 +00003889"Hello World" Demo:
3890-------------------
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk2729af92004-05-03 20:45:30 +00003892'examples/hello_world.c' contains a small "Hello World" Demo
3893application; it is automatically compiled when you build U-Boot.
3894It's configured to run at address 0x00040004, so you can play with it
3895like that:
wdenkc6097192002-11-03 00:24:07 +00003896
wdenk2729af92004-05-03 20:45:30 +00003897 => loads
3898 ## Ready for S-Record download ...
3899 ~>examples/hello_world.srec
3900 1 2 3 4 5 6 7 8 9 10 11 ...
3901 [file transfer complete]
3902 [connected]
3903 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003904
wdenk2729af92004-05-03 20:45:30 +00003905 => go 40004 Hello World! This is a test.
3906 ## Starting application at 0x00040004 ...
3907 Hello World
3908 argc = 7
3909 argv[0] = "40004"
3910 argv[1] = "Hello"
3911 argv[2] = "World!"
3912 argv[3] = "This"
3913 argv[4] = "is"
3914 argv[5] = "a"
3915 argv[6] = "test."
3916 argv[7] = "<NULL>"
3917 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003918
wdenk2729af92004-05-03 20:45:30 +00003919 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003920
wdenk2729af92004-05-03 20:45:30 +00003921Another example, which demonstrates how to register a CPM interrupt
3922handler with the U-Boot code, can be found in 'examples/timer.c'.
3923Here, a CPM timer is set up to generate an interrupt every second.
3924The interrupt service routine is trivial, just printing a '.'
3925character, but this is just a demo program. The application can be
3926controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk2729af92004-05-03 20:45:30 +00003928 ? - print current values og the CPM Timer registers
3929 b - enable interrupts and start timer
3930 e - stop timer and disable interrupts
3931 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk2729af92004-05-03 20:45:30 +00003933 => loads
3934 ## Ready for S-Record download ...
3935 ~>examples/timer.srec
3936 1 2 3 4 5 6 7 8 9 10 11 ...
3937 [file transfer complete]
3938 [connected]
3939 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003940
wdenk2729af92004-05-03 20:45:30 +00003941 => go 40004
3942 ## Starting application at 0x00040004 ...
3943 TIMERS=0xfff00980
3944 Using timer 1
3945 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk2729af92004-05-03 20:45:30 +00003947Hit 'b':
3948 [q, b, e, ?] Set interval 1000000 us
3949 Enabling timer
3950Hit '?':
3951 [q, b, e, ?] ........
3952 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3953Hit '?':
3954 [q, b, e, ?] .
3955 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3956Hit '?':
3957 [q, b, e, ?] .
3958 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3959Hit '?':
3960 [q, b, e, ?] .
3961 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3962Hit 'e':
3963 [q, b, e, ?] ...Stopping timer
3964Hit 'q':
3965 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003966
3967
wdenk2729af92004-05-03 20:45:30 +00003968Minicom warning:
3969================
wdenk85ec0bc2003-03-31 16:34:49 +00003970
wdenk2729af92004-05-03 20:45:30 +00003971Over time, many people have reported problems when trying to use the
3972"minicom" terminal emulation program for serial download. I (wd)
3973consider minicom to be broken, and recommend not to use it. Under
3974Unix, I recommend to use C-Kermit for general purpose use (and
3975especially for kermit binary protocol download ("loadb" command), and
3976use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003977
wdenk2729af92004-05-03 20:45:30 +00003978Nevertheless, if you absolutely want to use it try adding this
3979configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003980
wdenk2729af92004-05-03 20:45:30 +00003981 Name Program Name U/D FullScr IO-Red. Multi
3982 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3983 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003984
3985
wdenk2729af92004-05-03 20:45:30 +00003986NetBSD Notes:
3987=============
wdenkc6097192002-11-03 00:24:07 +00003988
wdenk2729af92004-05-03 20:45:30 +00003989Starting at version 0.9.2, U-Boot supports NetBSD both as host
3990(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992Building requires a cross environment; it is known to work on
3993NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3994need gmake since the Makefiles are not compatible with BSD make).
3995Note that the cross-powerpc package does not install include files;
3996attempting to build U-Boot will fail because <machine/ansi.h> is
3997missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003998
wdenk2729af92004-05-03 20:45:30 +00003999 # cd /usr/pkg/cross/powerpc-netbsd/include
4000 # mkdir powerpc
4001 # ln -s powerpc machine
4002 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4003 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk2729af92004-05-03 20:45:30 +00004005Native builds *don't* work due to incompatibilities between native
4006and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk2729af92004-05-03 20:45:30 +00004008Booting assumes that (the first part of) the image booted is a
4009stage-2 loader which in turn loads and then invokes the kernel
4010proper. Loader sources will eventually appear in the NetBSD source
4011tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004012meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004013
4014
wdenk2729af92004-05-03 20:45:30 +00004015Implementation Internals:
4016=========================
wdenkc6097192002-11-03 00:24:07 +00004017
wdenk2729af92004-05-03 20:45:30 +00004018The following is not intended to be a complete description of every
4019implementation detail. However, it should help to understand the
4020inner workings of U-Boot and make it easier to port it to custom
4021hardware.
wdenkc6097192002-11-03 00:24:07 +00004022
4023
wdenk2729af92004-05-03 20:45:30 +00004024Initial Stack, Global Data:
4025---------------------------
wdenkc6097192002-11-03 00:24:07 +00004026
wdenk2729af92004-05-03 20:45:30 +00004027The implementation of U-Boot is complicated by the fact that U-Boot
4028starts running out of ROM (flash memory), usually without access to
4029system RAM (because the memory controller is not initialized yet).
4030This means that we don't have writable Data or BSS segments, and BSS
4031is not initialized as zero. To be able to get a C environment working
4032at all, we have to allocate at least a minimal stack. Implementation
4033options for this are defined and restricted by the CPU used: Some CPU
4034models provide on-chip memory (like the IMMR area on MPC8xx and
4035MPC826x processors), on others (parts of) the data cache can be
4036locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004037
Wolfgang Denk218ca722008-03-26 10:40:12 +01004038 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004039 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004040
wdenk2729af92004-05-03 20:45:30 +00004041 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4042 From: "Chris Hallinan" <clh@net1plus.com>
4043 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4044 ...
wdenk43d96162003-03-06 00:02:04 +00004045
wdenk2729af92004-05-03 20:45:30 +00004046 Correct me if I'm wrong, folks, but the way I understand it
4047 is this: Using DCACHE as initial RAM for Stack, etc, does not
4048 require any physical RAM backing up the cache. The cleverness
4049 is that the cache is being used as a temporary supply of
4050 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004051 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004052 can see how this works by studying the cache architecture and
4053 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004054
wdenk2729af92004-05-03 20:45:30 +00004055 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4056 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004057 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004058 option should work for you. Using CS 4 should be fine if your
4059 board designers haven't used it for something that would
4060 cause you grief during the initial boot! It is frequently not
4061 used.
wdenk43d96162003-03-06 00:02:04 +00004062
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004063 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004064 with your processor/board/system design. The default value
4065 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004066 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004067 than your SDRAM module. If you have a 64MB SDRAM module, set
4068 it above 400_0000. Just make sure your board has no resources
4069 that are supposed to respond to that address! That code in
4070 start.S has been around a while and should work as is when
4071 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004072
wdenk2729af92004-05-03 20:45:30 +00004073 -Chris Hallinan
4074 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004075
wdenk2729af92004-05-03 20:45:30 +00004076It is essential to remember this, since it has some impact on the C
4077code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk2729af92004-05-03 20:45:30 +00004079* Initialized global data (data segment) is read-only. Do not attempt
4080 to write it.
wdenkc6097192002-11-03 00:24:07 +00004081
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004082* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004083 as zero data - BSS segment) at all - this is undefined, initiali-
4084 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004085
wdenk2729af92004-05-03 20:45:30 +00004086* Stack space is very limited. Avoid big data buffers or things like
4087 that.
wdenkc6097192002-11-03 00:24:07 +00004088
wdenk2729af92004-05-03 20:45:30 +00004089Having only the stack as writable memory limits means we cannot use
4090normal global data to share information beween the code. But it
4091turned out that the implementation of U-Boot can be greatly
4092simplified by making a global data structure (gd_t) available to all
4093functions. We could pass a pointer to this data as argument to _all_
4094functions, but this would bloat the code. Instead we use a feature of
4095the GCC compiler (Global Register Variables) to share the data: we
4096place a pointer (gd) to the global data into a register which we
4097reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004098
wdenk2729af92004-05-03 20:45:30 +00004099When choosing a register for such a purpose we are restricted by the
4100relevant (E)ABI specifications for the current architecture, and by
4101GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004102
wdenk2729af92004-05-03 20:45:30 +00004103For PowerPC, the following registers have specific use:
4104 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004105 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004106 R3-R4: parameter passing and return values
4107 R5-R10: parameter passing
4108 R13: small data area pointer
4109 R30: GOT pointer
4110 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004111
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004112 (U-Boot also uses R12 as internal GOT pointer. r12
4113 is a volatile register so r12 needs to be reset when
4114 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004115
Wolfgang Denke7670f62008-02-14 22:43:22 +01004116 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk2729af92004-05-03 20:45:30 +00004118 Note: on PPC, we could use a static initializer (since the
4119 address of the global data structure is known at compile time),
4120 but it turned out that reserving a register results in somewhat
4121 smaller code - although the code savings are not that big (on
4122 average for all boards 752 bytes for the whole U-Boot image,
4123 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004124
Robin Getzc4db3352009-08-17 15:23:02 +00004125On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004126 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4127
Robin Getzc4db3352009-08-17 15:23:02 +00004128 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004129
wdenk2729af92004-05-03 20:45:30 +00004130On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004131
wdenk2729af92004-05-03 20:45:30 +00004132 R0: function argument word/integer result
4133 R1-R3: function argument word
4134 R9: GOT pointer
4135 R10: stack limit (used only if stack checking if enabled)
4136 R11: argument (frame) pointer
4137 R12: temporary workspace
4138 R13: stack pointer
4139 R14: link register
4140 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004141
wdenk2729af92004-05-03 20:45:30 +00004142 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004143
Thomas Chou0df01fd2010-05-21 11:08:03 +08004144On Nios II, the ABI is documented here:
4145 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4146
4147 ==> U-Boot will use gp to hold a pointer to the global data
4148
4149 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4150 to access small data sections, so gp is free.
4151
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004152NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4153or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004154
wdenk2729af92004-05-03 20:45:30 +00004155Memory Management:
4156------------------
wdenkc6097192002-11-03 00:24:07 +00004157
wdenk2729af92004-05-03 20:45:30 +00004158U-Boot runs in system state and uses physical addresses, i.e. the
4159MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004160
wdenk2729af92004-05-03 20:45:30 +00004161The available memory is mapped to fixed addresses using the memory
4162controller. In this process, a contiguous block is formed for each
4163memory type (Flash, SDRAM, SRAM), even when it consists of several
4164physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166U-Boot is installed in the first 128 kB of the first Flash bank (on
4167TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4168booting and sizing and initializing DRAM, the code relocates itself
4169to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004170memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004171configuration setting]. Below that, a structure with global Board
4172Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004173
wdenk2729af92004-05-03 20:45:30 +00004174Additionally, some exception handler code is copied to the low 8 kB
4175of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004176
wdenk2729af92004-05-03 20:45:30 +00004177So a typical memory configuration with 16 MB of DRAM could look like
4178this:
wdenkc6097192002-11-03 00:24:07 +00004179
wdenk2729af92004-05-03 20:45:30 +00004180 0x0000 0000 Exception Vector code
4181 :
4182 0x0000 1FFF
4183 0x0000 2000 Free for Application Use
4184 :
4185 :
wdenkc6097192002-11-03 00:24:07 +00004186
wdenk2729af92004-05-03 20:45:30 +00004187 :
4188 :
4189 0x00FB FF20 Monitor Stack (Growing downward)
4190 0x00FB FFAC Board Info Data and permanent copy of global data
4191 0x00FC 0000 Malloc Arena
4192 :
4193 0x00FD FFFF
4194 0x00FE 0000 RAM Copy of Monitor Code
4195 ... eventually: LCD or video framebuffer
4196 ... eventually: pRAM (Protected RAM - unchanged by reset)
4197 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004198
4199
wdenk2729af92004-05-03 20:45:30 +00004200System Initialization:
4201----------------------
wdenkc6097192002-11-03 00:24:07 +00004202
wdenk2729af92004-05-03 20:45:30 +00004203In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004204(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004205configuration for CS0# this is a mirror of the onboard Flash memory.
4206To be able to re-map memory U-Boot then jumps to its link address.
4207To be able to implement the initialization code in C, a (small!)
4208initial stack is set up in the internal Dual Ported RAM (in case CPUs
4209which provide such a feature like MPC8xx or MPC8260), or in a locked
4210part of the data cache. After that, U-Boot initializes the CPU core,
4211the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004212
wdenk2729af92004-05-03 20:45:30 +00004213Next, all (potentially) available memory banks are mapped using a
4214preliminary mapping. For example, we put them on 512 MB boundaries
4215(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4216on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4217programmed for SDRAM access. Using the temporary configuration, a
4218simple memory test is run that determines the size of the SDRAM
4219banks.
wdenkc6097192002-11-03 00:24:07 +00004220
wdenk2729af92004-05-03 20:45:30 +00004221When there is more than one SDRAM bank, and the banks are of
4222different size, the largest is mapped first. For equal size, the first
4223bank (CS2#) is mapped first. The first mapping is always for address
42240x00000000, with any additional banks following immediately to create
4225contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004226
wdenk2729af92004-05-03 20:45:30 +00004227Then, the monitor installs itself at the upper end of the SDRAM area
4228and allocates memory for use by malloc() and for the global Board
4229Info data; also, the exception vector code is copied to the low RAM
4230pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004231
wdenk2729af92004-05-03 20:45:30 +00004232Only after this relocation will you have a "normal" C environment;
4233until that you are restricted in several ways, mostly because you are
4234running from ROM, and because the code will have to be relocated to a
4235new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004236
4237
wdenk2729af92004-05-03 20:45:30 +00004238U-Boot Porting Guide:
4239----------------------
wdenkc6097192002-11-03 00:24:07 +00004240
wdenk2729af92004-05-03 20:45:30 +00004241[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4242list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004243
4244
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004245int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004246{
4247 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004248
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004249 signal(SIGALRM, no_more_time);
4250 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004251
wdenk2729af92004-05-03 20:45:30 +00004252 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004253 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004254 return 0;
4255 }
4256
wdenk2729af92004-05-03 20:45:30 +00004257 Download latest U-Boot source;
4258
Wolfgang Denk06682362008-12-30 22:56:11 +01004259 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004260
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004261 if (clueless)
4262 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264 while (learning) {
4265 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004266 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4267 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004268 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004269 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004270 }
wdenkc6097192002-11-03 00:24:07 +00004271
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004272 if (available_money > toLocalCurrency ($2500))
4273 Buy a BDI3000;
4274 else
wdenk2729af92004-05-03 20:45:30 +00004275 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004276
4277 if (a similar board exists) { /* hopefully... */
4278 cp -a board/<similar> board/<myboard>
4279 cp include/configs/<similar>.h include/configs/<myboard>.h
4280 } else {
4281 Create your own board support subdirectory;
4282 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004283 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004284 Edit new board/<myboard> files
4285 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004286
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004287 while (!accepted) {
4288 while (!running) {
4289 do {
4290 Add / modify source code;
4291 } until (compiles);
4292 Debug;
4293 if (clueless)
4294 email("Hi, I am having problems...");
4295 }
4296 Send patch file to the U-Boot email list;
4297 if (reasonable critiques)
4298 Incorporate improvements from email list code review;
4299 else
4300 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004301 }
wdenkc6097192002-11-03 00:24:07 +00004302
wdenk2729af92004-05-03 20:45:30 +00004303 return 0;
4304}
4305
4306void no_more_time (int sig)
4307{
4308 hire_a_guru();
4309}
wdenkc6097192002-11-03 00:24:07 +00004310
4311
wdenk2729af92004-05-03 20:45:30 +00004312Coding Standards:
4313-----------------
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk2729af92004-05-03 20:45:30 +00004315All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004316coding style; see the file "Documentation/CodingStyle" and the script
4317"scripts/Lindent" in your Linux kernel source directory. In sources
4318originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4319spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004320
Detlev Zundel2c051652006-09-01 15:39:02 +02004321Source files originating from a different project (for example the
4322MTD subsystem) are generally exempt from these guidelines and are not
4323reformated to ease subsequent migration to newer versions of those
4324sources.
4325
4326Please note that U-Boot is implemented in C (and to some small parts in
4327Assembler); no C++ is used, so please do not use C++ style comments (//)
4328in your code.
wdenk2729af92004-05-03 20:45:30 +00004329
4330Please also stick to the following formatting rules:
4331- remove any trailing white space
4332- use TAB characters for indentation, not spaces
4333- make sure NOT to use DOS '\r\n' line feeds
4334- do not add more than 2 empty lines to source files
4335- do not add trailing empty lines to source files
4336
4337Submissions which do not conform to the standards may be returned
4338with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004339
4340
wdenk2729af92004-05-03 20:45:30 +00004341Submitting Patches:
4342-------------------
wdenkc6097192002-11-03 00:24:07 +00004343
wdenk2729af92004-05-03 20:45:30 +00004344Since the number of patches for U-Boot is growing, we need to
4345establish some rules. Submissions which do not conform to these rules
4346may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004347
Magnus Lilja0d28f342008-08-06 19:32:33 +02004348Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004349
Wolfgang Denk06682362008-12-30 22:56:11 +01004350Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4351see http://lists.denx.de/mailman/listinfo/u-boot
4352
wdenk2729af92004-05-03 20:45:30 +00004353When you send a patch, please include the following information with
4354it:
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356* For bug fixes: a description of the bug and how your patch fixes
4357 this bug. Please try to include a way of demonstrating that the
4358 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004359
wdenk2729af92004-05-03 20:45:30 +00004360* For new features: a description of the feature and your
4361 implementation.
wdenkc6097192002-11-03 00:24:07 +00004362
wdenk2729af92004-05-03 20:45:30 +00004363* A CHANGELOG entry as plaintext (separate from the patch)
4364
4365* For major contributions, your entry to the CREDITS file
4366
4367* When you add support for a new board, don't forget to add this
4368 board to the MAKEALL script, too.
4369
4370* If your patch adds new configuration options, don't forget to
4371 document these in the README file.
4372
Wolfgang Denk218ca722008-03-26 10:40:12 +01004373* The patch itself. If you are using git (which is *strongly*
4374 recommended) you can easily generate the patch using the
4375 "git-format-patch". If you then use "git-send-email" to send it to
4376 the U-Boot mailing list, you will avoid most of the common problems
4377 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004378
Wolfgang Denk218ca722008-03-26 10:40:12 +01004379 If you cannot use git, use "diff -purN OLD NEW". If your version of
4380 diff does not support these options, then get the latest version of
4381 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004382
Wolfgang Denk218ca722008-03-26 10:40:12 +01004383 The current directory when running this command shall be the parent
4384 directory of the U-Boot source tree (i. e. please make sure that
4385 your patch includes sufficient directory information for the
4386 affected files).
4387
4388 We prefer patches as plain text. MIME attachments are discouraged,
4389 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004390
4391* If one logical set of modifications affects or creates several
4392 files, all these changes shall be submitted in a SINGLE patch file.
4393
4394* Changesets that contain different, unrelated modifications shall be
4395 submitted as SEPARATE patches, one patch per changeset.
4396
4397
4398Notes:
4399
4400* Before sending the patch, run the MAKEALL script on your patched
4401 source tree and make sure that no errors or warnings are reported
4402 for any of the boards.
4403
4404* Keep your modifications to the necessary minimum: A patch
4405 containing several unrelated changes or arbitrary reformats will be
4406 returned with a request to re-formatting / split it.
4407
4408* If you modify existing code, make sure that your new code does not
4409 add to the memory footprint of the code ;-) Small is beautiful!
4410 When adding new features, these should compile conditionally only
4411 (using #ifdef), and the resulting code with the new feature
4412 disabled must not need more memory than the old code without your
4413 modification.
wdenk90dc6702005-05-03 14:12:25 +00004414
Wolfgang Denk06682362008-12-30 22:56:11 +01004415* Remember that there is a size limit of 100 kB per message on the
4416 u-boot mailing list. Bigger patches will be moderated. If they are
4417 reasonable and not too big, they will be acknowledged. But patches
4418 bigger than the size limit should be avoided.