blob: bc3e905828594afa1c311beae8ee484033ae009c [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
167 /i386 Files generic to i386 architecture
168 /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
628 CONFIG_CMD_DATE * support for RTC, date/time...
629 CONFIG_CMD_DHCP * DHCP support
630 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600631 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
632 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
633 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
634 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500635 CONFIG_CMD_DTT * Digital Therm and Thermostat
636 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500637 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500638 CONFIG_CMD_EEPROM * EEPROM read/write support
639 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500640 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500641 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500642 CONFIG_CMD_FDC * Floppy Disk Support
643 CONFIG_CMD_FAT * FAT partition support
644 CONFIG_CMD_FDOS * Dos diskette Support
645 CONFIG_CMD_FLASH flinfo, erase, protect
646 CONFIG_CMD_FPGA FPGA device initialization support
647 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
648 CONFIG_CMD_I2C * I2C serial bus support
649 CONFIG_CMD_IDE * IDE harddisk support
650 CONFIG_CMD_IMI iminfo
651 CONFIG_CMD_IMLS List all found images
652 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500653 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500654 CONFIG_CMD_IRQ * irqinfo
655 CONFIG_CMD_ITEST Integer/string test of 2 values
656 CONFIG_CMD_JFFS2 * JFFS2 Support
657 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500658 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500659 CONFIG_CMD_LOADB loadb
660 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400661 CONFIG_CMD_MD5SUM print md5 message digest
662 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500663 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
664 loop, loopw, mtest
665 CONFIG_CMD_MISC Misc functions like sleep etc
666 CONFIG_CMD_MMC * MMC memory mapped support
667 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100668 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500669 CONFIG_CMD_NAND * NAND support
670 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600671 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
672 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500673 CONFIG_CMD_PCI * pciinfo
674 CONFIG_CMD_PCMCIA * PCMCIA support
675 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
676 host
677 CONFIG_CMD_PORTIO * Port I/O
678 CONFIG_CMD_REGINFO * Register dump
679 CONFIG_CMD_RUN run command in env variable
680 CONFIG_CMD_SAVES * save S record dump
681 CONFIG_CMD_SCSI * SCSI Support
682 CONFIG_CMD_SDRAM * print SDRAM configuration information
683 (requires CONFIG_CMD_I2C)
684 CONFIG_CMD_SETGETDCR Support for DCR Register access
685 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100686 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400687 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200688 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500689 CONFIG_CMD_SPI * SPI serial bus support
690 CONFIG_CMD_USB * USB support
691 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500692 CONFIG_CMD_CDP * Cisco Discover Protocol support
693 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000694
wdenkc6097192002-11-03 00:24:07 +0000695
696 EXAMPLE: If you want all functions except of network
697 support you can write:
698
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500699 #include "config_cmd_all.h"
700 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000701
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400702 Other Commands:
703 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000704
705 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500706 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000707 what you (and your U-Boot users) are doing. Data
708 cache cannot be enabled on systems like the 8xx or
709 8260 (where accesses to the IMMR region must be
710 uncached), and it cannot be disabled on all other
711 systems where we (mis-) use the data cache to hold an
712 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000713
714
715 XXX - this list needs to get updated!
716
717- Watchdog:
718 CONFIG_WATCHDOG
719 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000720 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000721 code for a watchdog. For the 8xx and 8260 CPUs, the
722 SIU Watchdog feature is enabled in the SYPCR
723 register.
724
stroesec1551ea2003-04-04 15:53:41 +0000725- U-Boot Version:
726 CONFIG_VERSION_VARIABLE
727 If this variable is defined, an environment variable
728 named "ver" is created by U-Boot showing the U-Boot
729 version as printed by the "version" command.
730 This variable is readonly.
731
wdenkc6097192002-11-03 00:24:07 +0000732- Real-Time Clock:
733
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500734 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000735 has to be selected, too. Define exactly one of the
736 following options:
737
738 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
739 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200740 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000741 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000742 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000743 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000744 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000745 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100746 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000747 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200748 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000749
wdenkb37c7e52003-06-30 16:24:52 +0000750 Note that if the RTC uses I2C, then the I2C interface
751 must also be configured. See I2C Support, below.
752
Peter Tysere92739d2008-12-17 16:36:21 -0600753- GPIO Support:
754 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
755 CONFIG_PCA953X_INFO - enable pca953x info command
756
Chris Packham5dec49c2010-12-19 10:12:13 +0000757 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
758 chip-ngpio pairs that tell the PCA953X driver the number of
759 pins supported by a particular chip.
760
Peter Tysere92739d2008-12-17 16:36:21 -0600761 Note that if the GPIO device uses I2C, then the I2C interface
762 must also be configured. See I2C Support, below.
763
wdenkc6097192002-11-03 00:24:07 +0000764- Timestamp Support:
765
wdenk43d96162003-03-06 00:02:04 +0000766 When CONFIG_TIMESTAMP is selected, the timestamp
767 (date and time) of an image is printed by image
768 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500769 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000770
771- Partition Support:
772 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400773 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000774
Wolfgang Denk218ca722008-03-26 10:40:12 +0100775 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
776 CONFIG_CMD_SCSI) you must configure support for at
777 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000778
779- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000780 CONFIG_IDE_RESET_ROUTINE - this is defined in several
781 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000782
wdenk4d13cba2004-03-14 14:09:05 +0000783 CONFIG_IDE_RESET - is this is defined, IDE Reset will
784 be performed by calling the function
785 ide_set_reset(int reset)
786 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000787
788- ATAPI Support:
789 CONFIG_ATAPI
790
791 Set this to enable ATAPI support.
792
wdenkc40b2952004-03-13 23:29:43 +0000793- LBA48 Support
794 CONFIG_LBA48
795
796 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100797 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000798 Whithout these , LBA48 support uses 32bit variables and will 'only'
799 support disks up to 2.1TB.
800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200801 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000802 When enabled, makes the IDE subsystem use 64bit sector addresses.
803 Default is 32bit.
804
wdenkc6097192002-11-03 00:24:07 +0000805- SCSI Support:
806 At the moment only there is only support for the
807 SYM53C8XX SCSI controller; define
808 CONFIG_SCSI_SYM53C8XX to enable it.
809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200810 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
811 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
812 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000813 maximum numbers of LUNs, SCSI ID's and target
814 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200815 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000816
817- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000818 CONFIG_E1000
819 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000820
Andre Schwarzac3315c2008-03-06 16:45:44 +0100821 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200822 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100823
wdenkc6097192002-11-03 00:24:07 +0000824 CONFIG_EEPRO100
825 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200826 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000827 write routine for first time initialisation.
828
829 CONFIG_TULIP
830 Support for Digital 2114x chips.
831 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
832 modem chip initialisation (KS8761/QS6611).
833
834 CONFIG_NATSEMI
835 Support for National dp83815 chips.
836
837 CONFIG_NS8382X
838 Support for National dp8382[01] gigabit chips.
839
wdenk45219c42003-05-12 21:50:16 +0000840- NETWORK Support (other):
841
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100842 CONFIG_DRIVER_AT91EMAC
843 Support for AT91RM9200 EMAC.
844
845 CONFIG_RMII
846 Define this to use reduced MII inteface
847
848 CONFIG_DRIVER_AT91EMAC_QUIET
849 If this defined, the driver is quiet.
850 The driver doen't show link status messages.
851
wdenk45219c42003-05-12 21:50:16 +0000852 CONFIG_DRIVER_LAN91C96
853 Support for SMSC's LAN91C96 chips.
854
855 CONFIG_LAN91C96_BASE
856 Define this to hold the physical address
857 of the LAN91C96's I/O space
858
859 CONFIG_LAN91C96_USE_32_BIT
860 Define this to enable 32 bit addressing
861
wdenkf39748a2004-06-09 13:37:52 +0000862 CONFIG_DRIVER_SMC91111
863 Support for SMSC's LAN91C111 chip
864
865 CONFIG_SMC91111_BASE
866 Define this to hold the physical address
867 of the device (I/O space)
868
869 CONFIG_SMC_USE_32_BIT
870 Define this if data bus is 32 bits
871
872 CONFIG_SMC_USE_IOFUNCS
873 Define this to use i/o functions instead of macros
874 (some hardware wont work with macros)
875
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800876 CONFIG_FTGMAC100
877 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
878
879 CONFIG_FTGMAC100_EGIGA
880 Define this to use GE link update with gigabit PHY.
881 Define this if FTGMAC100 is connected to gigabit PHY.
882 If your system has 10/100 PHY only, it might not occur
883 wrong behavior. Because PHY usually return timeout or
884 useless data when polling gigabit status and gigabit
885 control registers. This behavior won't affect the
886 correctnessof 10/100 link speed update.
887
Mike Rapoportc2fff332009-11-11 10:03:03 +0200888 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200889 Support for SMSC's LAN911x and LAN921x chips
890
Mike Rapoportc2fff332009-11-11 10:03:03 +0200891 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200892 Define this to hold the physical address
893 of the device (I/O space)
894
Mike Rapoportc2fff332009-11-11 10:03:03 +0200895 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200896 Define this if data bus is 32 bits
897
Mike Rapoportc2fff332009-11-11 10:03:03 +0200898 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200899 Define this if data bus is 16 bits. If your processor
900 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200901 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200902
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900903 CONFIG_SH_ETHER
904 Support for Renesas on-chip Ethernet controller
905
906 CONFIG_SH_ETHER_USE_PORT
907 Define the number of ports to be used
908
909 CONFIG_SH_ETHER_PHY_ADDR
910 Define the ETH PHY's address
911
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900912 CONFIG_SH_ETHER_CACHE_WRITEBACK
913 If this option is set, the driver enables cache flush.
914
wdenkc6097192002-11-03 00:24:07 +0000915- USB Support:
916 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000917 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000918 CONFIG_USB_UHCI to enable it.
919 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000920 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000921 storage devices.
922 Note:
923 Supported are USB Keyboards and USB Floppy drives
924 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000925 MPC5200 USB requires additional defines:
926 CONFIG_USB_CLOCK
927 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500928 CONFIG_PSC3_USB
929 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000930 CONFIG_USB_CONFIG
931 for differential drivers: 0x00001000
932 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500933 for differential drivers on PSC3: 0x00000100
934 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200935 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200936 May be defined to allow interrupt polling
937 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000938
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200939- USB Device:
940 Define the below if you wish to use the USB console.
941 Once firmware is rebuilt from a serial console issue the
942 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200943 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200944 it has found a new device. The environment variable usbtty
945 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200946 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200947 Common Device Class Abstract Control Model serial device.
948 If you select usbtty = gserial you should be able to enumerate
949 a Linux host by
950 # modprobe usbserial vendor=0xVendorID product=0xProductID
951 else if using cdc_acm, simply setting the environment
952 variable usbtty to be cdc_acm should suffice. The following
953 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200954
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200955 CONFIG_USB_DEVICE
956 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000957
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200958 CONFIG_USB_TTY
959 Define this to have a tty type of device available to
960 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200961
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200962 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200963 Define this if you want stdin, stdout &/or stderr to
964 be set to usbtty.
965
966 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200967 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200968 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200969 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200970
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200971 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200972 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200973 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200974
Wolfgang Denk386eda02006-06-14 18:14:56 +0200975 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200976 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200977 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200978 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
979 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
980 should pretend to be a Linux device to it's target host.
981
982 CONFIG_USBD_MANUFACTURER
983 Define this string as the name of your company for
984 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200985
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200986 CONFIG_USBD_PRODUCT_NAME
987 Define this string as the name of your product
988 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
989
990 CONFIG_USBD_VENDORID
991 Define this as your assigned Vendor ID from the USB
992 Implementors Forum. This *must* be a genuine Vendor ID
993 to avoid polluting the USB namespace.
994 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200995
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200996 CONFIG_USBD_PRODUCTID
997 Define this as the unique Product ID
998 for your device
999 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001000
1001
1002- MMC Support:
1003 The MMC controller on the Intel PXA is supported. To
1004 enable this define CONFIG_MMC. The MMC can be
1005 accessed from the boot prompt by mapping the device
1006 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001007 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1008 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001009
wdenk6705d812004-08-02 23:22:59 +00001010- Journaling Flash filesystem support:
1011 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1012 CONFIG_JFFS2_NAND_DEV
1013 Define these for a default partition on a NAND device
1014
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001015 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1016 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001017 Define these for a default partition on a NOR device
1018
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001019 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001020 Define this to create an own partition. You have to provide a
1021 function struct part_info* jffs2_part_info(int part_num)
1022
1023 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001024 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001025 to disable the command chpart. This is the default when you
1026 have not defined a custom partition
1027
wdenkc6097192002-11-03 00:24:07 +00001028- Keyboard Support:
1029 CONFIG_ISA_KEYBOARD
1030
1031 Define this to enable standard (PC-Style) keyboard
1032 support
1033
1034 CONFIG_I8042_KBD
1035 Standard PC keyboard driver with US (is default) and
1036 GERMAN key layout (switch via environment 'keymap=de') support.
1037 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1038 for cfb_console. Supports cursor blinking.
1039
1040- Video support:
1041 CONFIG_VIDEO
1042
1043 Define this to enable video support (for output to
1044 video).
1045
1046 CONFIG_VIDEO_CT69000
1047
1048 Enable Chips & Technologies 69000 Video chip
1049
1050 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001051 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001052 video output is selected via environment 'videoout'
1053 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1054 assumed.
wdenkc6097192002-11-03 00:24:07 +00001055
wdenkb79a11c2004-03-25 15:14:43 +00001056 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001057 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001058 are possible:
1059 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001060 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001061
1062 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1063 -------------+---------------------------------------------
1064 8 bits | 0x301* 0x303 0x305 0x161 0x307
1065 15 bits | 0x310 0x313 0x316 0x162 0x319
1066 16 bits | 0x311 0x314 0x317 0x163 0x31A
1067 24 bits | 0x312 0x315 0x318 ? 0x31B
1068 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001069 (i.e. setenv videomode 317; saveenv; reset;)
1070
wdenkb79a11c2004-03-25 15:14:43 +00001071 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001072 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001073
1074
stroesec1551ea2003-04-04 15:53:41 +00001075 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001076 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001077 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1078 or CONFIG_VIDEO_SED13806_16BPP
1079
Timur Tabi7d3053f2011-02-15 17:09:19 -06001080 CONFIG_FSL_DIU_FB
1081 Enable the Freescale DIU video driver. Reference boards for
1082 SOCs that have a DIU should define this macro to enable DIU
1083 support, and should also define these other macros:
1084
1085 CONFIG_SYS_DIU_ADDR
1086 CONFIG_VIDEO
1087 CONFIG_CMD_BMP
1088 CONFIG_CFB_CONSOLE
1089 CONFIG_VIDEO_SW_CURSOR
1090 CONFIG_VGA_AS_SINGLE_DEVICE
1091 CONFIG_VIDEO_LOGO
1092 CONFIG_VIDEO_BMP_LOGO
1093
1094 The DIU driver will look for the 'monitor' environment variable,
1095 and if defined, enable the DIU as a console during boot. This
1096 variable should be set to one of these values:
1097
1098 '0' Output video to the DVI connector
1099 '1' Output video to the LVDS connector
1100 '2' Output video to the Dual-Link LVDS connector
1101
wdenk682011f2003-06-03 23:54:09 +00001102- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001103 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001104
wdenk8bde7f72003-06-27 21:31:46 +00001105 Define this to enable a custom keyboard support.
1106 This simply calls drv_keyboard_init() which must be
1107 defined in your board-specific files.
1108 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001109
wdenkc6097192002-11-03 00:24:07 +00001110- LCD Support: CONFIG_LCD
1111
1112 Define this to enable LCD support (for output to LCD
1113 display); also select one of the supported displays
1114 by defining one of these:
1115
Stelian Pop39cf4802008-05-09 21:57:18 +02001116 CONFIG_ATMEL_LCD:
1117
1118 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1119
wdenkfd3103b2003-11-25 16:55:19 +00001120 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001121
wdenkfd3103b2003-11-25 16:55:19 +00001122 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001123
wdenkfd3103b2003-11-25 16:55:19 +00001124 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001125
wdenkfd3103b2003-11-25 16:55:19 +00001126 NEC NL6448BC20-08. 6.5", 640x480.
1127 Active, color, single scan.
1128
1129 CONFIG_NEC_NL6448BC33_54
1130
1131 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001132 Active, color, single scan.
1133
1134 CONFIG_SHARP_16x9
1135
1136 Sharp 320x240. Active, color, single scan.
1137 It isn't 16x9, and I am not sure what it is.
1138
1139 CONFIG_SHARP_LQ64D341
1140
1141 Sharp LQ64D341 display, 640x480.
1142 Active, color, single scan.
1143
1144 CONFIG_HLD1045
1145
1146 HLD1045 display, 640x480.
1147 Active, color, single scan.
1148
1149 CONFIG_OPTREX_BW
1150
1151 Optrex CBL50840-2 NF-FW 99 22 M5
1152 or
1153 Hitachi LMG6912RPFC-00T
1154 or
1155 Hitachi SP14Q002
1156
1157 320x240. Black & white.
1158
1159 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001160 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001161
wdenk7152b1d2003-09-05 23:19:14 +00001162- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001163
wdenk8bde7f72003-06-27 21:31:46 +00001164 If this option is set, the environment is checked for
1165 a variable "splashimage". If found, the usual display
1166 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001167 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001168 specified in "splashimage" is loaded instead. The
1169 console is redirected to the "nulldev", too. This
1170 allows for a "silent" boot where a splash screen is
1171 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001172
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001173 CONFIG_SPLASH_SCREEN_ALIGN
1174
1175 If this option is set the splash image can be freely positioned
1176 on the screen. Environment variable "splashpos" specifies the
1177 position as "x,y". If a positive number is given it is used as
1178 number of pixel from left/top. If a negative number is given it
1179 is used as number of pixel from right/bottom. You can also
1180 specify 'm' for centering the image.
1181
1182 Example:
1183 setenv splashpos m,m
1184 => image at center of screen
1185
1186 setenv splashpos 30,20
1187 => image at x = 30 and y = 20
1188
1189 setenv splashpos -10,m
1190 => vertically centered image
1191 at x = dspWidth - bmpWidth - 9
1192
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001193- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1194
1195 If this option is set, additionally to standard BMP
1196 images, gzipped BMP images can be displayed via the
1197 splashscreen support or the bmp command.
1198
Anatolij Gustschind5011762010-03-15 14:50:25 +01001199- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1200
1201 If this option is set, 8-bit RLE compressed BMP images
1202 can be displayed via the splashscreen support or the
1203 bmp command.
1204
wdenkc29fdfc2003-08-29 20:57:53 +00001205- Compression support:
1206 CONFIG_BZIP2
1207
1208 If this option is set, support for bzip2 compressed
1209 images is included. If not, only uncompressed and gzip
1210 compressed images are supported.
1211
wdenk42d1f032003-10-15 23:53:47 +00001212 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001213 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001214 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001215
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001216 CONFIG_LZMA
1217
1218 If this option is set, support for lzma compressed
1219 images is included.
1220
1221 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1222 requires an amount of dynamic memory that is given by the
1223 formula:
1224
1225 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1226
1227 Where lc and lp stand for, respectively, Literal context bits
1228 and Literal pos bits.
1229
1230 This value is upper-bounded by 14MB in the worst case. Anyway,
1231 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1232 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1233 a very small buffer.
1234
1235 Use the lzmainfo tool to determinate the lc and lp values and
1236 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001237 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001238
wdenk17ea1172004-06-06 21:51:03 +00001239- MII/PHY support:
1240 CONFIG_PHY_ADDR
1241
1242 The address of PHY on MII bus.
1243
1244 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1245
1246 The clock frequency of the MII bus
1247
1248 CONFIG_PHY_GIGE
1249
1250 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001251 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001252
1253 CONFIG_PHY_RESET_DELAY
1254
1255 Some PHY like Intel LXT971A need extra delay after
1256 reset before any MII register access is possible.
1257 For such PHY, set this option to the usec delay
1258 required. (minimum 300usec for LXT971A)
1259
1260 CONFIG_PHY_CMD_DELAY (ppc4xx)
1261
1262 Some PHY like Intel LXT971A need extra delay after
1263 command issued before MII status register can be read
1264
wdenkc6097192002-11-03 00:24:07 +00001265- Ethernet address:
1266 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001267 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001268 CONFIG_ETH2ADDR
1269 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001270 CONFIG_ETH4ADDR
1271 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001272
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001273 Define a default value for Ethernet address to use
1274 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001275 is not determined automatically.
1276
1277- IP address:
1278 CONFIG_IPADDR
1279
1280 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001281 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001282 determined through e.g. bootp.
1283
1284- Server IP address:
1285 CONFIG_SERVERIP
1286
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001287 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001288 server to contact when using the "tftboot" command.
1289
Robin Getz97cfe862009-07-21 12:15:28 -04001290 CONFIG_KEEP_SERVERADDR
1291
1292 Keeps the server's MAC address, in the env 'serveraddr'
1293 for passing to bootargs (like Linux's netconsole option)
1294
David Updegraff53a5c422007-06-11 10:41:07 -05001295- Multicast TFTP Mode:
1296 CONFIG_MCAST_TFTP
1297
1298 Defines whether you want to support multicast TFTP as per
1299 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001300 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001301 driver in use must provide a function: mcast() to join/leave a
1302 multicast group.
1303
1304 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001305- BOOTP Recovery Mode:
1306 CONFIG_BOOTP_RANDOM_DELAY
1307
1308 If you have many targets in a network that try to
1309 boot using BOOTP, you may want to avoid that all
1310 systems send out BOOTP requests at precisely the same
1311 moment (which would happen for instance at recovery
1312 from a power failure, when all systems will try to
1313 boot, thus flooding the BOOTP server. Defining
1314 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1315 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001316 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001317
1318 1st BOOTP request: delay 0 ... 1 sec
1319 2nd BOOTP request: delay 0 ... 2 sec
1320 3rd BOOTP request: delay 0 ... 4 sec
1321 4th and following
1322 BOOTP requests: delay 0 ... 8 sec
1323
stroesefe389a82003-08-28 14:17:32 +00001324- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001325 You can fine tune the DHCP functionality by defining
1326 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001327
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001328 CONFIG_BOOTP_SUBNETMASK
1329 CONFIG_BOOTP_GATEWAY
1330 CONFIG_BOOTP_HOSTNAME
1331 CONFIG_BOOTP_NISDOMAIN
1332 CONFIG_BOOTP_BOOTPATH
1333 CONFIG_BOOTP_BOOTFILESIZE
1334 CONFIG_BOOTP_DNS
1335 CONFIG_BOOTP_DNS2
1336 CONFIG_BOOTP_SEND_HOSTNAME
1337 CONFIG_BOOTP_NTPSERVER
1338 CONFIG_BOOTP_TIMEOFFSET
1339 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001340
Wilson Callan5d110f02007-07-28 10:56:13 -04001341 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1342 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001343
1344 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1345 serverip from a DHCP server, it is possible that more
1346 than one DNS serverip is offered to the client.
1347 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1348 serverip will be stored in the additional environment
1349 variable "dnsip2". The first DNS serverip is always
1350 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001351 is defined.
stroesefe389a82003-08-28 14:17:32 +00001352
1353 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1354 to do a dynamic update of a DNS server. To do this, they
1355 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001356 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001357 of the "hostname" environment variable is passed as
1358 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001359
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001360 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1361
1362 A 32bit value in microseconds for a delay between
1363 receiving a "DHCP Offer" and sending the "DHCP Request".
1364 This fixes a problem with certain DHCP servers that don't
1365 respond 100% of the time to a "DHCP request". E.g. On an
1366 AT91RM9200 processor running at 180MHz, this delay needed
1367 to be *at least* 15,000 usec before a Windows Server 2003
1368 DHCP server would reply 100% of the time. I recommend at
1369 least 50,000 usec to be safe. The alternative is to hope
1370 that one of the retries will be successful but note that
1371 the DHCP timeout and retry process takes a longer than
1372 this delay.
1373
wdenka3d991b2004-04-15 21:48:45 +00001374 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001375 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001376
1377 The device id used in CDP trigger frames.
1378
1379 CONFIG_CDP_DEVICE_ID_PREFIX
1380
1381 A two character string which is prefixed to the MAC address
1382 of the device.
1383
1384 CONFIG_CDP_PORT_ID
1385
1386 A printf format string which contains the ascii name of
1387 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001388 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001389
1390 CONFIG_CDP_CAPABILITIES
1391
1392 A 32bit integer which indicates the device capabilities;
1393 0x00000010 for a normal host which does not forwards.
1394
1395 CONFIG_CDP_VERSION
1396
1397 An ascii string containing the version of the software.
1398
1399 CONFIG_CDP_PLATFORM
1400
1401 An ascii string containing the name of the platform.
1402
1403 CONFIG_CDP_TRIGGER
1404
1405 A 32bit integer sent on the trigger.
1406
1407 CONFIG_CDP_POWER_CONSUMPTION
1408
1409 A 16bit integer containing the power consumption of the
1410 device in .1 of milliwatts.
1411
1412 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1413
1414 A byte containing the id of the VLAN.
1415
wdenkc6097192002-11-03 00:24:07 +00001416- Status LED: CONFIG_STATUS_LED
1417
1418 Several configurations allow to display the current
1419 status using a LED. For instance, the LED will blink
1420 fast while running U-Boot code, stop blinking as
1421 soon as a reply to a BOOTP request was received, and
1422 start blinking slow once the Linux kernel is running
1423 (supported by a status LED driver in the Linux
1424 kernel). Defining CONFIG_STATUS_LED enables this
1425 feature in U-Boot.
1426
1427- CAN Support: CONFIG_CAN_DRIVER
1428
1429 Defining CONFIG_CAN_DRIVER enables CAN driver support
1430 on those systems that support this (optional)
1431 feature, like the TQM8xxL modules.
1432
1433- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1434
wdenkb37c7e52003-06-30 16:24:52 +00001435 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001436 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001437 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001438
wdenk945af8d2003-07-16 21:53:01 +00001439 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001440 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001441 CONFIG_COMMANDS) and communicate with i2c based realtime
1442 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001443 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001444
Ben Warrenbb99ad62006-09-07 16:50:54 -04001445 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001446
wdenk945af8d2003-07-16 21:53:01 +00001447 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001448 bit-banging) driver instead of CPM or similar hardware
1449 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001450
wdenk945af8d2003-07-16 21:53:01 +00001451 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001452 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001454 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001455 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001456 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001457 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001458
Peter Tyser8d321b82010-04-12 22:28:21 -05001459 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001460 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001461 and so its address should therefore be cleared to 0 (See,
1462 eg, MPC823e User's Manual p.16-473). So, set
1463 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001464
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001465 CONFIG_SYS_I2C_INIT_MPC5XXX
1466
1467 When a board is reset during an i2c bus transfer
1468 chips might think that the current transfer is still
1469 in progress. Reset the slave devices by sending start
1470 commands until the slave device responds.
1471
wdenk945af8d2003-07-16 21:53:01 +00001472 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001473
1474 If you use the software i2c interface (CONFIG_SOFT_I2C)
1475 then the following macros need to be defined (examples are
1476 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001477
1478 I2C_INIT
1479
wdenkb37c7e52003-06-30 16:24:52 +00001480 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001481 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001482
wdenkba56f622004-02-06 23:19:44 +00001483 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001484
wdenkc6097192002-11-03 00:24:07 +00001485 I2C_PORT
1486
wdenk43d96162003-03-06 00:02:04 +00001487 (Only for MPC8260 CPU). The I/O port to use (the code
1488 assumes both bits are on the same port). Valid values
1489 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001490
1491 I2C_ACTIVE
1492
1493 The code necessary to make the I2C data line active
1494 (driven). If the data line is open collector, this
1495 define can be null.
1496
wdenkb37c7e52003-06-30 16:24:52 +00001497 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1498
wdenkc6097192002-11-03 00:24:07 +00001499 I2C_TRISTATE
1500
1501 The code necessary to make the I2C data line tri-stated
1502 (inactive). If the data line is open collector, this
1503 define can be null.
1504
wdenkb37c7e52003-06-30 16:24:52 +00001505 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1506
wdenkc6097192002-11-03 00:24:07 +00001507 I2C_READ
1508
1509 Code that returns TRUE if the I2C data line is high,
1510 FALSE if it is low.
1511
wdenkb37c7e52003-06-30 16:24:52 +00001512 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1513
wdenkc6097192002-11-03 00:24:07 +00001514 I2C_SDA(bit)
1515
1516 If <bit> is TRUE, sets the I2C data line high. If it
1517 is FALSE, it clears it (low).
1518
wdenkb37c7e52003-06-30 16:24:52 +00001519 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001520 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001521 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001522
wdenkc6097192002-11-03 00:24:07 +00001523 I2C_SCL(bit)
1524
1525 If <bit> is TRUE, sets the I2C clock line high. If it
1526 is FALSE, it clears it (low).
1527
wdenkb37c7e52003-06-30 16:24:52 +00001528 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001529 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001530 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001531
wdenkc6097192002-11-03 00:24:07 +00001532 I2C_DELAY
1533
1534 This delay is invoked four times per clock cycle so this
1535 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001536 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001537 like:
1538
wdenkb37c7e52003-06-30 16:24:52 +00001539 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001540
Mike Frysinger793b5722010-07-21 13:38:02 -04001541 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1542
1543 If your arch supports the generic GPIO framework (asm/gpio.h),
1544 then you may alternatively define the two GPIOs that are to be
1545 used as SCL / SDA. Any of the previous I2C_xxx macros will
1546 have GPIO-based defaults assigned to them as appropriate.
1547
1548 You should define these to the GPIO value as given directly to
1549 the generic GPIO functions.
1550
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001551 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001552
wdenk8bde7f72003-06-27 21:31:46 +00001553 When a board is reset during an i2c bus transfer
1554 chips might think that the current transfer is still
1555 in progress. On some boards it is possible to access
1556 the i2c SCLK line directly, either by using the
1557 processor pin as a GPIO or by having a second pin
1558 connected to the bus. If this option is defined a
1559 custom i2c_init_board() routine in boards/xxx/board.c
1560 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001561
Richard Retanubun26a33502010-04-12 15:08:17 -04001562 CONFIG_SYS_I2C_BOARD_LATE_INIT
1563
1564 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1565 defined a custom i2c_board_late_init() routine in
1566 boards/xxx/board.c is run AFTER the operations in i2c_init()
1567 is completed. This callpoint can be used to unreset i2c bus
1568 using CPU i2c controller register accesses for CPUs whose i2c
1569 controller provide such a method. It is called at the end of
1570 i2c_init() to allow i2c_init operations to setup the i2c bus
1571 controller on the CPU (e.g. setting bus speed & slave address).
1572
wdenk17ea1172004-06-06 21:51:03 +00001573 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1574
1575 This option enables configuration of bi_iic_fast[] flags
1576 in u-boot bd_info structure based on u-boot environment
1577 variable "i2cfast". (see also i2cfast)
1578
Ben Warrenbb99ad62006-09-07 16:50:54 -04001579 CONFIG_I2C_MULTI_BUS
1580
1581 This option allows the use of multiple I2C buses, each of which
1582 must have a controller. At any point in time, only one bus is
1583 active. To switch to a different bus, use the 'i2c dev' command.
1584 Note that bus numbering is zero-based.
1585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001586 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001587
1588 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001589 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1590 is set, specify a list of bus-device pairs. Otherwise, specify
1591 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001592
1593 e.g.
1594 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001595 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001596
1597 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1598
1599 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001600 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001601
1602 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1603
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001604 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001605
1606 If defined, then this indicates the I2C bus number for DDR SPD.
1607 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1608
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001609 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001610
1611 If defined, then this indicates the I2C bus number for the RTC.
1612 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001614 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001615
1616 If defined, then this indicates the I2C bus number for the DTT.
1617 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001619 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001620
1621 If defined, specifies the I2C address of the DTT device.
1622 If not defined, then U-Boot uses predefined value for
1623 specified DTT device.
1624
Timur Tabibe5e6182006-11-03 19:15:00 -06001625 CONFIG_FSL_I2C
1626
1627 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001628 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001629
Heiko Schocher67b23a32008-10-15 09:39:47 +02001630 CONFIG_I2C_MUX
1631
1632 Define this option if you have I2C devices reached over 1 .. n
1633 I2C Muxes like the pca9544a. This option addes a new I2C
1634 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1635 new I2C Bus to the existing I2C Busses. If you select the
1636 new Bus with "i2c dev", u-bbot sends first the commandos for
1637 the muxes to activate this new "bus".
1638
1639 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1640 feature!
1641
1642 Example:
1643 Adding a new I2C Bus reached over 2 pca9544a muxes
1644 The First mux with address 70 and channel 6
1645 The Second mux with address 71 and channel 4
1646
1647 => i2c bus pca9544a:70:6:pca9544a:71:4
1648
1649 Use the "i2c bus" command without parameter, to get a list
1650 of I2C Busses with muxes:
1651
1652 => i2c bus
1653 Busses reached over muxes:
1654 Bus ID: 2
1655 reached over Mux(es):
1656 pca9544a@70 ch: 4
1657 Bus ID: 3
1658 reached over Mux(es):
1659 pca9544a@70 ch: 6
1660 pca9544a@71 ch: 4
1661 =>
1662
1663 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1664 u-boot sends First the Commando to the mux@70 to enable
1665 channel 6, and then the Commando to the mux@71 to enable
1666 the channel 4.
1667
1668 After that, you can use the "normal" i2c commands as
1669 usual, to communicate with your I2C devices behind
1670 the 2 muxes.
1671
1672 This option is actually implemented for the bitbanging
1673 algorithm in common/soft_i2c.c and for the Hardware I2C
1674 Bus on the MPC8260. But it should be not so difficult
1675 to add this option to other architectures.
1676
Andrew Dyer2ac69852008-12-29 17:36:01 -06001677 CONFIG_SOFT_I2C_READ_REPEATED_START
1678
1679 defining this will force the i2c_read() function in
1680 the soft_i2c driver to perform an I2C repeated start
1681 between writing the address pointer and reading the
1682 data. If this define is omitted the default behaviour
1683 of doing a stop-start sequence will be used. Most I2C
1684 devices can use either method, but some require one or
1685 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001686
wdenkc6097192002-11-03 00:24:07 +00001687- SPI Support: CONFIG_SPI
1688
1689 Enables SPI driver (so far only tested with
1690 SPI EEPROM, also an instance works with Crystal A/D and
1691 D/As on the SACSng board)
1692
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001693 CONFIG_SH_SPI
1694
1695 Enables the driver for SPI controller on SuperH. Currently
1696 only SH7757 is supported.
1697
wdenkc6097192002-11-03 00:24:07 +00001698 CONFIG_SPI_X
1699
1700 Enables extended (16-bit) SPI EEPROM addressing.
1701 (symmetrical to CONFIG_I2C_X)
1702
1703 CONFIG_SOFT_SPI
1704
wdenk43d96162003-03-06 00:02:04 +00001705 Enables a software (bit-bang) SPI driver rather than
1706 using hardware support. This is a general purpose
1707 driver that only requires three general I/O port pins
1708 (two outputs, one input) to function. If this is
1709 defined, the board configuration must define several
1710 SPI configuration items (port pins to use, etc). For
1711 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001712
Ben Warren04a9e112008-01-16 22:37:35 -05001713 CONFIG_HARD_SPI
1714
1715 Enables a hardware SPI driver for general-purpose reads
1716 and writes. As with CONFIG_SOFT_SPI, the board configuration
1717 must define a list of chip-select function pointers.
1718 Currently supported on some MPC8xxx processors. For an
1719 example, see include/configs/mpc8349emds.h.
1720
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001721 CONFIG_MXC_SPI
1722
1723 Enables the driver for the SPI controllers on i.MX and MXC
1724 SoCs. Currently only i.MX31 is supported.
1725
Matthias Fuchs01335022007-12-27 17:12:34 +01001726- FPGA Support: CONFIG_FPGA
1727
1728 Enables FPGA subsystem.
1729
1730 CONFIG_FPGA_<vendor>
1731
1732 Enables support for specific chip vendors.
1733 (ALTERA, XILINX)
1734
1735 CONFIG_FPGA_<family>
1736
1737 Enables support for FPGA family.
1738 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1739
1740 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001741
wdenk43d96162003-03-06 00:02:04 +00001742 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001744 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001745
wdenk8bde7f72003-06-27 21:31:46 +00001746 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001748 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001749
wdenk43d96162003-03-06 00:02:04 +00001750 Enable checks on FPGA configuration interface busy
1751 status by the configuration function. This option
1752 will require a board or device specific function to
1753 be written.
wdenkc6097192002-11-03 00:24:07 +00001754
1755 CONFIG_FPGA_DELAY
1756
1757 If defined, a function that provides delays in the FPGA
1758 configuration driver.
1759
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001760 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001761 Allow Control-C to interrupt FPGA configuration
1762
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001763 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001764
wdenk43d96162003-03-06 00:02:04 +00001765 Check for configuration errors during FPGA bitfile
1766 loading. For example, abort during Virtex II
1767 configuration if the INIT_B line goes low (which
1768 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001769
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001770 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001771
wdenk43d96162003-03-06 00:02:04 +00001772 Maximum time to wait for the INIT_B line to deassert
1773 after PROB_B has been deasserted during a Virtex II
1774 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001775 ms.
wdenkc6097192002-11-03 00:24:07 +00001776
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001777 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001778
wdenk43d96162003-03-06 00:02:04 +00001779 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001780 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001782 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001783
wdenk43d96162003-03-06 00:02:04 +00001784 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001785 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001786
1787- Configuration Management:
1788 CONFIG_IDENT_STRING
1789
wdenk43d96162003-03-06 00:02:04 +00001790 If defined, this string will be added to the U-Boot
1791 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001792
1793- Vendor Parameter Protection:
1794
wdenk43d96162003-03-06 00:02:04 +00001795 U-Boot considers the values of the environment
1796 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001797 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001798 are set once by the board vendor / manufacturer, and
1799 protects these variables from casual modification by
1800 the user. Once set, these variables are read-only,
1801 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001802 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001803
1804 If CONFIG_ENV_OVERWRITE is #defined in your config
1805 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001806 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001807 these parameters.
1808
1809 Alternatively, if you #define _both_ CONFIG_ETHADDR
1810 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001811 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001812 which can be changed exactly ONCE by the user. [The
1813 serial# is unaffected by this, i. e. it remains
1814 read-only.]
1815
1816- Protected RAM:
1817 CONFIG_PRAM
1818
1819 Define this variable to enable the reservation of
1820 "protected RAM", i. e. RAM which is not overwritten
1821 by U-Boot. Define CONFIG_PRAM to hold the number of
1822 kB you want to reserve for pRAM. You can overwrite
1823 this default value by defining an environment
1824 variable "pram" to the number of kB you want to
1825 reserve. Note that the board info structure will
1826 still show the full amount of RAM. If pRAM is
1827 reserved, a new environment variable "mem" will
1828 automatically be defined to hold the amount of
1829 remaining RAM in a form that can be passed as boot
1830 argument to Linux, for instance like that:
1831
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001832 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001833 saveenv
1834
1835 This way you can tell Linux not to use this memory,
1836 either, which results in a memory region that will
1837 not be affected by reboots.
1838
1839 *WARNING* If your board configuration uses automatic
1840 detection of the RAM size, you must make sure that
1841 this memory test is non-destructive. So far, the
1842 following board configurations are known to be
1843 "pRAM-clean":
1844
1845 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1846 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001847 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001848
1849- Error Recovery:
1850 CONFIG_PANIC_HANG
1851
1852 Define this variable to stop the system in case of a
1853 fatal error, so that you have to reset it manually.
1854 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001855 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001856 automatically as fast as possible, but it may be
1857 useful during development since you can try to debug
1858 the conditions that lead to the situation.
1859
1860 CONFIG_NET_RETRY_COUNT
1861
wdenk43d96162003-03-06 00:02:04 +00001862 This variable defines the number of retries for
1863 network operations like ARP, RARP, TFTP, or BOOTP
1864 before giving up the operation. If not defined, a
1865 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001866
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001867 CONFIG_ARP_TIMEOUT
1868
1869 Timeout waiting for an ARP reply in milliseconds.
1870
wdenkc6097192002-11-03 00:24:07 +00001871- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001872 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001873
1874 Enable auto completion of commands using TAB.
1875
Wolfgang Denka9398e02006-11-27 15:32:42 +01001876 Note that this feature has NOT been implemented yet
1877 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001878
1879
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001880 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001881
1882 Define this variable to enable the "hush" shell (from
1883 Busybox) as command line interpreter, thus enabling
1884 powerful command line syntax like
1885 if...then...else...fi conditionals or `&&' and '||'
1886 constructs ("shell scripts").
1887
1888 If undefined, you get the old, much simpler behaviour
1889 with a somewhat smaller memory footprint.
1890
1891
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001892 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001893
1894 This defines the secondary prompt string, which is
1895 printed when the command interpreter needs more input
1896 to complete a command. Usually "> ".
1897
1898 Note:
1899
wdenk8bde7f72003-06-27 21:31:46 +00001900 In the current implementation, the local variables
1901 space and global environment variables space are
1902 separated. Local variables are those you define by
1903 simply typing `name=value'. To access a local
1904 variable later on, you have write `$name' or
1905 `${name}'; to execute the contents of a variable
1906 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001907
wdenk43d96162003-03-06 00:02:04 +00001908 Global environment variables are those you use
1909 setenv/printenv to work with. To run a command stored
1910 in such a variable, you need to use the run command,
1911 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001912
1913 To store commands and special characters in a
1914 variable, please use double quotation marks
1915 surrounding the whole text of the variable, instead
1916 of the backslashes before semicolons and special
1917 symbols.
1918
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001919- Commandline Editing and History:
1920 CONFIG_CMDLINE_EDITING
1921
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001922 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001923 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001924
wdenka8c7c702003-12-06 19:49:23 +00001925- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001926 CONFIG_EXTRA_ENV_SETTINGS
1927
wdenk43d96162003-03-06 00:02:04 +00001928 Define this to contain any number of null terminated
1929 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001930 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001931
wdenk43d96162003-03-06 00:02:04 +00001932 For example, place something like this in your
1933 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001934
1935 #define CONFIG_EXTRA_ENV_SETTINGS \
1936 "myvar1=value1\0" \
1937 "myvar2=value2\0"
1938
wdenk43d96162003-03-06 00:02:04 +00001939 Warning: This method is based on knowledge about the
1940 internal format how the environment is stored by the
1941 U-Boot code. This is NOT an official, exported
1942 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001943 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001944 You better know what you are doing here.
1945
wdenk43d96162003-03-06 00:02:04 +00001946 Note: overly (ab)use of the default environment is
1947 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001948 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001949 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001950
wdenka8c7c702003-12-06 19:49:23 +00001951- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001952 CONFIG_HAS_DATAFLASH
1953
wdenk8bde7f72003-06-27 21:31:46 +00001954 Defining this option enables DataFlash features and
1955 allows to read/write in Dataflash via the standard
1956 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001957
wdenk3f85ce22004-02-23 16:11:30 +00001958- SystemACE Support:
1959 CONFIG_SYSTEMACE
1960
1961 Adding this option adds support for Xilinx SystemACE
1962 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001963 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001964 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001965
1966 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001967 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001968
1969 When SystemACE support is added, the "ace" device type
1970 becomes available to the fat commands, i.e. fatls.
1971
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001972- TFTP Fixed UDP Port:
1973 CONFIG_TFTP_PORT
1974
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001975 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001976 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001977 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001978 number generator is used.
1979
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001980 Also, the environment variable tftpdstp is used to supply
1981 the TFTP UDP destination port value. If tftpdstp isn't
1982 defined, the normal port 69 is used.
1983
1984 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001985 blindly start the TFTP transfer using the pre-configured
1986 target IP address and UDP port. This has the effect of
1987 "punching through" the (Windows XP) firewall, allowing
1988 the remainder of the TFTP transfer to proceed normally.
1989 A better solution is to properly configure the firewall,
1990 but sometimes that is not allowed.
1991
wdenka8c7c702003-12-06 19:49:23 +00001992- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001993 CONFIG_SHOW_BOOT_PROGRESS
1994
wdenk43d96162003-03-06 00:02:04 +00001995 Defining this option allows to add some board-
1996 specific code (calling a user-provided function
1997 "show_boot_progress(int)") that enables you to show
1998 the system's boot progress on some display (for
1999 example, some LED's) on your board. At the moment,
2000 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002001
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002002- Standalone program support:
2003 CONFIG_STANDALONE_LOAD_ADDR
2004
2005 This option allows to define board specific values
2006 for the address where standalone program gets loaded,
2007 thus overwriting the architecutre dependent default
2008 settings.
2009
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002010Legacy uImage format:
2011
wdenkc6097192002-11-03 00:24:07 +00002012 Arg Where When
2013 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002014 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002015 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002016 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002017 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002018 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002019 4 common/cmd_bootm.c Image data has correct checksum
2020 -4 common/cmd_bootm.c Image is for unsupported architecture
2021 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002022 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002023 6 common/cmd_bootm.c Image Type check OK
2024 -6 common/cmd_bootm.c gunzip uncompression error
2025 -7 common/cmd_bootm.c Unimplemented compression type
2026 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002027 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002028 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002029
2030 9 common/image.c Start initial ramdisk verification
2031 -10 common/image.c Ramdisk header has bad magic number
2032 -11 common/image.c Ramdisk header has bad checksum
2033 10 common/image.c Ramdisk header is OK
2034 -12 common/image.c Ramdisk data has bad checksum
2035 11 common/image.c Ramdisk data has correct checksum
2036 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002037 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002038 13 common/image.c Start multifile image verification
2039 14 common/image.c No initial ramdisk, no multifile, continue.
2040
Peter Tyserea0364f2010-04-12 22:28:04 -05002041 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002042
Stefan Roesea47a12b2010-04-15 16:07:28 +02002043 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002044 -31 post/post.c POST test failed, detected by post_output_backlog()
2045 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002046
Heiko Schocher566a4942007-06-22 19:11:54 +02002047 34 common/cmd_doc.c before loading a Image from a DOC device
2048 -35 common/cmd_doc.c Bad usage of "doc" command
2049 35 common/cmd_doc.c correct usage of "doc" command
2050 -36 common/cmd_doc.c No boot device
2051 36 common/cmd_doc.c correct boot device
2052 -37 common/cmd_doc.c Unknown Chip ID on boot device
2053 37 common/cmd_doc.c correct chip ID found, device available
2054 -38 common/cmd_doc.c Read Error on boot device
2055 38 common/cmd_doc.c reading Image header from DOC device OK
2056 -39 common/cmd_doc.c Image header has bad magic number
2057 39 common/cmd_doc.c Image header has correct magic number
2058 -40 common/cmd_doc.c Error reading Image from DOC device
2059 40 common/cmd_doc.c Image header has correct magic number
2060 41 common/cmd_ide.c before loading a Image from a IDE device
2061 -42 common/cmd_ide.c Bad usage of "ide" command
2062 42 common/cmd_ide.c correct usage of "ide" command
2063 -43 common/cmd_ide.c No boot device
2064 43 common/cmd_ide.c boot device found
2065 -44 common/cmd_ide.c Device not available
2066 44 common/cmd_ide.c Device available
2067 -45 common/cmd_ide.c wrong partition selected
2068 45 common/cmd_ide.c partition selected
2069 -46 common/cmd_ide.c Unknown partition table
2070 46 common/cmd_ide.c valid partition table found
2071 -47 common/cmd_ide.c Invalid partition type
2072 47 common/cmd_ide.c correct partition type
2073 -48 common/cmd_ide.c Error reading Image Header on boot device
2074 48 common/cmd_ide.c reading Image Header from IDE device OK
2075 -49 common/cmd_ide.c Image header has bad magic number
2076 49 common/cmd_ide.c Image header has correct magic number
2077 -50 common/cmd_ide.c Image header has bad checksum
2078 50 common/cmd_ide.c Image header has correct checksum
2079 -51 common/cmd_ide.c Error reading Image from IDE device
2080 51 common/cmd_ide.c reading Image from IDE device OK
2081 52 common/cmd_nand.c before loading a Image from a NAND device
2082 -53 common/cmd_nand.c Bad usage of "nand" command
2083 53 common/cmd_nand.c correct usage of "nand" command
2084 -54 common/cmd_nand.c No boot device
2085 54 common/cmd_nand.c boot device found
2086 -55 common/cmd_nand.c Unknown Chip ID on boot device
2087 55 common/cmd_nand.c correct chip ID found, device available
2088 -56 common/cmd_nand.c Error reading Image Header on boot device
2089 56 common/cmd_nand.c reading Image Header from NAND device OK
2090 -57 common/cmd_nand.c Image header has bad magic number
2091 57 common/cmd_nand.c Image header has correct magic number
2092 -58 common/cmd_nand.c Error reading Image from NAND device
2093 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002094
Heiko Schocher566a4942007-06-22 19:11:54 +02002095 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002096
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002097 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002098 -64 net/eth.c no Ethernet found.
2099 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002100
Heiko Schocher566a4942007-06-22 19:11:54 +02002101 -80 common/cmd_net.c usage wrong
2102 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002103 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002104 81 common/cmd_net.c NetLoop() back without error
2105 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2106 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002107 83 common/cmd_net.c running "source" command
2108 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002109 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002110
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002111FIT uImage format:
2112
2113 Arg Where When
2114 100 common/cmd_bootm.c Kernel FIT Image has correct format
2115 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2116 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2117 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2118 102 common/cmd_bootm.c Kernel unit name specified
2119 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002120 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002121 104 common/cmd_bootm.c Got kernel subimage node offset
2122 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2123 105 common/cmd_bootm.c Kernel subimage hash verification OK
2124 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2125 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002126 -106 common/cmd_bootm.c Kernel subimage has wrong type
2127 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002128 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2129 108 common/cmd_bootm.c Got kernel subimage data/size
2130 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2131 -109 common/cmd_bootm.c Can't get kernel subimage type
2132 -110 common/cmd_bootm.c Can't get kernel subimage comp
2133 -111 common/cmd_bootm.c Can't get kernel subimage os
2134 -112 common/cmd_bootm.c Can't get kernel subimage load address
2135 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2136
2137 120 common/image.c Start initial ramdisk verification
2138 -120 common/image.c Ramdisk FIT image has incorrect format
2139 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002140 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002141 -122 common/image.c Can't get configuration for ramdisk subimage
2142 123 common/image.c Ramdisk unit name specified
2143 -124 common/image.c Can't get ramdisk subimage node offset
2144 125 common/image.c Got ramdisk subimage node offset
2145 -125 common/image.c Ramdisk subimage hash verification failed
2146 126 common/image.c Ramdisk subimage hash verification OK
2147 -126 common/image.c Ramdisk subimage for unsupported architecture
2148 127 common/image.c Architecture check OK
2149 -127 common/image.c Can't get ramdisk subimage data/size
2150 128 common/image.c Got ramdisk subimage data/size
2151 129 common/image.c Can't get ramdisk load address
2152 -129 common/image.c Got ramdisk load address
2153
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002154 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002155 131 common/cmd_doc.c FIT image format OK
2156
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002157 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002158 141 common/cmd_ide.c FIT image format OK
2159
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002160 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002161 151 common/cmd_nand.c FIT image format OK
2162
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002163- Automatic software updates via TFTP server
2164 CONFIG_UPDATE_TFTP
2165 CONFIG_UPDATE_TFTP_CNT_MAX
2166 CONFIG_UPDATE_TFTP_MSEC_MAX
2167
2168 These options enable and control the auto-update feature;
2169 for a more detailed description refer to doc/README.update.
2170
2171- MTD Support (mtdparts command, UBI support)
2172 CONFIG_MTD_DEVICE
2173
2174 Adds the MTD device infrastructure from the Linux kernel.
2175 Needed for mtdparts command support.
2176
2177 CONFIG_MTD_PARTITIONS
2178
2179 Adds the MTD partitioning infrastructure from the Linux
2180 kernel. Needed for UBI support.
2181
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002182
wdenkc6097192002-11-03 00:24:07 +00002183Modem Support:
2184--------------
2185
wdenk85ec0bc2003-03-31 16:34:49 +00002186[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002187
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002188- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002189 CONFIG_MODEM_SUPPORT
2190
2191- RTS/CTS Flow control enable:
2192 CONFIG_HWFLOW
2193
2194- Modem debug support:
2195 CONFIG_MODEM_SUPPORT_DEBUG
2196
wdenk43d96162003-03-06 00:02:04 +00002197 Enables debugging stuff (char screen[1024], dbg())
2198 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002199
wdenka8c7c702003-12-06 19:49:23 +00002200- Interrupt support (PPC):
2201
wdenkd4ca31c2004-01-02 14:00:00 +00002202 There are common interrupt_init() and timer_interrupt()
2203 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002204 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002205 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002206 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002207 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002208 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002209 specific handling. If board has watchdog / status_led
2210 / other_activity_monitor it works automatically from
2211 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002212
wdenkc6097192002-11-03 00:24:07 +00002213- General:
2214
wdenk43d96162003-03-06 00:02:04 +00002215 In the target system modem support is enabled when a
2216 specific key (key combination) is pressed during
2217 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002218 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002219 board_init(). Currently key_pressed() is a dummy
2220 function, returning 1 and thus enabling modem
2221 initialization.
wdenkc6097192002-11-03 00:24:07 +00002222
wdenk43d96162003-03-06 00:02:04 +00002223 If there are no modem init strings in the
2224 environment, U-Boot proceed to autoboot; the
2225 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002226 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002227
2228 See also: doc/README.Modem
2229
2230
wdenkc6097192002-11-03 00:24:07 +00002231Configuration Settings:
2232-----------------------
2233
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002234- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002235 undefine this when you're short of memory.
2236
Peter Tyser2fb26042009-01-27 18:03:12 -06002237- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2238 width of the commands listed in the 'help' command output.
2239
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002240- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002241 prompt for user input.
2242
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002243- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002244
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002245- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002247- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002249- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002250 the application (usually a Linux kernel) when it is
2251 booted
2252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002253- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002254 List of legal baudrate settings for this board.
2255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002256- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002257 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002259- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002260 If the board specific function
2261 extern int overwrite_console (void);
2262 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002263 serial port, else the settings in the environment are used.
2264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002265- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002266 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002267
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002268- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002269 Enable overwrite of previous console environment settings.
2270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002271- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002272 Begin and End addresses of the area used by the
2273 simple memory test.
2274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002275- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002276 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002278- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002279 Scratch address used by the alternate memory test
2280 You only need to set this if address zero isn't writeable
2281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002282- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2283 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002284 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002285 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002286 fixing up gd->ram_size the Linux kernel should gets passed
2287 the now "corrected" memory size and won't touch it either.
2288 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002289 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002290 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002291 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002292
2293 This option can be used as a workaround for the 440EPx/GRx
2294 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2295 be touched.
2296
2297 WARNING: Please make sure that this value is a multiple of
2298 the Linux page size (normally 4k). If this is not the case,
2299 then the end address of the Linux memory will be located at a
2300 non page size aligned address and this could cause major
2301 problems.
2302
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002303- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002304 Default load address for network file downloads
2305
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002306- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002307 Enable temporary baudrate change while serial download
2308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002309- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002310 Physical start address of SDRAM. _Must_ be 0 here.
2311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002312- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002313 Physical start address of Motherboard I/O (if using a
2314 Cogent motherboard)
2315
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002316- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002317 Physical start address of Flash memory.
2318
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002319- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002320 Physical start address of boot monitor code (set by
2321 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002322 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002323 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002324
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002325- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002326 Size of memory reserved for monitor code, used to
2327 determine _at_compile_time_ (!) if the environment is
2328 embedded within the U-Boot image, or in a separate
2329 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002330
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002331- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002332 Size of DRAM reserved for malloc() use.
2333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002334- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002335 Normally compressed uImages are limited to an
2336 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002337 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002338 to adjust this setting to your needs.
2339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002340- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002341 Maximum size of memory mapped by the startup code of
2342 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002343 the Linux kernel (bd_info, boot arguments, FDT blob if
2344 used) must be put below this limit, unless "bootm_low"
2345 enviroment variable is defined and non-zero. In such case
2346 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002347 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002348
John Rigbyfca43cc2010-10-13 13:57:35 -06002349- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2350 Enable initrd_high functionality. If defined then the
2351 initrd_high feature is enabled and the bootm ramdisk subcommand
2352 is enabled.
2353
2354- CONFIG_SYS_BOOT_GET_CMDLINE:
2355 Enables allocating and saving kernel cmdline in space between
2356 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2357
2358- CONFIG_SYS_BOOT_GET_KBD:
2359 Enables allocating and saving a kernel copy of the bd_info in
2360 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2361
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002362- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002363 Max number of Flash memory banks
2364
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002365- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002366 Max number of sectors on a Flash chip
2367
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002368- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002369 Timeout for Flash erase operations (in ms)
2370
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002371- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002372 Timeout for Flash write operations (in ms)
2373
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002374- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002375 Timeout for Flash set sector lock bit operation (in ms)
2376
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002377- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002378 Timeout for Flash clear lock bits operation (in ms)
2379
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002380- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002381 If defined, hardware flash sectors protection is used
2382 instead of U-Boot software protection.
2383
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002384- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002385
2386 Enable TFTP transfers directly to flash memory;
2387 without this option such a download has to be
2388 performed in two steps: (1) download to RAM, and (2)
2389 copy from RAM to flash.
2390
2391 The two-step approach is usually more reliable, since
2392 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002393 the flash, but in some situations (when system RAM is
2394 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002395 downloaded image) this option may be very useful.
2396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002397- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002398 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002399 common flash structure for storing flash geometry.
2400
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002401- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002402 This option also enables the building of the cfi_flash driver
2403 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002404
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002405- CONFIG_FLASH_CFI_MTD
2406 This option enables the building of the cfi_mtd driver
2407 in the drivers directory. The driver exports CFI flash
2408 to the MTD layer.
2409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002410- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002411 Use buffered writes to flash.
2412
2413- CONFIG_FLASH_SPANSION_S29WS_N
2414 s29ws-n MirrorBit flash has non-standard addresses for buffered
2415 write commands.
2416
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002417- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002418 If this option is defined, the common CFI flash doesn't
2419 print it's warning upon not recognized FLASH banks. This
2420 is useful, if some of the configured banks are only
2421 optionally available.
2422
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002423- CONFIG_FLASH_SHOW_PROGRESS
2424 If defined (must be an integer), print out countdown
2425 digits and dots. Recommended value: 45 (9..1) for 80
2426 column displays, 15 (3..1) for 40 column displays.
2427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002428- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002429 Defines the number of Ethernet receive buffers. On some
2430 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002431 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2432 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002433 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002434 Defaults to 4 if not defined.
2435
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002436- CONFIG_ENV_MAX_ENTRIES
2437
Wolfgang Denk071bc922010-10-27 22:48:30 +02002438 Maximum number of entries in the hash table that is used
2439 internally to store the environment settings. The default
2440 setting is supposed to be generous and should work in most
2441 cases. This setting can be used to tune behaviour; see
2442 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002443
wdenkc6097192002-11-03 00:24:07 +00002444The following definitions that deal with the placement and management
2445of environment data (variable area); in general, we support the
2446following configurations:
2447
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002448- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002449
2450 Define this if the environment is in flash memory.
2451
2452 a) The environment occupies one whole flash sector, which is
2453 "embedded" in the text segment with the U-Boot code. This
2454 happens usually with "bottom boot sector" or "top boot
2455 sector" type flash chips, which have several smaller
2456 sectors at the start or the end. For instance, such a
2457 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2458 such a case you would place the environment in one of the
2459 4 kB sectors - with U-Boot code before and after it. With
2460 "top boot sector" type flash chips, you would put the
2461 environment in one of the last sectors, leaving a gap
2462 between U-Boot and the environment.
2463
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002464 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002465
2466 Offset of environment data (variable area) to the
2467 beginning of flash memory; for instance, with bottom boot
2468 type flash chips the second sector can be used: the offset
2469 for this sector is given here.
2470
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002471 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002472
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002473 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002474
2475 This is just another way to specify the start address of
2476 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002477 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002478
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002479 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002480
2481 Size of the sector containing the environment.
2482
2483
2484 b) Sometimes flash chips have few, equal sized, BIG sectors.
2485 In such a case you don't want to spend a whole sector for
2486 the environment.
2487
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002488 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002489
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002490 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002491 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002492 of this flash sector for the environment. This saves
2493 memory for the RAM copy of the environment.
2494
2495 It may also save flash memory if you decide to use this
2496 when your environment is "embedded" within U-Boot code,
2497 since then the remainder of the flash sector could be used
2498 for U-Boot code. It should be pointed out that this is
2499 STRONGLY DISCOURAGED from a robustness point of view:
2500 updating the environment in flash makes it always
2501 necessary to erase the WHOLE sector. If something goes
2502 wrong before the contents has been restored from a copy in
2503 RAM, your target system will be dead.
2504
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002505 - CONFIG_ENV_ADDR_REDUND
2506 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002507
wdenk43d96162003-03-06 00:02:04 +00002508 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002509 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002510 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002511 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002512
2513BE CAREFUL! Any changes to the flash layout, and some changes to the
2514source code will make it necessary to adapt <board>/u-boot.lds*
2515accordingly!
2516
2517
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002518- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002519
2520 Define this if you have some non-volatile memory device
2521 (NVRAM, battery buffered SRAM) which you want to use for the
2522 environment.
2523
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002524 - CONFIG_ENV_ADDR:
2525 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002526
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002527 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002528 want to use for environment. It is assumed that this memory
2529 can just be read and written to, without any special
2530 provision.
2531
2532BE CAREFUL! The first access to the environment happens quite early
2533in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002534console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002535U-Boot will hang.
2536
2537Please note that even with NVRAM we still use a copy of the
2538environment in RAM: we could work on NVRAM directly, but we want to
2539keep settings there always unmodified except somebody uses "saveenv"
2540to save the current settings.
2541
2542
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002543- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002544
2545 Use this if you have an EEPROM or similar serial access
2546 device and a driver for it.
2547
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002548 - CONFIG_ENV_OFFSET:
2549 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002550
2551 These two #defines specify the offset and size of the
2552 environment area within the total memory of your EEPROM.
2553
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002554 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002555 If defined, specified the chip address of the EEPROM device.
2556 The default address is zero.
2557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002558 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002559 If defined, the number of bits used to address bytes in a
2560 single page in the EEPROM device. A 64 byte page, for example
2561 would require six bits.
2562
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002563 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002564 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002565 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002566
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002567 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002568 The length in bytes of the EEPROM memory array address. Note
2569 that this is NOT the chip address length!
2570
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002571 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002572 EEPROM chips that implement "address overflow" are ones
2573 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2574 address and the extra bits end up in the "chip address" bit
2575 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2576 byte chips.
2577
2578 Note that we consider the length of the address field to
2579 still be one byte because the extra address bits are hidden
2580 in the chip address.
2581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002582 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002583 The size in bytes of the EEPROM device.
2584
Heiko Schocher548738b2010-01-07 08:55:40 +01002585 - CONFIG_ENV_EEPROM_IS_ON_I2C
2586 define this, if you have I2C and SPI activated, and your
2587 EEPROM, which holds the environment, is on the I2C bus.
2588
2589 - CONFIG_I2C_ENV_EEPROM_BUS
2590 if you have an Environment on an EEPROM reached over
2591 I2C muxes, you can define here, how to reach this
2592 EEPROM. For example:
2593
Wolfgang Denka9046b92010-06-13 17:48:15 +02002594 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002595
2596 EEPROM which holds the environment, is reached over
2597 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002598
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002599- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002600
wdenkd4ca31c2004-01-02 14:00:00 +00002601 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002602 want to use for the environment.
2603
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002604 - CONFIG_ENV_OFFSET:
2605 - CONFIG_ENV_ADDR:
2606 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002607
2608 These three #defines specify the offset and size of the
2609 environment area within the total memory of your DataFlash placed
2610 at the specified address.
2611
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002612- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002613
2614 Define this if you have a NAND device which you want to use
2615 for the environment.
2616
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002617 - CONFIG_ENV_OFFSET:
2618 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002619
2620 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002621 area within the first NAND device. CONFIG_ENV_OFFSET must be
2622 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002623
Scott Woodfdd813d2010-09-17 14:38:37 -05002624 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002625
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002626 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002627 size used to hold a redundant copy of the environment data, so
2628 that there is a valid backup copy in case there is a power failure
2629 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2630 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002631
Scott Woodfdd813d2010-09-17 14:38:37 -05002632 - CONFIG_ENV_RANGE (optional):
2633
2634 Specifies the length of the region in which the environment
2635 can be written. This should be a multiple of the NAND device's
2636 block size. Specifying a range with more erase blocks than
2637 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2638 the range to be avoided.
2639
2640 - CONFIG_ENV_OFFSET_OOB (optional):
2641
2642 Enables support for dynamically retrieving the offset of the
2643 environment from block zero's out-of-band data. The
2644 "nand env.oob" command can be used to record this offset.
2645 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2646 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002647
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002648- CONFIG_NAND_ENV_DST
2649
2650 Defines address in RAM to which the nand_spl code should copy the
2651 environment. If redundant environment is used, it will be copied to
2652 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2653
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002654- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002655
2656 Defines offset to the initial SPI buffer area in DPRAM. The
2657 area is used at an early stage (ROM part) if the environment
2658 is configured to reside in the SPI EEPROM: We need a 520 byte
2659 scratch DPRAM area. It is used between the two initialization
2660 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2661 to be a good choice since it makes it far enough from the
2662 start of the data area as well as from the stack pointer.
2663
Bruce Adlere881cb52007-11-02 13:15:42 -07002664Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002665has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002666created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002667until then to read environment variables.
2668
wdenk85ec0bc2003-03-31 16:34:49 +00002669The environment is protected by a CRC32 checksum. Before the monitor
2670is relocated into RAM, as a result of a bad CRC you will be working
2671with the compiled-in default environment - *silently*!!! [This is
2672necessary, because the first environment variable we need is the
2673"baudrate" setting for the console - if we have a bad CRC, we don't
2674have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002675
2676Note: once the monitor has been relocated, then it will complain if
2677the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002678use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002680- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002681 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002683 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002684 also needs to be defined.
2685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002686- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002687 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002688
Ron Madridf5675aa2009-02-18 14:30:44 -08002689- CONFIG_NS16550_MIN_FUNCTIONS:
2690 Define this if you desire to only have use of the NS16550_init
2691 and NS16550_putc functions for the serial driver located at
2692 drivers/serial/ns16550.c. This option is useful for saving
2693 space for already greatly restricted images, including but not
2694 limited to NAND_SPL configurations.
2695
wdenkc6097192002-11-03 00:24:07 +00002696Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002697---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002698
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002699- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002700 Cache Line Size of the CPU.
2701
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002702- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002703 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002704
wdenk42d1f032003-10-15 23:53:47 +00002705 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2706 and RPXsuper) to be able to adjust the position of
2707 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002708
wdenk7f6c2cb2002-11-10 22:06:23 +00002709- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002710 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002711
2712 the default drive number (default value 0)
2713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002714 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002715
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002716 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002717 (default value 1)
2718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002719 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002720
wdenk43d96162003-03-06 00:02:04 +00002721 defines the offset of register from address. It
2722 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002723 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2726 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002727 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002729 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002730 fdc_hw_init() is called at the beginning of the FDC
2731 setup. fdc_hw_init() must be provided by the board
2732 source code. It is used to make hardware dependant
2733 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002735- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002736 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002737 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002739- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002740
wdenk7152b1d2003-09-05 23:19:14 +00002741 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002742 initial data and stack; please note that this must be
2743 writable memory that is working WITHOUT special
2744 initialization, i. e. you CANNOT use normal RAM which
2745 will become available only after programming the
2746 memory controller and running certain initialization
2747 sequences.
2748
2749 U-Boot uses the following memory types:
2750 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2751 - MPC824X: data cache
2752 - PPC4xx: data cache
2753
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002754- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002755
2756 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002757 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2758 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002759 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002760 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002761 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2762 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2763 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002764
2765 Note:
2766 On the MPC824X (or other systems that use the data
2767 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002768 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002769 point to an otherwise UNUSED address space between
2770 the top of RAM and the start of the PCI space.
2771
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002772- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002774- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002775
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002776- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002778- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002779
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002780- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002782- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002784- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002785 SDRAM timing
2786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002787- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002788 periodic timer for refresh
2789
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002790- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002791
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002792- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2793 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2794 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2795 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002796 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2797
2798- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002799 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2800 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002801 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002803- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2804 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002805 Machine Mode Register and Memory Periodic Timer
2806 Prescaler definitions (SDRAM timing)
2807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002808- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002809 enable I2C microcode relocation patch (MPC8xx);
2810 define relocation offset in DPRAM [DSP2]
2811
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002812- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002813 enable SMC microcode relocation patch (MPC8xx);
2814 define relocation offset in DPRAM [SMC1]
2815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002816- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002817 enable SPI microcode relocation patch (MPC8xx);
2818 define relocation offset in DPRAM [SCC4]
2819
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002820- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002821 Use OSCM clock mode on MBX8xx board. Be careful,
2822 wrong setting might damage your board. Read
2823 doc/README.MBX before setting this variable!
2824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002825- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002826 Offset of the bootmode word in DPRAM used by post
2827 (Power On Self Tests). This definition overrides
2828 #define'd default value in commproc.h resp.
2829 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002830
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002831- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2832 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2833 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2834 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2835 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2836 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2837 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2838 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002839 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002840
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002841- CONFIG_PCI_DISABLE_PCIE:
2842 Disable PCI-Express on systems where it is supported but not
2843 required.
2844
Kumar Galaa09b9b62010-12-30 12:09:53 -06002845- CONFIG_SYS_SRIO:
2846 Chip has SRIO or not
2847
2848- CONFIG_SRIO1:
2849 Board has SRIO 1 port available
2850
2851- CONFIG_SRIO2:
2852 Board has SRIO 2 port available
2853
2854- CONFIG_SYS_SRIOn_MEM_VIRT:
2855 Virtual Address of SRIO port 'n' memory region
2856
2857- CONFIG_SYS_SRIOn_MEM_PHYS:
2858 Physical Address of SRIO port 'n' memory region
2859
2860- CONFIG_SYS_SRIOn_MEM_SIZE:
2861 Size of SRIO port 'n' memory region
2862
Ben Warrenbb99ad62006-09-07 16:50:54 -04002863- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002864 Get DDR timing information from an I2C EEPROM. Common
2865 with pluggable memory modules such as SODIMMs
2866
Ben Warrenbb99ad62006-09-07 16:50:54 -04002867 SPD_EEPROM_ADDRESS
2868 I2C address of the SPD EEPROM
2869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002870- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002871 If SPD EEPROM is on an I2C bus other than the first
2872 one, specify here. Note that the value must resolve
2873 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002874
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002875- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002876 Only for 83xx systems. If specified, then DDR should
2877 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002878
wdenkc26e4542004-04-18 10:13:26 +00002879- CONFIG_ETHER_ON_FEC[12]
2880 Define to enable FEC[12] on a 8xx series processor.
2881
2882- CONFIG_FEC[12]_PHY
2883 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002884 to the given FEC; i. e.
2885 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002886 means that the PHY with address 4 is connected to FEC1
2887
2888 When set to -1, means to probe for first available.
2889
2890- CONFIG_FEC[12]_PHY_NORXERR
2891 The PHY does not have a RXERR line (RMII only).
2892 (so program the FEC to ignore it).
2893
2894- CONFIG_RMII
2895 Enable RMII mode for all FECs.
2896 Note that this is a global option, we can't
2897 have one FEC in standard MII mode and another in RMII mode.
2898
wdenk5cf91d62004-04-23 20:32:05 +00002899- CONFIG_CRC32_VERIFY
2900 Add a verify option to the crc32 command.
2901 The syntax is:
2902
2903 => crc32 -v <address> <count> <crc32>
2904
2905 Where address/count indicate a memory area
2906 and crc32 is the correct crc32 which the
2907 area should have.
2908
wdenk56523f12004-07-11 17:40:54 +00002909- CONFIG_LOOPW
2910 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002911 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002912
stroese7b466642004-12-16 18:46:55 +00002913- CONFIG_MX_CYCLIC
2914 Add the "mdc" and "mwc" memory commands. These are cyclic
2915 "md/mw" commands.
2916 Examples:
2917
wdenkefe2a4d2004-12-16 21:44:03 +00002918 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002919 This command will print 4 bytes (10,11,12,13) each 500 ms.
2920
wdenkefe2a4d2004-12-16 21:44:03 +00002921 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002922 This command will write 12345678 to address 100 all 10 ms.
2923
wdenkefe2a4d2004-12-16 21:44:03 +00002924 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002925 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002926
wdenk8aa1a2d2005-04-04 12:44:11 +00002927- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002928 [ARM only] If this variable is defined, then certain
2929 low level initializations (like setting up the memory
2930 controller) are omitted and/or U-Boot does not
2931 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002932
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002933 Normally this variable MUST NOT be defined. The only
2934 exception is when U-Boot is loaded (to RAM) by some
2935 other boot loader or by a debugger which performs
2936 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002937
Magnus Liljadf812382009-06-13 20:50:00 +02002938- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02002939 Modifies the behaviour of start.S when compiling a loader
2940 that is executed before the actual U-Boot. E.g. when
2941 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002942
wdenkc6097192002-11-03 00:24:07 +00002943Building the Software:
2944======================
2945
Wolfgang Denk218ca722008-03-26 10:40:12 +01002946Building U-Boot has been tested in several native build environments
2947and in many different cross environments. Of course we cannot support
2948all possibly existing versions of cross development tools in all
2949(potentially obsolete) versions. In case of tool chain problems we
2950recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2951which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002952
Wolfgang Denk218ca722008-03-26 10:40:12 +01002953If you are not using a native environment, it is assumed that you
2954have GNU cross compiling tools available in your path. In this case,
2955you must set the environment variable CROSS_COMPILE in your shell.
2956Note that no changes to the Makefile or any other source files are
2957necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002958
Wolfgang Denk218ca722008-03-26 10:40:12 +01002959 $ CROSS_COMPILE=ppc_4xx-
2960 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002961
Peter Tyser2f8d3962009-03-13 18:54:51 -05002962Note: If you wish to generate Windows versions of the utilities in
2963 the tools directory you can use the MinGW toolchain
2964 (http://www.mingw.org). Set your HOST tools to the MinGW
2965 toolchain and execute 'make tools'. For example:
2966
2967 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2968
2969 Binaries such as tools/mkimage.exe will be created which can
2970 be executed on computers running Windows.
2971
Wolfgang Denk218ca722008-03-26 10:40:12 +01002972U-Boot is intended to be simple to build. After installing the
2973sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002974is done by typing:
2975
2976 make NAME_config
2977
Wolfgang Denk218ca722008-03-26 10:40:12 +01002978where "NAME_config" is the name of one of the existing configu-
2979rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002980
wdenk2729af92004-05-03 20:45:30 +00002981Note: for some board special configuration names may exist; check if
2982 additional information is available from the board vendor; for
2983 instance, the TQM823L systems are available without (standard)
2984 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002985 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002986
wdenk2729af92004-05-03 20:45:30 +00002987 make TQM823L_config
2988 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002989
wdenk2729af92004-05-03 20:45:30 +00002990 make TQM823L_LCD_config
2991 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002992
wdenk2729af92004-05-03 20:45:30 +00002993 etc.
wdenkc6097192002-11-03 00:24:07 +00002994
wdenkc6097192002-11-03 00:24:07 +00002995
wdenk2729af92004-05-03 20:45:30 +00002996Finally, type "make all", and you should get some working U-Boot
2997images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002998
wdenk2729af92004-05-03 20:45:30 +00002999- "u-boot.bin" is a raw binary image
3000- "u-boot" is an image in ELF binary format
3001- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003002
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003003By default the build is performed locally and the objects are saved
3004in the source directory. One of the two methods can be used to change
3005this behavior and build U-Boot to some external directory:
3006
30071. Add O= to the make command line invocations:
3008
3009 make O=/tmp/build distclean
3010 make O=/tmp/build NAME_config
3011 make O=/tmp/build all
3012
30132. Set environment variable BUILD_DIR to point to the desired location:
3014
3015 export BUILD_DIR=/tmp/build
3016 make distclean
3017 make NAME_config
3018 make all
3019
3020Note that the command line "O=" setting overrides the BUILD_DIR environment
3021variable.
3022
wdenkc6097192002-11-03 00:24:07 +00003023
wdenk2729af92004-05-03 20:45:30 +00003024Please be aware that the Makefiles assume you are using GNU make, so
3025for instance on NetBSD you might need to use "gmake" instead of
3026native "make".
wdenkc6097192002-11-03 00:24:07 +00003027
wdenkc6097192002-11-03 00:24:07 +00003028
wdenk2729af92004-05-03 20:45:30 +00003029If the system board that you have is not listed, then you will need
3030to port U-Boot to your hardware platform. To do this, follow these
3031steps:
wdenkc6097192002-11-03 00:24:07 +00003032
wdenk2729af92004-05-03 20:45:30 +000030331. Add a new configuration option for your board to the toplevel
3034 "Makefile" and to the "MAKEALL" script, using the existing
3035 entries as examples. Note that here and at many other places
3036 boards and other names are listed in alphabetical sort order. Please
3037 keep this order.
30382. Create a new directory to hold your board specific code. Add any
3039 files you need. In your board directory, you will need at least
3040 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
30413. Create a new configuration file "include/configs/<board>.h" for
3042 your board
30433. If you're porting U-Boot to a new CPU, then also create a new
3044 directory to hold your CPU specific code. Add any files you need.
30454. Run "make <board>_config" with your new name.
30465. Type "make", and you should get a working "u-boot.srec" file
3047 to be installed on your target system.
30486. Debug and solve any problems that might arise.
3049 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003050
wdenkc6097192002-11-03 00:24:07 +00003051
wdenk2729af92004-05-03 20:45:30 +00003052Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3053==============================================================
wdenkc6097192002-11-03 00:24:07 +00003054
Wolfgang Denk218ca722008-03-26 10:40:12 +01003055If you have modified U-Boot sources (for instance added a new board
3056or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003057provide feedback to the other developers. The feedback normally takes
3058the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003059official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003060
Wolfgang Denk218ca722008-03-26 10:40:12 +01003061But before you submit such a patch, please verify that your modifi-
3062cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003063the supported boards compile WITHOUT ANY compiler warnings. To do so,
3064just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003065for ALL supported system. Be warned, this will take a while. You can
3066select which (cross) compiler to use by passing a `CROSS_COMPILE'
3067environment variable to the script, i. e. to use the ELDK cross tools
3068you can type
wdenkc6097192002-11-03 00:24:07 +00003069
wdenk2729af92004-05-03 20:45:30 +00003070 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003073
wdenk2729af92004-05-03 20:45:30 +00003074 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003075
Wolfgang Denk218ca722008-03-26 10:40:12 +01003076When using the MAKEALL script, the default behaviour is to build
3077U-Boot in the source directory. This location can be changed by
3078setting the BUILD_DIR environment variable. Also, for each target
3079built, the MAKEALL script saves two log files (<target>.ERR and
3080<target>.MAKEALL) in the <source dir>/LOG directory. This default
3081location can be changed by setting the MAKEALL_LOGDIR environment
3082variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003083
3084 export BUILD_DIR=/tmp/build
3085 export MAKEALL_LOGDIR=/tmp/log
3086 CROSS_COMPILE=ppc_8xx- MAKEALL
3087
Wolfgang Denk218ca722008-03-26 10:40:12 +01003088With the above settings build objects are saved in the /tmp/build,
3089log files are saved in the /tmp/log and the source tree remains clean
3090during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003091
3092
wdenk2729af92004-05-03 20:45:30 +00003093See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003094
wdenkc6097192002-11-03 00:24:07 +00003095
wdenk2729af92004-05-03 20:45:30 +00003096Monitor Commands - Overview:
3097============================
wdenkc6097192002-11-03 00:24:07 +00003098
wdenk2729af92004-05-03 20:45:30 +00003099go - start application at address 'addr'
3100run - run commands in an environment variable
3101bootm - boot application image from memory
3102bootp - boot image via network using BootP/TFTP protocol
3103tftpboot- boot image via network using TFTP protocol
3104 and env variables "ipaddr" and "serverip"
3105 (and eventually "gatewayip")
3106rarpboot- boot image via network using RARP/TFTP protocol
3107diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3108loads - load S-Record file over serial line
3109loadb - load binary file over serial line (kermit mode)
3110md - memory display
3111mm - memory modify (auto-incrementing)
3112nm - memory modify (constant address)
3113mw - memory write (fill)
3114cp - memory copy
3115cmp - memory compare
3116crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003117i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003118sspi - SPI utility commands
3119base - print or set address offset
3120printenv- print environment variables
3121setenv - set environment variables
3122saveenv - save environment variables to persistent storage
3123protect - enable or disable FLASH write protection
3124erase - erase FLASH memory
3125flinfo - print FLASH memory information
3126bdinfo - print Board Info structure
3127iminfo - print header information for application image
3128coninfo - print console devices and informations
3129ide - IDE sub-system
3130loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003131loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003132mtest - simple RAM test
3133icache - enable or disable instruction cache
3134dcache - enable or disable data cache
3135reset - Perform RESET of the CPU
3136echo - echo args to console
3137version - print monitor version
3138help - print online help
3139? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003140
wdenkc6097192002-11-03 00:24:07 +00003141
wdenk2729af92004-05-03 20:45:30 +00003142Monitor Commands - Detailed Description:
3143========================================
wdenkc6097192002-11-03 00:24:07 +00003144
wdenk2729af92004-05-03 20:45:30 +00003145TODO.
wdenkc6097192002-11-03 00:24:07 +00003146
wdenk2729af92004-05-03 20:45:30 +00003147For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003148
3149
wdenk2729af92004-05-03 20:45:30 +00003150Environment Variables:
3151======================
wdenkc6097192002-11-03 00:24:07 +00003152
wdenk2729af92004-05-03 20:45:30 +00003153U-Boot supports user configuration using Environment Variables which
3154can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003155
wdenk2729af92004-05-03 20:45:30 +00003156Environment Variables are set using "setenv", printed using
3157"printenv", and saved to Flash using "saveenv". Using "setenv"
3158without a value can be used to delete a variable from the
3159environment. As long as you don't save the environment you are
3160working with an in-memory copy. In case the Flash area containing the
3161environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003162
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003163Some configuration options can be set using Environment Variables.
3164
3165List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003166
wdenk2729af92004-05-03 20:45:30 +00003167 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003168
wdenk2729af92004-05-03 20:45:30 +00003169 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003170
wdenk2729af92004-05-03 20:45:30 +00003171 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003172
wdenk2729af92004-05-03 20:45:30 +00003173 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003174
wdenk2729af92004-05-03 20:45:30 +00003175 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003176
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003177 bootm_low - Memory range available for image processing in the bootm
3178 command can be restricted. This variable is given as
3179 a hexadecimal number and defines lowest address allowed
3180 for use by the bootm command. See also "bootm_size"
3181 environment variable. Address defined by "bootm_low" is
3182 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003183 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003184
3185 bootm_size - Memory range available for image processing in the bootm
3186 command can be restricted. This variable is given as
3187 a hexadecimal number and defines the size of the region
3188 allowed for use by the bootm command. See also "bootm_low"
3189 environment variable.
3190
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003191 updatefile - Location of the software update file on a TFTP server, used
3192 by the automatic software update feature. Please refer to
3193 documentation in doc/README.update for more details.
3194
wdenk2729af92004-05-03 20:45:30 +00003195 autoload - if set to "no" (any string beginning with 'n'),
3196 "bootp" will just load perform a lookup of the
3197 configuration from the BOOTP server, but not try to
3198 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk2729af92004-05-03 20:45:30 +00003200 autostart - if set to "yes", an image loaded using the "bootp",
3201 "rarpboot", "tftpboot" or "diskboot" commands will
3202 be automatically started (by internally calling
3203 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003204
wdenk2729af92004-05-03 20:45:30 +00003205 If set to "no", a standalone image passed to the
3206 "bootm" command will be copied to the load address
3207 (and eventually uncompressed), but NOT be started.
3208 This can be used to load and uncompress arbitrary
3209 data.
wdenkc6097192002-11-03 00:24:07 +00003210
wdenk17ea1172004-06-06 21:51:03 +00003211 i2cfast - (PPC405GP|PPC405EP only)
3212 if set to 'y' configures Linux I2C driver for fast
3213 mode (400kHZ). This environment variable is used in
3214 initialization code. So, for changes to be effective
3215 it must be saved and board must be reset.
3216
wdenk2729af92004-05-03 20:45:30 +00003217 initrd_high - restrict positioning of initrd images:
3218 If this variable is not set, initrd images will be
3219 copied to the highest possible address in RAM; this
3220 is usually what you want since it allows for
3221 maximum initrd size. If for some reason you want to
3222 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003223 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003224 variable to a value of "no" or "off" or "0".
3225 Alternatively, you can set it to a maximum upper
3226 address to use (U-Boot will still check that it
3227 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk2729af92004-05-03 20:45:30 +00003229 For instance, when you have a system with 16 MB
3230 RAM, and want to reserve 4 MB from use by Linux,
3231 you can do this by adding "mem=12M" to the value of
3232 the "bootargs" variable. However, now you must make
3233 sure that the initrd image is placed in the first
3234 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk2729af92004-05-03 20:45:30 +00003236 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk2729af92004-05-03 20:45:30 +00003238 If you set initrd_high to 0xFFFFFFFF, this is an
3239 indication to U-Boot that all addresses are legal
3240 for the Linux kernel, including addresses in flash
3241 memory. In this case U-Boot will NOT COPY the
3242 ramdisk at all. This may be useful to reduce the
3243 boot time on your system, but requires that this
3244 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003245
wdenk2729af92004-05-03 20:45:30 +00003246 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003247
wdenk2729af92004-05-03 20:45:30 +00003248 loadaddr - Default load address for commands like "bootp",
3249 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003250
wdenk2729af92004-05-03 20:45:30 +00003251 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003252
wdenk2729af92004-05-03 20:45:30 +00003253 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003254
wdenk2729af92004-05-03 20:45:30 +00003255 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003256
wdenk2729af92004-05-03 20:45:30 +00003257 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003258
wdenk2729af92004-05-03 20:45:30 +00003259 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003260
wdenk2729af92004-05-03 20:45:30 +00003261 ethprime - When CONFIG_NET_MULTI is enabled controls which
3262 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003263
wdenk2729af92004-05-03 20:45:30 +00003264 ethact - When CONFIG_NET_MULTI is enabled controls which
3265 interface is currently active. For example you
3266 can do the following
wdenkc6097192002-11-03 00:24:07 +00003267
Heiko Schocher48690d82010-07-20 17:45:02 +02003268 => setenv ethact FEC
3269 => ping 192.168.0.1 # traffic sent on FEC
3270 => setenv ethact SCC
3271 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003272
Matthias Fuchse1692572008-01-17 07:45:05 +01003273 ethrotate - When set to "no" U-Boot does not go through all
3274 available network interfaces.
3275 It just stays at the currently selected interface.
3276
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003277 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003278 either succeed or fail without retrying.
3279 When set to "once" the network operation will
3280 fail when all the available network interfaces
3281 are tried once without success.
3282 Useful on scripts which control the retry operation
3283 themselves.
wdenkc6097192002-11-03 00:24:07 +00003284
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003285 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003286
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003287 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003288 UDP source port.
3289
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003290 tftpdstport - If this is set, the value is used for TFTP's UDP
3291 destination port instead of the Well Know Port 69.
3292
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003293 tftpblocksize - Block size to use for TFTP transfers; if not set,
3294 we use the TFTP server's default block size
3295
3296 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3297 seconds, minimum value is 1000 = 1 second). Defines
3298 when a packet is considered to be lost so it has to
3299 be retransmitted. The default is 5000 = 5 seconds.
3300 Lowering this value may make downloads succeed
3301 faster in networks with high packet loss rates or
3302 with unreliable TFTP servers.
3303
3304 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003305 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003306 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003307
wdenk2729af92004-05-03 20:45:30 +00003308The following environment variables may be used and automatically
3309updated by the network boot commands ("bootp" and "rarpboot"),
3310depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003311
wdenk2729af92004-05-03 20:45:30 +00003312 bootfile - see above
3313 dnsip - IP address of your Domain Name Server
3314 dnsip2 - IP address of your secondary Domain Name Server
3315 gatewayip - IP address of the Gateway (Router) to use
3316 hostname - Target hostname
3317 ipaddr - see above
3318 netmask - Subnet Mask
3319 rootpath - Pathname of the root filesystem on the NFS server
3320 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003321
wdenka3d991b2004-04-15 21:48:45 +00003322
wdenk2729af92004-05-03 20:45:30 +00003323There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003324
wdenk2729af92004-05-03 20:45:30 +00003325 serial# - contains hardware identification information such
3326 as type string and/or serial number
3327 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329These variables can be set only once (usually during manufacturing of
3330the board). U-Boot refuses to delete or overwrite these variables
3331once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003332
3333
wdenk2729af92004-05-03 20:45:30 +00003334Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003335
wdenk2729af92004-05-03 20:45:30 +00003336 ver - Contains the U-Boot version string as printed
3337 with the "version" command. This variable is
3338 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003339
wdenkc6097192002-11-03 00:24:07 +00003340
wdenk2729af92004-05-03 20:45:30 +00003341Please note that changes to some configuration parameters may take
3342only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003343
stroesec1551ea2003-04-04 15:53:41 +00003344
wdenk2729af92004-05-03 20:45:30 +00003345Command Line Parsing:
3346=====================
stroesec1551ea2003-04-04 15:53:41 +00003347
wdenk2729af92004-05-03 20:45:30 +00003348There are two different command line parsers available with U-Boot:
3349the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003350
wdenk2729af92004-05-03 20:45:30 +00003351Old, simple command line parser:
3352--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003353
wdenk2729af92004-05-03 20:45:30 +00003354- supports environment variables (through setenv / saveenv commands)
3355- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003356- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003357- special characters ('$', ';') can be escaped by prefixing with '\',
3358 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003359 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003360- You can also escape text by enclosing in single apostrophes, for example:
3361 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003362
wdenk2729af92004-05-03 20:45:30 +00003363Hush shell:
3364-----------
wdenkf07771c2003-05-28 08:06:31 +00003365
wdenk2729af92004-05-03 20:45:30 +00003366- similar to Bourne shell, with control structures like
3367 if...then...else...fi, for...do...done; while...do...done,
3368 until...do...done, ...
3369- supports environment ("global") variables (through setenv / saveenv
3370 commands) and local shell variables (through standard shell syntax
3371 "name=value"); only environment variables can be used with "run"
3372 command
wdenkf07771c2003-05-28 08:06:31 +00003373
wdenk2729af92004-05-03 20:45:30 +00003374General rules:
3375--------------
wdenkf07771c2003-05-28 08:06:31 +00003376
wdenk2729af92004-05-03 20:45:30 +00003377(1) If a command line (or an environment variable executed by a "run"
3378 command) contains several commands separated by semicolon, and
3379 one of these commands fails, then the remaining commands will be
3380 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003381
wdenk2729af92004-05-03 20:45:30 +00003382(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003383 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003384 command will cause "run" to terminate, i. e. the remaining
3385 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003386
wdenk2729af92004-05-03 20:45:30 +00003387Note for Redundant Ethernet Interfaces:
3388=======================================
wdenkf07771c2003-05-28 08:06:31 +00003389
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003390Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003391such configurations and is capable of automatic selection of a
3392"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003393
wdenk2729af92004-05-03 20:45:30 +00003394Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3395MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3396"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003397
wdenk2729af92004-05-03 20:45:30 +00003398If the network interface stores some valid MAC address (for instance
3399in SROM), this is used as default address if there is NO correspon-
3400ding setting in the environment; if the corresponding environment
3401variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403o If the SROM has a valid MAC address, and there is no address in the
3404 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406o If there is no valid address in the SROM, and a definition in the
3407 environment exists, then the value from the environment variable is
3408 used.
wdenkc6097192002-11-03 00:24:07 +00003409
wdenk2729af92004-05-03 20:45:30 +00003410o If both the SROM and the environment contain a MAC address, and
3411 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003412
wdenk2729af92004-05-03 20:45:30 +00003413o If both the SROM and the environment contain a MAC address, and the
3414 addresses differ, the value from the environment is used and a
3415 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003416
wdenk2729af92004-05-03 20:45:30 +00003417o If neither SROM nor the environment contain a MAC address, an error
3418 is raised.
wdenkc6097192002-11-03 00:24:07 +00003419
Ben Warrenecee9322010-04-26 11:11:46 -07003420If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3421will be programmed into hardware as part of the initialization process. This
3422may be skipped by setting the appropriate 'ethmacskip' environment variable.
3423The naming convention is as follows:
3424"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003425
wdenk2729af92004-05-03 20:45:30 +00003426Image Formats:
3427==============
wdenkc6097192002-11-03 00:24:07 +00003428
Marian Balakowicz3310c542008-03-12 12:13:13 +01003429U-Boot is capable of booting (and performing other auxiliary operations on)
3430images in two formats:
3431
3432New uImage format (FIT)
3433-----------------------
3434
3435Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3436to Flattened Device Tree). It allows the use of images with multiple
3437components (several kernels, ramdisks, etc.), with contents protected by
3438SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3439
3440
3441Old uImage format
3442-----------------
3443
3444Old image format is based on binary files which can be basically anything,
3445preceded by a special header; see the definitions in include/image.h for
3446details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003447
wdenk2729af92004-05-03 20:45:30 +00003448* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3449 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003450 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3451 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3452 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003453* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003454 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3455 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003456* Compression Type (uncompressed, gzip, bzip2)
3457* Load Address
3458* Entry Point
3459* Image Name
3460* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003461
wdenk2729af92004-05-03 20:45:30 +00003462The header is marked by a special Magic Number, and both the header
3463and the data portions of the image are secured against corruption by
3464CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003465
wdenkc6097192002-11-03 00:24:07 +00003466
wdenk2729af92004-05-03 20:45:30 +00003467Linux Support:
3468==============
wdenkc6097192002-11-03 00:24:07 +00003469
wdenk2729af92004-05-03 20:45:30 +00003470Although U-Boot should support any OS or standalone application
3471easily, the main focus has always been on Linux during the design of
3472U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003473
wdenk2729af92004-05-03 20:45:30 +00003474U-Boot includes many features that so far have been part of some
3475special "boot loader" code within the Linux kernel. Also, any
3476"initrd" images to be used are no longer part of one big Linux image;
3477instead, kernel and "initrd" are separate images. This implementation
3478serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk2729af92004-05-03 20:45:30 +00003480- the same features can be used for other OS or standalone
3481 applications (for instance: using compressed images to reduce the
3482 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484- it becomes much easier to port new Linux kernel versions because
3485 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003486
wdenk2729af92004-05-03 20:45:30 +00003487- the same Linux kernel image can now be used with different "initrd"
3488 images; of course this also means that different kernel images can
3489 be run with the same "initrd". This makes testing easier (you don't
3490 have to build a new "zImage.initrd" Linux image when you just
3491 change a file in your "initrd"). Also, a field-upgrade of the
3492 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003493
wdenkc6097192002-11-03 00:24:07 +00003494
wdenk2729af92004-05-03 20:45:30 +00003495Linux HOWTO:
3496============
wdenkc6097192002-11-03 00:24:07 +00003497
wdenk2729af92004-05-03 20:45:30 +00003498Porting Linux to U-Boot based systems:
3499---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003500
wdenk2729af92004-05-03 20:45:30 +00003501U-Boot cannot save you from doing all the necessary modifications to
3502configure the Linux device drivers for use with your target hardware
3503(no, we don't intend to provide a full virtual machine interface to
3504Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003505
Stefan Roesea47a12b2010-04-15 16:07:28 +02003506But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk2729af92004-05-03 20:45:30 +00003508Just make sure your machine specific header file (for instance
3509include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003510Information structure as we define in include/asm-<arch>/u-boot.h,
3511and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003512as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003513
wdenkc6097192002-11-03 00:24:07 +00003514
wdenk2729af92004-05-03 20:45:30 +00003515Configuring the Linux kernel:
3516-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003517
wdenk2729af92004-05-03 20:45:30 +00003518No specific requirements for U-Boot. Make sure you have some root
3519device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003520
wdenkc6097192002-11-03 00:24:07 +00003521
wdenk2729af92004-05-03 20:45:30 +00003522Building a Linux Image:
3523-----------------------
wdenkc6097192002-11-03 00:24:07 +00003524
wdenk2729af92004-05-03 20:45:30 +00003525With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3526not used. If you use recent kernel source, a new build target
3527"uImage" will exist which automatically builds an image usable by
3528U-Boot. Most older kernels also have support for a "pImage" target,
3529which was introduced for our predecessor project PPCBoot and uses a
3530100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003531
wdenk2729af92004-05-03 20:45:30 +00003532Example:
wdenkc6097192002-11-03 00:24:07 +00003533
wdenk2729af92004-05-03 20:45:30 +00003534 make TQM850L_config
3535 make oldconfig
3536 make dep
3537 make uImage
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk2729af92004-05-03 20:45:30 +00003539The "uImage" build target uses a special tool (in 'tools/mkimage') to
3540encapsulate a compressed Linux kernel image with header information,
3541CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003544
wdenk2729af92004-05-03 20:45:30 +00003545* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003546
wdenk2729af92004-05-03 20:45:30 +00003547 ${CROSS_COMPILE}-objcopy -O binary \
3548 -R .note -R .comment \
3549 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003550
wdenk2729af92004-05-03 20:45:30 +00003551* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk2729af92004-05-03 20:45:30 +00003553 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003554
wdenk2729af92004-05-03 20:45:30 +00003555* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003556
wdenk2729af92004-05-03 20:45:30 +00003557 mkimage -A ppc -O linux -T kernel -C gzip \
3558 -a 0 -e 0 -n "Linux Kernel Image" \
3559 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003560
wdenk24ee89b2002-11-03 17:56:27 +00003561
wdenk2729af92004-05-03 20:45:30 +00003562The "mkimage" tool can also be used to create ramdisk images for use
3563with U-Boot, either separated from the Linux kernel image, or
3564combined into one file. "mkimage" encapsulates the images with a 64
3565byte header containing information about target architecture,
3566operating system, image type, compression method, entry points, time
3567stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003568
wdenk2729af92004-05-03 20:45:30 +00003569"mkimage" can be called in two ways: to verify existing images and
3570print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003571
wdenk2729af92004-05-03 20:45:30 +00003572In the first form (with "-l" option) mkimage lists the information
3573contained in the header of an existing U-Boot image; this includes
3574checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003575
wdenk2729af92004-05-03 20:45:30 +00003576 tools/mkimage -l image
3577 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003578
wdenk2729af92004-05-03 20:45:30 +00003579The second form (with "-d" option) is used to build a U-Boot image
3580from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003581
wdenk2729af92004-05-03 20:45:30 +00003582 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3583 -n name -d data_file image
3584 -A ==> set architecture to 'arch'
3585 -O ==> set operating system to 'os'
3586 -T ==> set image type to 'type'
3587 -C ==> set compression type 'comp'
3588 -a ==> set load address to 'addr' (hex)
3589 -e ==> set entry point to 'ep' (hex)
3590 -n ==> set image name to 'name'
3591 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003592
wdenk69459792004-05-29 16:53:29 +00003593Right now, all Linux kernels for PowerPC systems use the same load
3594address (0x00000000), but the entry point address depends on the
3595kernel version:
wdenkc6097192002-11-03 00:24:07 +00003596
wdenk2729af92004-05-03 20:45:30 +00003597- 2.2.x kernels have the entry point at 0x0000000C,
3598- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003599
wdenk2729af92004-05-03 20:45:30 +00003600So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003601
wdenk2729af92004-05-03 20:45:30 +00003602 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3603 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003604 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003605 > examples/uImage.TQM850L
3606 Image Name: 2.4.4 kernel for TQM850L
3607 Created: Wed Jul 19 02:34:59 2000
3608 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3609 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3610 Load Address: 0x00000000
3611 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003612
wdenk2729af92004-05-03 20:45:30 +00003613To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003614
wdenk2729af92004-05-03 20:45:30 +00003615 -> tools/mkimage -l examples/uImage.TQM850L
3616 Image Name: 2.4.4 kernel for TQM850L
3617 Created: Wed Jul 19 02:34:59 2000
3618 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3619 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3620 Load Address: 0x00000000
3621 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003622
wdenk2729af92004-05-03 20:45:30 +00003623NOTE: for embedded systems where boot time is critical you can trade
3624speed for memory and install an UNCOMPRESSED image instead: this
3625needs more space in Flash, but boots much faster since it does not
3626need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003627
Stefan Roesea47a12b2010-04-15 16:07:28 +02003628 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003629 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3630 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003631 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003632 > examples/uImage.TQM850L-uncompressed
3633 Image Name: 2.4.4 kernel for TQM850L
3634 Created: Wed Jul 19 02:34:59 2000
3635 Image Type: PowerPC Linux Kernel Image (uncompressed)
3636 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3637 Load Address: 0x00000000
3638 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003639
wdenkc6097192002-11-03 00:24:07 +00003640
wdenk2729af92004-05-03 20:45:30 +00003641Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3642when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003643
wdenk2729af92004-05-03 20:45:30 +00003644 -> tools/mkimage -n 'Simple Ramdisk Image' \
3645 > -A ppc -O linux -T ramdisk -C gzip \
3646 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3647 Image Name: Simple Ramdisk Image
3648 Created: Wed Jan 12 14:01:50 2000
3649 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3650 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3651 Load Address: 0x00000000
3652 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003653
wdenkdb01a2e2004-04-15 23:14:49 +00003654
wdenk2729af92004-05-03 20:45:30 +00003655Installing a Linux Image:
3656-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003657
wdenk2729af92004-05-03 20:45:30 +00003658To downloading a U-Boot image over the serial (console) interface,
3659you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003660
wdenk2729af92004-05-03 20:45:30 +00003661 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003662
wdenk2729af92004-05-03 20:45:30 +00003663The 'objcopy' does not understand the information in the U-Boot
3664image header, so the resulting S-Record file will be relative to
3665address 0x00000000. To load it to a given address, you need to
3666specify the target address as 'offset' parameter with the 'loads'
3667command.
wdenkc6097192002-11-03 00:24:07 +00003668
wdenk2729af92004-05-03 20:45:30 +00003669Example: install the image to address 0x40100000 (which on the
3670TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003671
wdenk2729af92004-05-03 20:45:30 +00003672 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003673
wdenk2729af92004-05-03 20:45:30 +00003674 .......... done
3675 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003676
wdenk2729af92004-05-03 20:45:30 +00003677 => loads 40100000
3678 ## Ready for S-Record download ...
3679 ~>examples/image.srec
3680 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3681 ...
3682 15989 15990 15991 15992
3683 [file transfer complete]
3684 [connected]
3685 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003686
3687
wdenk2729af92004-05-03 20:45:30 +00003688You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003689this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003690corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003691
wdenk2729af92004-05-03 20:45:30 +00003692 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003693
wdenk2729af92004-05-03 20:45:30 +00003694 ## Checking Image at 40100000 ...
3695 Image Name: 2.2.13 for initrd on TQM850L
3696 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3697 Data Size: 335725 Bytes = 327 kB = 0 MB
3698 Load Address: 00000000
3699 Entry Point: 0000000c
3700 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003701
3702
wdenk2729af92004-05-03 20:45:30 +00003703Boot Linux:
3704-----------
wdenkc6097192002-11-03 00:24:07 +00003705
wdenk2729af92004-05-03 20:45:30 +00003706The "bootm" command is used to boot an application that is stored in
3707memory (RAM or Flash). In case of a Linux kernel image, the contents
3708of the "bootargs" environment variable is passed to the kernel as
3709parameters. You can check and modify this variable using the
3710"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003711
3712
wdenk2729af92004-05-03 20:45:30 +00003713 => printenv bootargs
3714 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003715
wdenk2729af92004-05-03 20:45:30 +00003716 => 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 +00003717
wdenk2729af92004-05-03 20:45:30 +00003718 => printenv bootargs
3719 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 +00003720
wdenk2729af92004-05-03 20:45:30 +00003721 => bootm 40020000
3722 ## Booting Linux kernel at 40020000 ...
3723 Image Name: 2.2.13 for NFS on TQM850L
3724 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3725 Data Size: 381681 Bytes = 372 kB = 0 MB
3726 Load Address: 00000000
3727 Entry Point: 0000000c
3728 Verifying Checksum ... OK
3729 Uncompressing Kernel Image ... OK
3730 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
3731 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3732 time_init: decrementer frequency = 187500000/60
3733 Calibrating delay loop... 49.77 BogoMIPS
3734 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3735 ...
wdenkc6097192002-11-03 00:24:07 +00003736
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003737If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003738the memory addresses of both the kernel and the initrd image (PPBCOOT
3739format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003740
wdenk2729af92004-05-03 20:45:30 +00003741 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003742
wdenk2729af92004-05-03 20:45:30 +00003743 ## Checking Image at 40100000 ...
3744 Image Name: 2.2.13 for initrd on TQM850L
3745 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3746 Data Size: 335725 Bytes = 327 kB = 0 MB
3747 Load Address: 00000000
3748 Entry Point: 0000000c
3749 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003750
wdenk2729af92004-05-03 20:45:30 +00003751 ## Checking Image at 40200000 ...
3752 Image Name: Simple Ramdisk Image
3753 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3754 Data Size: 566530 Bytes = 553 kB = 0 MB
3755 Load Address: 00000000
3756 Entry Point: 00000000
3757 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759 => bootm 40100000 40200000
3760 ## Booting Linux kernel at 40100000 ...
3761 Image Name: 2.2.13 for initrd on TQM850L
3762 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3763 Data Size: 335725 Bytes = 327 kB = 0 MB
3764 Load Address: 00000000
3765 Entry Point: 0000000c
3766 Verifying Checksum ... OK
3767 Uncompressing Kernel Image ... OK
3768 ## Loading RAMDisk Image at 40200000 ...
3769 Image Name: Simple Ramdisk Image
3770 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3771 Data Size: 566530 Bytes = 553 kB = 0 MB
3772 Load Address: 00000000
3773 Entry Point: 00000000
3774 Verifying Checksum ... OK
3775 Loading Ramdisk ... OK
3776 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
3777 Boot arguments: root=/dev/ram
3778 time_init: decrementer frequency = 187500000/60
3779 Calibrating delay loop... 49.77 BogoMIPS
3780 ...
3781 RAMDISK: Compressed image found at block 0
3782 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003783
wdenk2729af92004-05-03 20:45:30 +00003784 bash#
wdenkc6097192002-11-03 00:24:07 +00003785
Matthew McClintock02677682006-06-28 10:41:37 -05003786Boot Linux and pass a flat device tree:
3787-----------
3788
3789First, U-Boot must be compiled with the appropriate defines. See the section
3790titled "Linux Kernel Interface" above for a more in depth explanation. The
3791following is an example of how to start a kernel and pass an updated
3792flat device tree:
3793
3794=> print oftaddr
3795oftaddr=0x300000
3796=> print oft
3797oft=oftrees/mpc8540ads.dtb
3798=> tftp $oftaddr $oft
3799Speed: 1000, full duplex
3800Using TSEC0 device
3801TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3802Filename 'oftrees/mpc8540ads.dtb'.
3803Load address: 0x300000
3804Loading: #
3805done
3806Bytes transferred = 4106 (100a hex)
3807=> tftp $loadaddr $bootfile
3808Speed: 1000, full duplex
3809Using TSEC0 device
3810TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3811Filename 'uImage'.
3812Load address: 0x200000
3813Loading:############
3814done
3815Bytes transferred = 1029407 (fb51f hex)
3816=> print loadaddr
3817loadaddr=200000
3818=> print oftaddr
3819oftaddr=0x300000
3820=> bootm $loadaddr - $oftaddr
3821## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003822 Image Name: Linux-2.6.17-dirty
3823 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3824 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003825 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003826 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003827 Verifying Checksum ... OK
3828 Uncompressing Kernel Image ... OK
3829Booting using flat device tree at 0x300000
3830Using MPC85xx ADS machine description
3831Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3832[snip]
3833
3834
wdenk2729af92004-05-03 20:45:30 +00003835More About U-Boot Image Types:
3836------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003837
wdenk2729af92004-05-03 20:45:30 +00003838U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840 "Standalone Programs" are directly runnable in the environment
3841 provided by U-Boot; it is expected that (if they behave
3842 well) you can continue to work in U-Boot after return from
3843 the Standalone Program.
3844 "OS Kernel Images" are usually images of some Embedded OS which
3845 will take over control completely. Usually these programs
3846 will install their own set of exception handlers, device
3847 drivers, set up the MMU, etc. - this means, that you cannot
3848 expect to re-enter U-Boot except by resetting the CPU.
3849 "RAMDisk Images" are more or less just data blocks, and their
3850 parameters (address, size) are passed to an OS kernel that is
3851 being started.
3852 "Multi-File Images" contain several images, typically an OS
3853 (Linux) kernel image and one or more data images like
3854 RAMDisks. This construct is useful for instance when you want
3855 to boot over the network using BOOTP etc., where the boot
3856 server provides just a single image file, but you want to get
3857 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003858
wdenk2729af92004-05-03 20:45:30 +00003859 "Multi-File Images" start with a list of image sizes, each
3860 image size (in bytes) specified by an "uint32_t" in network
3861 byte order. This list is terminated by an "(uint32_t)0".
3862 Immediately after the terminating 0 follow the images, one by
3863 one, all aligned on "uint32_t" boundaries (size rounded up to
3864 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003865
wdenk2729af92004-05-03 20:45:30 +00003866 "Firmware Images" are binary images containing firmware (like
3867 U-Boot or FPGA images) which usually will be programmed to
3868 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003869
wdenk2729af92004-05-03 20:45:30 +00003870 "Script files" are command sequences that will be executed by
3871 U-Boot's command interpreter; this feature is especially
3872 useful when you configure U-Boot to use a real shell (hush)
3873 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003874
wdenkc6097192002-11-03 00:24:07 +00003875
wdenk2729af92004-05-03 20:45:30 +00003876Standalone HOWTO:
3877=================
wdenkc6097192002-11-03 00:24:07 +00003878
wdenk2729af92004-05-03 20:45:30 +00003879One of the features of U-Boot is that you can dynamically load and
3880run "standalone" applications, which can use some resources of
3881U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003882
wdenk2729af92004-05-03 20:45:30 +00003883Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003884
wdenk2729af92004-05-03 20:45:30 +00003885"Hello World" Demo:
3886-------------------
wdenkc6097192002-11-03 00:24:07 +00003887
wdenk2729af92004-05-03 20:45:30 +00003888'examples/hello_world.c' contains a small "Hello World" Demo
3889application; it is automatically compiled when you build U-Boot.
3890It's configured to run at address 0x00040004, so you can play with it
3891like that:
wdenkc6097192002-11-03 00:24:07 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893 => loads
3894 ## Ready for S-Record download ...
3895 ~>examples/hello_world.srec
3896 1 2 3 4 5 6 7 8 9 10 11 ...
3897 [file transfer complete]
3898 [connected]
3899 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003900
wdenk2729af92004-05-03 20:45:30 +00003901 => go 40004 Hello World! This is a test.
3902 ## Starting application at 0x00040004 ...
3903 Hello World
3904 argc = 7
3905 argv[0] = "40004"
3906 argv[1] = "Hello"
3907 argv[2] = "World!"
3908 argv[3] = "This"
3909 argv[4] = "is"
3910 argv[5] = "a"
3911 argv[6] = "test."
3912 argv[7] = "<NULL>"
3913 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003914
wdenk2729af92004-05-03 20:45:30 +00003915 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003916
wdenk2729af92004-05-03 20:45:30 +00003917Another example, which demonstrates how to register a CPM interrupt
3918handler with the U-Boot code, can be found in 'examples/timer.c'.
3919Here, a CPM timer is set up to generate an interrupt every second.
3920The interrupt service routine is trivial, just printing a '.'
3921character, but this is just a demo program. The application can be
3922controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003923
wdenk2729af92004-05-03 20:45:30 +00003924 ? - print current values og the CPM Timer registers
3925 b - enable interrupts and start timer
3926 e - stop timer and disable interrupts
3927 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003928
wdenk2729af92004-05-03 20:45:30 +00003929 => loads
3930 ## Ready for S-Record download ...
3931 ~>examples/timer.srec
3932 1 2 3 4 5 6 7 8 9 10 11 ...
3933 [file transfer complete]
3934 [connected]
3935 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937 => go 40004
3938 ## Starting application at 0x00040004 ...
3939 TIMERS=0xfff00980
3940 Using timer 1
3941 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003942
wdenk2729af92004-05-03 20:45:30 +00003943Hit 'b':
3944 [q, b, e, ?] Set interval 1000000 us
3945 Enabling timer
3946Hit '?':
3947 [q, b, e, ?] ........
3948 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3949Hit '?':
3950 [q, b, e, ?] .
3951 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3952Hit '?':
3953 [q, b, e, ?] .
3954 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3955Hit '?':
3956 [q, b, e, ?] .
3957 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3958Hit 'e':
3959 [q, b, e, ?] ...Stopping timer
3960Hit 'q':
3961 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003962
3963
wdenk2729af92004-05-03 20:45:30 +00003964Minicom warning:
3965================
wdenk85ec0bc2003-03-31 16:34:49 +00003966
wdenk2729af92004-05-03 20:45:30 +00003967Over time, many people have reported problems when trying to use the
3968"minicom" terminal emulation program for serial download. I (wd)
3969consider minicom to be broken, and recommend not to use it. Under
3970Unix, I recommend to use C-Kermit for general purpose use (and
3971especially for kermit binary protocol download ("loadb" command), and
3972use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003973
wdenk2729af92004-05-03 20:45:30 +00003974Nevertheless, if you absolutely want to use it try adding this
3975configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003976
wdenk2729af92004-05-03 20:45:30 +00003977 Name Program Name U/D FullScr IO-Red. Multi
3978 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3979 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003980
3981
wdenk2729af92004-05-03 20:45:30 +00003982NetBSD Notes:
3983=============
wdenkc6097192002-11-03 00:24:07 +00003984
wdenk2729af92004-05-03 20:45:30 +00003985Starting at version 0.9.2, U-Boot supports NetBSD both as host
3986(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003987
wdenk2729af92004-05-03 20:45:30 +00003988Building requires a cross environment; it is known to work on
3989NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3990need gmake since the Makefiles are not compatible with BSD make).
3991Note that the cross-powerpc package does not install include files;
3992attempting to build U-Boot will fail because <machine/ansi.h> is
3993missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003994
wdenk2729af92004-05-03 20:45:30 +00003995 # cd /usr/pkg/cross/powerpc-netbsd/include
3996 # mkdir powerpc
3997 # ln -s powerpc machine
3998 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3999 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004000
wdenk2729af92004-05-03 20:45:30 +00004001Native builds *don't* work due to incompatibilities between native
4002and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004003
wdenk2729af92004-05-03 20:45:30 +00004004Booting assumes that (the first part of) the image booted is a
4005stage-2 loader which in turn loads and then invokes the kernel
4006proper. Loader sources will eventually appear in the NetBSD source
4007tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004008meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004009
4010
wdenk2729af92004-05-03 20:45:30 +00004011Implementation Internals:
4012=========================
wdenkc6097192002-11-03 00:24:07 +00004013
wdenk2729af92004-05-03 20:45:30 +00004014The following is not intended to be a complete description of every
4015implementation detail. However, it should help to understand the
4016inner workings of U-Boot and make it easier to port it to custom
4017hardware.
wdenkc6097192002-11-03 00:24:07 +00004018
4019
wdenk2729af92004-05-03 20:45:30 +00004020Initial Stack, Global Data:
4021---------------------------
wdenkc6097192002-11-03 00:24:07 +00004022
wdenk2729af92004-05-03 20:45:30 +00004023The implementation of U-Boot is complicated by the fact that U-Boot
4024starts running out of ROM (flash memory), usually without access to
4025system RAM (because the memory controller is not initialized yet).
4026This means that we don't have writable Data or BSS segments, and BSS
4027is not initialized as zero. To be able to get a C environment working
4028at all, we have to allocate at least a minimal stack. Implementation
4029options for this are defined and restricted by the CPU used: Some CPU
4030models provide on-chip memory (like the IMMR area on MPC8xx and
4031MPC826x processors), on others (parts of) the data cache can be
4032locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004033
Wolfgang Denk218ca722008-03-26 10:40:12 +01004034 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004035 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004036
wdenk2729af92004-05-03 20:45:30 +00004037 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4038 From: "Chris Hallinan" <clh@net1plus.com>
4039 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4040 ...
wdenk43d96162003-03-06 00:02:04 +00004041
wdenk2729af92004-05-03 20:45:30 +00004042 Correct me if I'm wrong, folks, but the way I understand it
4043 is this: Using DCACHE as initial RAM for Stack, etc, does not
4044 require any physical RAM backing up the cache. The cleverness
4045 is that the cache is being used as a temporary supply of
4046 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004047 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004048 can see how this works by studying the cache architecture and
4049 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004050
wdenk2729af92004-05-03 20:45:30 +00004051 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4052 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004053 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004054 option should work for you. Using CS 4 should be fine if your
4055 board designers haven't used it for something that would
4056 cause you grief during the initial boot! It is frequently not
4057 used.
wdenk43d96162003-03-06 00:02:04 +00004058
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004059 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004060 with your processor/board/system design. The default value
4061 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004062 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004063 than your SDRAM module. If you have a 64MB SDRAM module, set
4064 it above 400_0000. Just make sure your board has no resources
4065 that are supposed to respond to that address! That code in
4066 start.S has been around a while and should work as is when
4067 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004068
wdenk2729af92004-05-03 20:45:30 +00004069 -Chris Hallinan
4070 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004071
wdenk2729af92004-05-03 20:45:30 +00004072It is essential to remember this, since it has some impact on the C
4073code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004074
wdenk2729af92004-05-03 20:45:30 +00004075* Initialized global data (data segment) is read-only. Do not attempt
4076 to write it.
wdenkc6097192002-11-03 00:24:07 +00004077
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004078* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004079 as zero data - BSS segment) at all - this is undefined, initiali-
4080 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004081
wdenk2729af92004-05-03 20:45:30 +00004082* Stack space is very limited. Avoid big data buffers or things like
4083 that.
wdenkc6097192002-11-03 00:24:07 +00004084
wdenk2729af92004-05-03 20:45:30 +00004085Having only the stack as writable memory limits means we cannot use
4086normal global data to share information beween the code. But it
4087turned out that the implementation of U-Boot can be greatly
4088simplified by making a global data structure (gd_t) available to all
4089functions. We could pass a pointer to this data as argument to _all_
4090functions, but this would bloat the code. Instead we use a feature of
4091the GCC compiler (Global Register Variables) to share the data: we
4092place a pointer (gd) to the global data into a register which we
4093reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095When choosing a register for such a purpose we are restricted by the
4096relevant (E)ABI specifications for the current architecture, and by
4097GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004098
wdenk2729af92004-05-03 20:45:30 +00004099For PowerPC, the following registers have specific use:
4100 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004101 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004102 R3-R4: parameter passing and return values
4103 R5-R10: parameter passing
4104 R13: small data area pointer
4105 R30: GOT pointer
4106 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004107
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004108 (U-Boot also uses R12 as internal GOT pointer. r12
4109 is a volatile register so r12 needs to be reset when
4110 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004111
Wolfgang Denke7670f62008-02-14 22:43:22 +01004112 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114 Note: on PPC, we could use a static initializer (since the
4115 address of the global data structure is known at compile time),
4116 but it turned out that reserving a register results in somewhat
4117 smaller code - although the code savings are not that big (on
4118 average for all boards 752 bytes for the whole U-Boot image,
4119 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004120
Robin Getzc4db3352009-08-17 15:23:02 +00004121On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004122 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4123
Robin Getzc4db3352009-08-17 15:23:02 +00004124 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004125
wdenk2729af92004-05-03 20:45:30 +00004126On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128 R0: function argument word/integer result
4129 R1-R3: function argument word
4130 R9: GOT pointer
4131 R10: stack limit (used only if stack checking if enabled)
4132 R11: argument (frame) pointer
4133 R12: temporary workspace
4134 R13: stack pointer
4135 R14: link register
4136 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk2729af92004-05-03 20:45:30 +00004138 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004139
Thomas Chou0df01fd2010-05-21 11:08:03 +08004140On Nios II, the ABI is documented here:
4141 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4142
4143 ==> U-Boot will use gp to hold a pointer to the global data
4144
4145 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4146 to access small data sections, so gp is free.
4147
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004148NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4149or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004150
wdenk2729af92004-05-03 20:45:30 +00004151Memory Management:
4152------------------
wdenkc6097192002-11-03 00:24:07 +00004153
wdenk2729af92004-05-03 20:45:30 +00004154U-Boot runs in system state and uses physical addresses, i.e. the
4155MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004156
wdenk2729af92004-05-03 20:45:30 +00004157The available memory is mapped to fixed addresses using the memory
4158controller. In this process, a contiguous block is formed for each
4159memory type (Flash, SDRAM, SRAM), even when it consists of several
4160physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162U-Boot is installed in the first 128 kB of the first Flash bank (on
4163TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4164booting and sizing and initializing DRAM, the code relocates itself
4165to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004166memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004167configuration setting]. Below that, a structure with global Board
4168Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004169
wdenk2729af92004-05-03 20:45:30 +00004170Additionally, some exception handler code is copied to the low 8 kB
4171of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004172
wdenk2729af92004-05-03 20:45:30 +00004173So a typical memory configuration with 16 MB of DRAM could look like
4174this:
wdenkc6097192002-11-03 00:24:07 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176 0x0000 0000 Exception Vector code
4177 :
4178 0x0000 1FFF
4179 0x0000 2000 Free for Application Use
4180 :
4181 :
wdenkc6097192002-11-03 00:24:07 +00004182
wdenk2729af92004-05-03 20:45:30 +00004183 :
4184 :
4185 0x00FB FF20 Monitor Stack (Growing downward)
4186 0x00FB FFAC Board Info Data and permanent copy of global data
4187 0x00FC 0000 Malloc Arena
4188 :
4189 0x00FD FFFF
4190 0x00FE 0000 RAM Copy of Monitor Code
4191 ... eventually: LCD or video framebuffer
4192 ... eventually: pRAM (Protected RAM - unchanged by reset)
4193 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004194
4195
wdenk2729af92004-05-03 20:45:30 +00004196System Initialization:
4197----------------------
wdenkc6097192002-11-03 00:24:07 +00004198
wdenk2729af92004-05-03 20:45:30 +00004199In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004200(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004201configuration for CS0# this is a mirror of the onboard Flash memory.
4202To be able to re-map memory U-Boot then jumps to its link address.
4203To be able to implement the initialization code in C, a (small!)
4204initial stack is set up in the internal Dual Ported RAM (in case CPUs
4205which provide such a feature like MPC8xx or MPC8260), or in a locked
4206part of the data cache. After that, U-Boot initializes the CPU core,
4207the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004208
wdenk2729af92004-05-03 20:45:30 +00004209Next, all (potentially) available memory banks are mapped using a
4210preliminary mapping. For example, we put them on 512 MB boundaries
4211(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4212on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4213programmed for SDRAM access. Using the temporary configuration, a
4214simple memory test is run that determines the size of the SDRAM
4215banks.
wdenkc6097192002-11-03 00:24:07 +00004216
wdenk2729af92004-05-03 20:45:30 +00004217When there is more than one SDRAM bank, and the banks are of
4218different size, the largest is mapped first. For equal size, the first
4219bank (CS2#) is mapped first. The first mapping is always for address
42200x00000000, with any additional banks following immediately to create
4221contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004222
wdenk2729af92004-05-03 20:45:30 +00004223Then, the monitor installs itself at the upper end of the SDRAM area
4224and allocates memory for use by malloc() and for the global Board
4225Info data; also, the exception vector code is copied to the low RAM
4226pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004227
wdenk2729af92004-05-03 20:45:30 +00004228Only after this relocation will you have a "normal" C environment;
4229until that you are restricted in several ways, mostly because you are
4230running from ROM, and because the code will have to be relocated to a
4231new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004232
4233
wdenk2729af92004-05-03 20:45:30 +00004234U-Boot Porting Guide:
4235----------------------
wdenkc6097192002-11-03 00:24:07 +00004236
wdenk2729af92004-05-03 20:45:30 +00004237[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4238list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004239
4240
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004241int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004242{
4243 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004244
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004245 signal(SIGALRM, no_more_time);
4246 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004247
wdenk2729af92004-05-03 20:45:30 +00004248 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004249 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004250 return 0;
4251 }
4252
wdenk2729af92004-05-03 20:45:30 +00004253 Download latest U-Boot source;
4254
Wolfgang Denk06682362008-12-30 22:56:11 +01004255 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004256
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004257 if (clueless)
4258 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004259
wdenk2729af92004-05-03 20:45:30 +00004260 while (learning) {
4261 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004262 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4263 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004264 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004265 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004266 }
wdenkc6097192002-11-03 00:24:07 +00004267
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004268 if (available_money > toLocalCurrency ($2500))
4269 Buy a BDI3000;
4270 else
wdenk2729af92004-05-03 20:45:30 +00004271 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004272
4273 if (a similar board exists) { /* hopefully... */
4274 cp -a board/<similar> board/<myboard>
4275 cp include/configs/<similar>.h include/configs/<myboard>.h
4276 } else {
4277 Create your own board support subdirectory;
4278 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004279 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004280 Edit new board/<myboard> files
4281 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004282
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004283 while (!accepted) {
4284 while (!running) {
4285 do {
4286 Add / modify source code;
4287 } until (compiles);
4288 Debug;
4289 if (clueless)
4290 email("Hi, I am having problems...");
4291 }
4292 Send patch file to the U-Boot email list;
4293 if (reasonable critiques)
4294 Incorporate improvements from email list code review;
4295 else
4296 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004297 }
wdenkc6097192002-11-03 00:24:07 +00004298
wdenk2729af92004-05-03 20:45:30 +00004299 return 0;
4300}
4301
4302void no_more_time (int sig)
4303{
4304 hire_a_guru();
4305}
wdenkc6097192002-11-03 00:24:07 +00004306
4307
wdenk2729af92004-05-03 20:45:30 +00004308Coding Standards:
4309-----------------
wdenkc6097192002-11-03 00:24:07 +00004310
wdenk2729af92004-05-03 20:45:30 +00004311All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004312coding style; see the file "Documentation/CodingStyle" and the script
4313"scripts/Lindent" in your Linux kernel source directory. In sources
4314originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4315spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004316
Detlev Zundel2c051652006-09-01 15:39:02 +02004317Source files originating from a different project (for example the
4318MTD subsystem) are generally exempt from these guidelines and are not
4319reformated to ease subsequent migration to newer versions of those
4320sources.
4321
4322Please note that U-Boot is implemented in C (and to some small parts in
4323Assembler); no C++ is used, so please do not use C++ style comments (//)
4324in your code.
wdenk2729af92004-05-03 20:45:30 +00004325
4326Please also stick to the following formatting rules:
4327- remove any trailing white space
4328- use TAB characters for indentation, not spaces
4329- make sure NOT to use DOS '\r\n' line feeds
4330- do not add more than 2 empty lines to source files
4331- do not add trailing empty lines to source files
4332
4333Submissions which do not conform to the standards may be returned
4334with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004335
4336
wdenk2729af92004-05-03 20:45:30 +00004337Submitting Patches:
4338-------------------
wdenkc6097192002-11-03 00:24:07 +00004339
wdenk2729af92004-05-03 20:45:30 +00004340Since the number of patches for U-Boot is growing, we need to
4341establish some rules. Submissions which do not conform to these rules
4342may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004343
Magnus Lilja0d28f342008-08-06 19:32:33 +02004344Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004345
Wolfgang Denk06682362008-12-30 22:56:11 +01004346Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4347see http://lists.denx.de/mailman/listinfo/u-boot
4348
wdenk2729af92004-05-03 20:45:30 +00004349When you send a patch, please include the following information with
4350it:
wdenkc6097192002-11-03 00:24:07 +00004351
wdenk2729af92004-05-03 20:45:30 +00004352* For bug fixes: a description of the bug and how your patch fixes
4353 this bug. Please try to include a way of demonstrating that the
4354 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356* For new features: a description of the feature and your
4357 implementation.
wdenkc6097192002-11-03 00:24:07 +00004358
wdenk2729af92004-05-03 20:45:30 +00004359* A CHANGELOG entry as plaintext (separate from the patch)
4360
4361* For major contributions, your entry to the CREDITS file
4362
4363* When you add support for a new board, don't forget to add this
4364 board to the MAKEALL script, too.
4365
4366* If your patch adds new configuration options, don't forget to
4367 document these in the README file.
4368
Wolfgang Denk218ca722008-03-26 10:40:12 +01004369* The patch itself. If you are using git (which is *strongly*
4370 recommended) you can easily generate the patch using the
4371 "git-format-patch". If you then use "git-send-email" to send it to
4372 the U-Boot mailing list, you will avoid most of the common problems
4373 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004374
Wolfgang Denk218ca722008-03-26 10:40:12 +01004375 If you cannot use git, use "diff -purN OLD NEW". If your version of
4376 diff does not support these options, then get the latest version of
4377 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004378
Wolfgang Denk218ca722008-03-26 10:40:12 +01004379 The current directory when running this command shall be the parent
4380 directory of the U-Boot source tree (i. e. please make sure that
4381 your patch includes sufficient directory information for the
4382 affected files).
4383
4384 We prefer patches as plain text. MIME attachments are discouraged,
4385 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004386
4387* If one logical set of modifications affects or creates several
4388 files, all these changes shall be submitted in a SINGLE patch file.
4389
4390* Changesets that contain different, unrelated modifications shall be
4391 submitted as SEPARATE patches, one patch per changeset.
4392
4393
4394Notes:
4395
4396* Before sending the patch, run the MAKEALL script on your patched
4397 source tree and make sure that no errors or warnings are reported
4398 for any of the boards.
4399
4400* Keep your modifications to the necessary minimum: A patch
4401 containing several unrelated changes or arbitrary reformats will be
4402 returned with a request to re-formatting / split it.
4403
4404* If you modify existing code, make sure that your new code does not
4405 add to the memory footprint of the code ;-) Small is beautiful!
4406 When adding new features, these should compile conditionally only
4407 (using #ifdef), and the resulting code with the new feature
4408 disabled must not need more memory than the old code without your
4409 modification.
wdenk90dc6702005-05-03 14:12:25 +00004410
Wolfgang Denk06682362008-12-30 22:56:11 +01004411* Remember that there is a size limit of 100 kB per message on the
4412 u-boot mailing list. Bigger patches will be moderated. If they are
4413 reasonable and not too big, they will be acknowledged. But patches
4414 bigger than the size limit should be avoided.