blob: 6f3748d6dc4c2a8d4ce491d92420acffa9e42d36 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00002# (C) Copyright 2000 - 2011
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
137 U-Boot v2009.11 - Release November 2009
138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Wolfgang Denka9046b92010-06-13 17:48:15 +0200150 /at91rm9200 Files specific to Atmel AT91RM9200 CPU
151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
183 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /nios2 Files generic to Altera NIOS2 architecture
185 /cpu CPU specific files
186 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200187 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /cpu CPU specific files
189 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
190 /mpc5xx Files specific to Freescale MPC5xx CPUs
191 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
192 /mpc8xx Files specific to Freescale MPC8xx CPUs
193 /mpc8220 Files specific to Freescale MPC8220 CPUs
194 /mpc824x Files specific to Freescale MPC824x CPUs
195 /mpc8260 Files specific to Freescale MPC8260 CPUs
196 /mpc85xx Files specific to Freescale MPC85xx CPUs
197 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
198 /lib Architecture specific library files
199 /sh Files generic to SH architecture
200 /cpu CPU specific files
201 /sh2 Files specific to sh2 CPUs
202 /sh3 Files specific to sh3 CPUs
203 /sh4 Files specific to sh4 CPUs
204 /lib Architecture specific library files
205 /sparc Files generic to SPARC architecture
206 /cpu CPU specific files
207 /leon2 Files specific to Gaisler LEON2 SPARC CPU
208 /leon3 Files specific to Gaisler LEON3 SPARC CPU
209 /lib Architecture specific library files
210/api Machine/arch independent API for external apps
211/board Board dependent files
212/common Misc architecture independent functions
213/disk Code for disk drive partition handling
214/doc Documentation (don't expect too much)
215/drivers Commonly used device drivers
216/examples Example code for standalone applications, etc.
217/fs Filesystem code (cramfs, ext2, jffs2, etc.)
218/include Header Files
219/lib Files generic to all architectures
220 /libfdt Library files to support flattened device trees
221 /lzma Library files to support LZMA decompression
222 /lzo Library files to support LZO decompression
223/net Networking code
224/post Power On Self Test
225/rtc Real Time Clock drivers
226/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000227
wdenkc6097192002-11-03 00:24:07 +0000228Software Configuration:
229=======================
230
231Configuration is usually done using C preprocessor defines; the
232rationale behind that is to avoid dead code whenever possible.
233
234There are two classes of configuration variables:
235
236* Configuration _OPTIONS_:
237 These are selectable by the user and have names beginning with
238 "CONFIG_".
239
240* Configuration _SETTINGS_:
241 These depend on the hardware etc. and should not be meddled with if
242 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200243 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000244
245Later we will add a configuration tool - probably similar to or even
246identical to what's used for the Linux kernel. Right now, we have to
247do the configuration by hand, which means creating some symbolic
248links and editing some configuration files. We use the TQM8xxL boards
249as an example here.
250
251
252Selection of Processor Architecture and Board Type:
253---------------------------------------------------
254
255For all supported boards there are ready-to-use default
256configurations available; just type "make <board_name>_config".
257
258Example: For a TQM823L module type:
259
260 cd u-boot
261 make TQM823L_config
262
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200263For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000264e.g. "make cogent_mpc8xx_config". And also configure the cogent
265directory according to the instructions in cogent/README.
266
267
268Configuration Options:
269----------------------
270
271Configuration depends on the combination of board and CPU type; all
272such information is kept in a configuration file
273"include/configs/<board_name>.h".
274
275Example: For a TQM823L module, all configuration settings are in
276"include/configs/TQM823L.h".
277
278
wdenk7f6c2cb2002-11-10 22:06:23 +0000279Many of the options are named exactly as the corresponding Linux
280kernel configuration options. The intention is to make it easier to
281build a config tool - later.
282
283
wdenkc6097192002-11-03 00:24:07 +0000284The following options need to be configured:
285
Kim Phillips26281142007-08-10 13:28:25 -0500286- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000287
Kim Phillips26281142007-08-10 13:28:25 -0500288- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200289
290- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100291 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000292
293- CPU Module Type: (if CONFIG_COGENT is defined)
294 Define exactly one of
295 CONFIG_CMA286_60_OLD
296--- FIXME --- not tested yet:
297 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298 CONFIG_CMA287_23, CONFIG_CMA287_50
299
300- Motherboard Type: (if CONFIG_COGENT is defined)
301 Define exactly one of
302 CONFIG_CMA101, CONFIG_CMA102
303
304- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305 Define one or more of
306 CONFIG_CMA302
307
308- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309 Define one or more of
310 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200311 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000312 a "rotator" |\-/|\-/
313
wdenk2535d602003-07-17 23:16:40 +0000314- Board flavour: (if CONFIG_MPC8260ADS is defined)
315 CONFIG_ADSTYPE
316 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200317 CONFIG_SYS_8260ADS - original MPC8260ADS
318 CONFIG_SYS_8266ADS - MPC8266ADS
319 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
320 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000321
Lei Wencf946c62011-02-09 18:06:58 +0530322- Marvell Family Member
323 CONFIG_SYS_MVFS - define it if you want to enable
324 multiple fs option at one time
325 for marvell soc family
326
wdenkc6097192002-11-03 00:24:07 +0000327- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000328 Define exactly one of
329 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000330
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200331- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
333 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000334 e.g. if there is no 32KHz
335 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
337 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000338
wdenk66ca92a2004-09-28 17:59:53 +0000339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200340 CONFIG_SYS_8xx_CPUCLK_MIN
341 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000343 See doc/README.MPC866
344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200345 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000346
wdenkba56f622004-02-06 23:19:44 +0000347 Define this to measure the actual CPU clock instead
348 of relying on the correctness of the configured
349 values. Mostly useful for board bringup to make sure
350 the PLL is locked at the intended frequency. Note
351 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200352 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000353
Heiko Schocher506f3912009-03-12 07:37:15 +0100354 CONFIG_SYS_DELAYED_ICACHE
355
356 Define this option if you want to enable the
357 ICache only when Code runs from RAM.
358
Kumar Gala66412c62011-02-18 05:40:54 -0600359- 85xx CPU Options:
360 CONFIG_SYS_FSL_TBCLK_DIV
361
362 Defines the core time base clock divider ratio compared to the
363 system clock. On most PQ3 devices this is 8, on newer QorIQ
364 devices it can be 16 or 32. The ratio varies from SoC to Soc.
365
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100366- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200367 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100368
369 Defines the Monahans run mode to oscillator
370 ratio. Valid values are 8, 16, 24, 31. The core
371 frequency is this value multiplied by 13 MHz.
372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200373 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200374
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100375 Defines the Monahans turbo mode to oscillator
376 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200377 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100378 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200379
wdenk5da627a2003-10-09 20:09:04 +0000380- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000381 CONFIG_CLOCKS_IN_MHZ
382
383 U-Boot stores all clock information in Hz
384 internally. For binary compatibility with older Linux
385 kernels (which expect the clocks passed in the
386 bd_info data to be in MHz) the environment variable
387 "clocks_in_mhz" can be defined so that U-Boot
388 converts clock data to MHZ before passing it to the
389 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000390 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100391 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000392 default environment.
393
wdenk5da627a2003-10-09 20:09:04 +0000394 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
395
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200396 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000397 expect it to be in bytes, others in MB.
398 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
399
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400400 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200401
402 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400403 passed using flattened device trees (based on open firmware
404 concepts).
405
406 CONFIG_OF_LIBFDT
407 * New libfdt-based support
408 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500409 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400410
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200411 OF_CPU - The proper name of the cpus node (only required for
412 MPC512X and MPC5xxx based boards).
413 OF_SOC - The proper name of the soc node (only required for
414 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200415 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600416 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200417
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200418 boards with QUICC Engines require OF_QE to set UCC MAC
419 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500420
Kumar Gala4e253132006-01-11 13:54:17 -0600421 CONFIG_OF_BOARD_SETUP
422
423 Board code has addition modification that it wants to make
424 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000425
Matthew McClintock02677682006-06-28 10:41:37 -0500426 CONFIG_OF_BOOT_CPU
427
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200428 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500429 param header, the default value is zero if undefined.
430
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200431 CONFIG_OF_IDE_FIXUP
432
433 U-Boot can detect if an IDE device is present or not.
434 If not, and this new config option is activated, U-Boot
435 removes the ATA node from the DTS before booting Linux,
436 so the Linux IDE driver does not probe the device and
437 crash. This is needed for buggy hardware (uc101) where
438 no pull down resistor is connected to the signal IDE5V_DD7.
439
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100440- vxWorks boot parameters:
441
442 bootvx constructs a valid bootline using the following
443 environments variables: bootfile, ipaddr, serverip, hostname.
444 It loads the vxWorks image pointed bootfile.
445
446 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
447 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
448 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
449 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
450
451 CONFIG_SYS_VXWORKS_ADD_PARAMS
452
453 Add it at the end of the bootline. E.g "u=username pw=secret"
454
455 Note: If a "bootargs" environment is defined, it will overwride
456 the defaults discussed just above.
457
wdenk6705d812004-08-02 23:22:59 +0000458- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200459 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000460
461 Define this if you want support for Amba PrimeCell PL010 UARTs.
462
Andreas Engel48d01922008-09-08 14:30:53 +0200463 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000464
465 Define this if you want support for Amba PrimeCell PL011 UARTs.
466
467 CONFIG_PL011_CLOCK
468
469 If you have Amba PrimeCell PL011 UARTs, set this variable to
470 the clock speed of the UARTs.
471
472 CONFIG_PL01x_PORTS
473
474 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
475 define this to a list of base addresses for each (supported)
476 port. See e.g. include/configs/versatile.h
477
John Rigby910f1ae2011-04-19 10:42:39 +0000478 CONFIG_PL011_SERIAL_RLCR
479
480 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
481 have separate receive and transmit line control registers. Set
482 this variable to initialize the extra register.
483
484 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
485
486 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
487 boot loader that has already initialized the UART. Define this
488 variable to flush the UART at init time.
489
wdenk6705d812004-08-02 23:22:59 +0000490
wdenkc6097192002-11-03 00:24:07 +0000491- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000492 Depending on board, define exactly one serial port
493 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
494 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
495 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000496
497 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
498 port routines must be defined elsewhere
499 (i.e. serial_init(), serial_getc(), ...)
500
501 CONFIG_CFB_CONSOLE
502 Enables console device for a color framebuffer. Needs following
503 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
504 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
505 (default big endian)
506 VIDEO_HW_RECTFILL graphic chip supports
507 rectangle fill
508 (cf. smiLynxEM)
509 VIDEO_HW_BITBLT graphic chip supports
510 bit-blit (cf. smiLynxEM)
511 VIDEO_VISIBLE_COLS visible pixel columns
512 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000513 VIDEO_VISIBLE_ROWS visible pixel rows
514 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000515 VIDEO_DATA_FORMAT graphic data format
516 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000517 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000518 VIDEO_KBD_INIT_FCT keyboard int fct
519 (i.e. i8042_kbd_init())
520 VIDEO_TSTC_FCT test char fct
521 (i.e. i8042_tstc)
522 VIDEO_GETC_FCT get char fct
523 (i.e. i8042_getc)
524 CONFIG_CONSOLE_CURSOR cursor drawing on/off
525 (requires blink timer
526 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200527 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000528 CONFIG_CONSOLE_TIME display time/date info in
529 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500530 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000531 CONFIG_VIDEO_LOGO display Linux logo in
532 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000533 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
534 linux_logo.h for logo.
535 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000536 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200537 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000538 the logo
539
wdenk43d96162003-03-06 00:02:04 +0000540 When CONFIG_CFB_CONSOLE is defined, video console is
541 default i/o. Serial console can be forced with
542 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000543
wdenkd4ca31c2004-01-02 14:00:00 +0000544 When CONFIG_SILENT_CONSOLE is defined, all console
545 messages (by U-Boot and Linux!) can be silenced with
546 the "silent" environment variable. See
547 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000548
wdenkc6097192002-11-03 00:24:07 +0000549- Console Baudrate:
550 CONFIG_BAUDRATE - in bps
551 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200552 CONFIG_SYS_BAUDRATE_TABLE, see below.
553 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000554
Heiko Schocherc92fac92009-01-30 12:55:38 +0100555- Console Rx buffer length
556 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
557 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100558 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100559 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
560 must be defined, to setup the maximum idle timeout for
561 the SMC.
562
wdenkc6097192002-11-03 00:24:07 +0000563- Boot Delay: CONFIG_BOOTDELAY - in seconds
564 Delay before automatically booting the default image;
565 set to -1 to disable autoboot.
566
567 See doc/README.autoboot for these options that
568 work with CONFIG_BOOTDELAY. None are required.
569 CONFIG_BOOT_RETRY_TIME
570 CONFIG_BOOT_RETRY_MIN
571 CONFIG_AUTOBOOT_KEYED
572 CONFIG_AUTOBOOT_PROMPT
573 CONFIG_AUTOBOOT_DELAY_STR
574 CONFIG_AUTOBOOT_STOP_STR
575 CONFIG_AUTOBOOT_DELAY_STR2
576 CONFIG_AUTOBOOT_STOP_STR2
577 CONFIG_ZERO_BOOTDELAY_CHECK
578 CONFIG_RESET_TO_RETRY
579
580- Autoboot Command:
581 CONFIG_BOOTCOMMAND
582 Only needed when CONFIG_BOOTDELAY is enabled;
583 define a command string that is automatically executed
584 when no character is read on the console interface
585 within "Boot Delay" after reset.
586
587 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000588 This can be used to pass arguments to the bootm
589 command. The value of CONFIG_BOOTARGS goes into the
590 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000591
592 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000593 The value of these goes into the environment as
594 "ramboot" and "nfsboot" respectively, and can be used
595 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200596 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000597
598- Pre-Boot Commands:
599 CONFIG_PREBOOT
600
601 When this option is #defined, the existence of the
602 environment variable "preboot" will be checked
603 immediately before starting the CONFIG_BOOTDELAY
604 countdown and/or running the auto-boot command resp.
605 entering interactive mode.
606
607 This feature is especially useful when "preboot" is
608 automatically generated or modified. For an example
609 see the LWMON board specific code: here "preboot" is
610 modified when the user holds down a certain
611 combination of keys on the (special) keyboard when
612 booting the systems
613
614- Serial Download Echo Mode:
615 CONFIG_LOADS_ECHO
616 If defined to 1, all characters received during a
617 serial download (using the "loads" command) are
618 echoed back. This might be needed by some terminal
619 emulations (like "cu"), but may as well just take
620 time on others. This setting #define's the initial
621 value of the "loads_echo" environment variable.
622
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500623- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000624 CONFIG_KGDB_BAUDRATE
625 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200626 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000627
628- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500629 Monitor commands can be included or excluded
630 from the build by using the #include files
631 "config_cmd_all.h" and #undef'ing unwanted
632 commands, or using "config_cmd_default.h"
633 and augmenting with additional #define's
634 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000635
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500636 The default command configuration includes all commands
637 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000638
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500639 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500640 CONFIG_CMD_BDI bdinfo
641 CONFIG_CMD_BEDBUG * Include BedBug Debugger
642 CONFIG_CMD_BMP * BMP support
643 CONFIG_CMD_BSP * Board specific commands
644 CONFIG_CMD_BOOTD bootd
645 CONFIG_CMD_CACHE * icache, dcache
646 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500647 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500648 CONFIG_CMD_DATE * support for RTC, date/time...
649 CONFIG_CMD_DHCP * DHCP support
650 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600651 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
652 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
653 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
654 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500655 CONFIG_CMD_DTT * Digital Therm and Thermostat
656 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500657 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500658 CONFIG_CMD_EEPROM * EEPROM read/write support
659 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500660 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500661 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500662 CONFIG_CMD_FDC * Floppy Disk Support
663 CONFIG_CMD_FAT * FAT partition support
664 CONFIG_CMD_FDOS * Dos diskette Support
665 CONFIG_CMD_FLASH flinfo, erase, protect
666 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500667 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000668 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500669 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
670 CONFIG_CMD_I2C * I2C serial bus support
671 CONFIG_CMD_IDE * IDE harddisk support
672 CONFIG_CMD_IMI iminfo
673 CONFIG_CMD_IMLS List all found images
674 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500675 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500676 CONFIG_CMD_IRQ * irqinfo
677 CONFIG_CMD_ITEST Integer/string test of 2 values
678 CONFIG_CMD_JFFS2 * JFFS2 Support
679 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500680 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500681 CONFIG_CMD_LOADB loadb
682 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400683 CONFIG_CMD_MD5SUM print md5 message digest
684 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500685 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
686 loop, loopw, mtest
687 CONFIG_CMD_MISC Misc functions like sleep etc
688 CONFIG_CMD_MMC * MMC memory mapped support
689 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100690 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500691 CONFIG_CMD_NAND * NAND support
692 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600693 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
694 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500695 CONFIG_CMD_PCI * pciinfo
696 CONFIG_CMD_PCMCIA * PCMCIA support
697 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
698 host
699 CONFIG_CMD_PORTIO * Port I/O
700 CONFIG_CMD_REGINFO * Register dump
701 CONFIG_CMD_RUN run command in env variable
702 CONFIG_CMD_SAVES * save S record dump
703 CONFIG_CMD_SCSI * SCSI Support
704 CONFIG_CMD_SDRAM * print SDRAM configuration information
705 (requires CONFIG_CMD_I2C)
706 CONFIG_CMD_SETGETDCR Support for DCR Register access
707 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100708 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400709 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200710 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500711 CONFIG_CMD_SPI * SPI serial bus support
712 CONFIG_CMD_USB * USB support
713 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500714 CONFIG_CMD_CDP * Cisco Discover Protocol support
715 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000716
wdenkc6097192002-11-03 00:24:07 +0000717
718 EXAMPLE: If you want all functions except of network
719 support you can write:
720
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500721 #include "config_cmd_all.h"
722 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000723
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400724 Other Commands:
725 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000726
727 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500728 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000729 what you (and your U-Boot users) are doing. Data
730 cache cannot be enabled on systems like the 8xx or
731 8260 (where accesses to the IMMR region must be
732 uncached), and it cannot be disabled on all other
733 systems where we (mis-) use the data cache to hold an
734 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000735
736
737 XXX - this list needs to get updated!
738
739- Watchdog:
740 CONFIG_WATCHDOG
741 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000742 support for the SoC. There must be support in the SoC
743 specific code for a watchdog. For the 8xx and 8260
744 CPUs, the SIU Watchdog feature is enabled in the SYPCR
745 register. When supported for a specific SoC is
746 available, then no further board specific code should
747 be needed to use it.
748
749 CONFIG_HW_WATCHDOG
750 When using a watchdog circuitry external to the used
751 SoC, then define this variable and provide board
752 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000753
stroesec1551ea2003-04-04 15:53:41 +0000754- U-Boot Version:
755 CONFIG_VERSION_VARIABLE
756 If this variable is defined, an environment variable
757 named "ver" is created by U-Boot showing the U-Boot
758 version as printed by the "version" command.
759 This variable is readonly.
760
wdenkc6097192002-11-03 00:24:07 +0000761- Real-Time Clock:
762
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500763 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000764 has to be selected, too. Define exactly one of the
765 following options:
766
767 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
768 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200769 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000770 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000771 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000772 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000773 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000774 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100775 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000776 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200777 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200778 CONFIG_SYS_RV3029_TCR - enable trickle charger on
779 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000780
wdenkb37c7e52003-06-30 16:24:52 +0000781 Note that if the RTC uses I2C, then the I2C interface
782 must also be configured. See I2C Support, below.
783
Peter Tysere92739d2008-12-17 16:36:21 -0600784- GPIO Support:
785 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
786 CONFIG_PCA953X_INFO - enable pca953x info command
787
Chris Packham5dec49c2010-12-19 10:12:13 +0000788 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
789 chip-ngpio pairs that tell the PCA953X driver the number of
790 pins supported by a particular chip.
791
Peter Tysere92739d2008-12-17 16:36:21 -0600792 Note that if the GPIO device uses I2C, then the I2C interface
793 must also be configured. See I2C Support, below.
794
wdenkc6097192002-11-03 00:24:07 +0000795- Timestamp Support:
796
wdenk43d96162003-03-06 00:02:04 +0000797 When CONFIG_TIMESTAMP is selected, the timestamp
798 (date and time) of an image is printed by image
799 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500800 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000801
802- Partition Support:
803 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400804 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000805
Wolfgang Denk218ca722008-03-26 10:40:12 +0100806 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
807 CONFIG_CMD_SCSI) you must configure support for at
808 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000809
810- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000811 CONFIG_IDE_RESET_ROUTINE - this is defined in several
812 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000813
wdenk4d13cba2004-03-14 14:09:05 +0000814 CONFIG_IDE_RESET - is this is defined, IDE Reset will
815 be performed by calling the function
816 ide_set_reset(int reset)
817 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000818
819- ATAPI Support:
820 CONFIG_ATAPI
821
822 Set this to enable ATAPI support.
823
wdenkc40b2952004-03-13 23:29:43 +0000824- LBA48 Support
825 CONFIG_LBA48
826
827 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100828 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000829 Whithout these , LBA48 support uses 32bit variables and will 'only'
830 support disks up to 2.1TB.
831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200832 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000833 When enabled, makes the IDE subsystem use 64bit sector addresses.
834 Default is 32bit.
835
wdenkc6097192002-11-03 00:24:07 +0000836- SCSI Support:
837 At the moment only there is only support for the
838 SYM53C8XX SCSI controller; define
839 CONFIG_SCSI_SYM53C8XX to enable it.
840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200841 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
842 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
843 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000844 maximum numbers of LUNs, SCSI ID's and target
845 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200846 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000847
848- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000849 CONFIG_E1000
850 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000851
Andre Schwarzac3315c2008-03-06 16:45:44 +0100852 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200853 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100854
wdenkc6097192002-11-03 00:24:07 +0000855 CONFIG_EEPRO100
856 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200857 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000858 write routine for first time initialisation.
859
860 CONFIG_TULIP
861 Support for Digital 2114x chips.
862 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
863 modem chip initialisation (KS8761/QS6611).
864
865 CONFIG_NATSEMI
866 Support for National dp83815 chips.
867
868 CONFIG_NS8382X
869 Support for National dp8382[01] gigabit chips.
870
wdenk45219c42003-05-12 21:50:16 +0000871- NETWORK Support (other):
872
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100873 CONFIG_DRIVER_AT91EMAC
874 Support for AT91RM9200 EMAC.
875
876 CONFIG_RMII
877 Define this to use reduced MII inteface
878
879 CONFIG_DRIVER_AT91EMAC_QUIET
880 If this defined, the driver is quiet.
881 The driver doen't show link status messages.
882
wdenk45219c42003-05-12 21:50:16 +0000883 CONFIG_DRIVER_LAN91C96
884 Support for SMSC's LAN91C96 chips.
885
886 CONFIG_LAN91C96_BASE
887 Define this to hold the physical address
888 of the LAN91C96's I/O space
889
890 CONFIG_LAN91C96_USE_32_BIT
891 Define this to enable 32 bit addressing
892
wdenkf39748a2004-06-09 13:37:52 +0000893 CONFIG_DRIVER_SMC91111
894 Support for SMSC's LAN91C111 chip
895
896 CONFIG_SMC91111_BASE
897 Define this to hold the physical address
898 of the device (I/O space)
899
900 CONFIG_SMC_USE_32_BIT
901 Define this if data bus is 32 bits
902
903 CONFIG_SMC_USE_IOFUNCS
904 Define this to use i/o functions instead of macros
905 (some hardware wont work with macros)
906
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800907 CONFIG_FTGMAC100
908 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
909
910 CONFIG_FTGMAC100_EGIGA
911 Define this to use GE link update with gigabit PHY.
912 Define this if FTGMAC100 is connected to gigabit PHY.
913 If your system has 10/100 PHY only, it might not occur
914 wrong behavior. Because PHY usually return timeout or
915 useless data when polling gigabit status and gigabit
916 control registers. This behavior won't affect the
917 correctnessof 10/100 link speed update.
918
Mike Rapoportc2fff332009-11-11 10:03:03 +0200919 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200920 Support for SMSC's LAN911x and LAN921x chips
921
Mike Rapoportc2fff332009-11-11 10:03:03 +0200922 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200923 Define this to hold the physical address
924 of the device (I/O space)
925
Mike Rapoportc2fff332009-11-11 10:03:03 +0200926 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200927 Define this if data bus is 32 bits
928
Mike Rapoportc2fff332009-11-11 10:03:03 +0200929 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200930 Define this if data bus is 16 bits. If your processor
931 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200932 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200933
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +0900934 CONFIG_SH_ETHER
935 Support for Renesas on-chip Ethernet controller
936
937 CONFIG_SH_ETHER_USE_PORT
938 Define the number of ports to be used
939
940 CONFIG_SH_ETHER_PHY_ADDR
941 Define the ETH PHY's address
942
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +0900943 CONFIG_SH_ETHER_CACHE_WRITEBACK
944 If this option is set, the driver enables cache flush.
945
wdenkc6097192002-11-03 00:24:07 +0000946- USB Support:
947 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000948 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000949 CONFIG_USB_UHCI to enable it.
950 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000951 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000952 storage devices.
953 Note:
954 Supported are USB Keyboards and USB Floppy drives
955 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000956 MPC5200 USB requires additional defines:
957 CONFIG_USB_CLOCK
958 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500959 CONFIG_PSC3_USB
960 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000961 CONFIG_USB_CONFIG
962 for differential drivers: 0x00001000
963 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500964 for differential drivers on PSC3: 0x00000100
965 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200966 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200967 May be defined to allow interrupt polling
968 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000969
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200970- USB Device:
971 Define the below if you wish to use the USB console.
972 Once firmware is rebuilt from a serial console issue the
973 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200974 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200975 it has found a new device. The environment variable usbtty
976 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200977 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200978 Common Device Class Abstract Control Model serial device.
979 If you select usbtty = gserial you should be able to enumerate
980 a Linux host by
981 # modprobe usbserial vendor=0xVendorID product=0xProductID
982 else if using cdc_acm, simply setting the environment
983 variable usbtty to be cdc_acm should suffice. The following
984 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200985
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200986 CONFIG_USB_DEVICE
987 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000988
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200989 CONFIG_USB_TTY
990 Define this to have a tty type of device available to
991 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200993 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200994 Define this if you want stdin, stdout &/or stderr to
995 be set to usbtty.
996
997 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200998 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200999 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001000 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001001
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001002 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001003 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001004 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001005
Wolfgang Denk386eda02006-06-14 18:14:56 +02001006 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001007 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001008 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001009 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1010 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1011 should pretend to be a Linux device to it's target host.
1012
1013 CONFIG_USBD_MANUFACTURER
1014 Define this string as the name of your company for
1015 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001016
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001017 CONFIG_USBD_PRODUCT_NAME
1018 Define this string as the name of your product
1019 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1020
1021 CONFIG_USBD_VENDORID
1022 Define this as your assigned Vendor ID from the USB
1023 Implementors Forum. This *must* be a genuine Vendor ID
1024 to avoid polluting the USB namespace.
1025 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001026
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001027 CONFIG_USBD_PRODUCTID
1028 Define this as the unique Product ID
1029 for your device
1030 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001031
1032
1033- MMC Support:
1034 The MMC controller on the Intel PXA is supported. To
1035 enable this define CONFIG_MMC. The MMC can be
1036 accessed from the boot prompt by mapping the device
1037 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001038 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1039 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001040
wdenk6705d812004-08-02 23:22:59 +00001041- Journaling Flash filesystem support:
1042 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1043 CONFIG_JFFS2_NAND_DEV
1044 Define these for a default partition on a NAND device
1045
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001046 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1047 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001048 Define these for a default partition on a NOR device
1049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001050 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001051 Define this to create an own partition. You have to provide a
1052 function struct part_info* jffs2_part_info(int part_num)
1053
1054 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001055 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001056 to disable the command chpart. This is the default when you
1057 have not defined a custom partition
1058
wdenkc6097192002-11-03 00:24:07 +00001059- Keyboard Support:
1060 CONFIG_ISA_KEYBOARD
1061
1062 Define this to enable standard (PC-Style) keyboard
1063 support
1064
1065 CONFIG_I8042_KBD
1066 Standard PC keyboard driver with US (is default) and
1067 GERMAN key layout (switch via environment 'keymap=de') support.
1068 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1069 for cfb_console. Supports cursor blinking.
1070
1071- Video support:
1072 CONFIG_VIDEO
1073
1074 Define this to enable video support (for output to
1075 video).
1076
1077 CONFIG_VIDEO_CT69000
1078
1079 Enable Chips & Technologies 69000 Video chip
1080
1081 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001082 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001083 video output is selected via environment 'videoout'
1084 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1085 assumed.
wdenkc6097192002-11-03 00:24:07 +00001086
wdenkb79a11c2004-03-25 15:14:43 +00001087 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001088 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001089 are possible:
1090 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001091 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001092
1093 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1094 -------------+---------------------------------------------
1095 8 bits | 0x301* 0x303 0x305 0x161 0x307
1096 15 bits | 0x310 0x313 0x316 0x162 0x319
1097 16 bits | 0x311 0x314 0x317 0x163 0x31A
1098 24 bits | 0x312 0x315 0x318 ? 0x31B
1099 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001100 (i.e. setenv videomode 317; saveenv; reset;)
1101
wdenkb79a11c2004-03-25 15:14:43 +00001102 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001103 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001104
1105
stroesec1551ea2003-04-04 15:53:41 +00001106 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001107 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001108 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1109 or CONFIG_VIDEO_SED13806_16BPP
1110
Timur Tabi7d3053f2011-02-15 17:09:19 -06001111 CONFIG_FSL_DIU_FB
1112 Enable the Freescale DIU video driver. Reference boards for
1113 SOCs that have a DIU should define this macro to enable DIU
1114 support, and should also define these other macros:
1115
1116 CONFIG_SYS_DIU_ADDR
1117 CONFIG_VIDEO
1118 CONFIG_CMD_BMP
1119 CONFIG_CFB_CONSOLE
1120 CONFIG_VIDEO_SW_CURSOR
1121 CONFIG_VGA_AS_SINGLE_DEVICE
1122 CONFIG_VIDEO_LOGO
1123 CONFIG_VIDEO_BMP_LOGO
1124
Timur Tabiba8e76b2011-04-11 14:18:22 -05001125 The DIU driver will look for the 'video-mode' environment
1126 variable, and if defined, enable the DIU as a console during
1127 boot. See the documentation file README.video for a
1128 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001129
wdenk682011f2003-06-03 23:54:09 +00001130- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001131 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001132
wdenk8bde7f72003-06-27 21:31:46 +00001133 Define this to enable a custom keyboard support.
1134 This simply calls drv_keyboard_init() which must be
1135 defined in your board-specific files.
1136 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001137
wdenkc6097192002-11-03 00:24:07 +00001138- LCD Support: CONFIG_LCD
1139
1140 Define this to enable LCD support (for output to LCD
1141 display); also select one of the supported displays
1142 by defining one of these:
1143
Stelian Pop39cf4802008-05-09 21:57:18 +02001144 CONFIG_ATMEL_LCD:
1145
1146 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1147
wdenkfd3103b2003-11-25 16:55:19 +00001148 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001149
wdenkfd3103b2003-11-25 16:55:19 +00001150 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001151
wdenkfd3103b2003-11-25 16:55:19 +00001152 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001153
wdenkfd3103b2003-11-25 16:55:19 +00001154 NEC NL6448BC20-08. 6.5", 640x480.
1155 Active, color, single scan.
1156
1157 CONFIG_NEC_NL6448BC33_54
1158
1159 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001160 Active, color, single scan.
1161
1162 CONFIG_SHARP_16x9
1163
1164 Sharp 320x240. Active, color, single scan.
1165 It isn't 16x9, and I am not sure what it is.
1166
1167 CONFIG_SHARP_LQ64D341
1168
1169 Sharp LQ64D341 display, 640x480.
1170 Active, color, single scan.
1171
1172 CONFIG_HLD1045
1173
1174 HLD1045 display, 640x480.
1175 Active, color, single scan.
1176
1177 CONFIG_OPTREX_BW
1178
1179 Optrex CBL50840-2 NF-FW 99 22 M5
1180 or
1181 Hitachi LMG6912RPFC-00T
1182 or
1183 Hitachi SP14Q002
1184
1185 320x240. Black & white.
1186
1187 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001188 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001189
wdenk7152b1d2003-09-05 23:19:14 +00001190- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001191
wdenk8bde7f72003-06-27 21:31:46 +00001192 If this option is set, the environment is checked for
1193 a variable "splashimage". If found, the usual display
1194 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001195 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001196 specified in "splashimage" is loaded instead. The
1197 console is redirected to the "nulldev", too. This
1198 allows for a "silent" boot where a splash screen is
1199 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001200
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001201 CONFIG_SPLASH_SCREEN_ALIGN
1202
1203 If this option is set the splash image can be freely positioned
1204 on the screen. Environment variable "splashpos" specifies the
1205 position as "x,y". If a positive number is given it is used as
1206 number of pixel from left/top. If a negative number is given it
1207 is used as number of pixel from right/bottom. You can also
1208 specify 'm' for centering the image.
1209
1210 Example:
1211 setenv splashpos m,m
1212 => image at center of screen
1213
1214 setenv splashpos 30,20
1215 => image at x = 30 and y = 20
1216
1217 setenv splashpos -10,m
1218 => vertically centered image
1219 at x = dspWidth - bmpWidth - 9
1220
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001221- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1222
1223 If this option is set, additionally to standard BMP
1224 images, gzipped BMP images can be displayed via the
1225 splashscreen support or the bmp command.
1226
Anatolij Gustschind5011762010-03-15 14:50:25 +01001227- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1228
1229 If this option is set, 8-bit RLE compressed BMP images
1230 can be displayed via the splashscreen support or the
1231 bmp command.
1232
wdenkc29fdfc2003-08-29 20:57:53 +00001233- Compression support:
1234 CONFIG_BZIP2
1235
1236 If this option is set, support for bzip2 compressed
1237 images is included. If not, only uncompressed and gzip
1238 compressed images are supported.
1239
wdenk42d1f032003-10-15 23:53:47 +00001240 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001241 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001242 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001243
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001244 CONFIG_LZMA
1245
1246 If this option is set, support for lzma compressed
1247 images is included.
1248
1249 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1250 requires an amount of dynamic memory that is given by the
1251 formula:
1252
1253 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1254
1255 Where lc and lp stand for, respectively, Literal context bits
1256 and Literal pos bits.
1257
1258 This value is upper-bounded by 14MB in the worst case. Anyway,
1259 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1260 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1261 a very small buffer.
1262
1263 Use the lzmainfo tool to determinate the lc and lp values and
1264 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001265 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001266
wdenk17ea1172004-06-06 21:51:03 +00001267- MII/PHY support:
1268 CONFIG_PHY_ADDR
1269
1270 The address of PHY on MII bus.
1271
1272 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1273
1274 The clock frequency of the MII bus
1275
1276 CONFIG_PHY_GIGE
1277
1278 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001279 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001280
1281 CONFIG_PHY_RESET_DELAY
1282
1283 Some PHY like Intel LXT971A need extra delay after
1284 reset before any MII register access is possible.
1285 For such PHY, set this option to the usec delay
1286 required. (minimum 300usec for LXT971A)
1287
1288 CONFIG_PHY_CMD_DELAY (ppc4xx)
1289
1290 Some PHY like Intel LXT971A need extra delay after
1291 command issued before MII status register can be read
1292
wdenkc6097192002-11-03 00:24:07 +00001293- Ethernet address:
1294 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001295 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001296 CONFIG_ETH2ADDR
1297 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001298 CONFIG_ETH4ADDR
1299 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001300
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001301 Define a default value for Ethernet address to use
1302 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001303 is not determined automatically.
1304
1305- IP address:
1306 CONFIG_IPADDR
1307
1308 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001309 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001310 determined through e.g. bootp.
1311
1312- Server IP address:
1313 CONFIG_SERVERIP
1314
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001315 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001316 server to contact when using the "tftboot" command.
1317
Robin Getz97cfe862009-07-21 12:15:28 -04001318 CONFIG_KEEP_SERVERADDR
1319
1320 Keeps the server's MAC address, in the env 'serveraddr'
1321 for passing to bootargs (like Linux's netconsole option)
1322
David Updegraff53a5c422007-06-11 10:41:07 -05001323- Multicast TFTP Mode:
1324 CONFIG_MCAST_TFTP
1325
1326 Defines whether you want to support multicast TFTP as per
1327 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001328 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001329 driver in use must provide a function: mcast() to join/leave a
1330 multicast group.
1331
wdenkc6097192002-11-03 00:24:07 +00001332- BOOTP Recovery Mode:
1333 CONFIG_BOOTP_RANDOM_DELAY
1334
1335 If you have many targets in a network that try to
1336 boot using BOOTP, you may want to avoid that all
1337 systems send out BOOTP requests at precisely the same
1338 moment (which would happen for instance at recovery
1339 from a power failure, when all systems will try to
1340 boot, thus flooding the BOOTP server. Defining
1341 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1342 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001343 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001344
1345 1st BOOTP request: delay 0 ... 1 sec
1346 2nd BOOTP request: delay 0 ... 2 sec
1347 3rd BOOTP request: delay 0 ... 4 sec
1348 4th and following
1349 BOOTP requests: delay 0 ... 8 sec
1350
stroesefe389a82003-08-28 14:17:32 +00001351- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001352 You can fine tune the DHCP functionality by defining
1353 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001354
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001355 CONFIG_BOOTP_SUBNETMASK
1356 CONFIG_BOOTP_GATEWAY
1357 CONFIG_BOOTP_HOSTNAME
1358 CONFIG_BOOTP_NISDOMAIN
1359 CONFIG_BOOTP_BOOTPATH
1360 CONFIG_BOOTP_BOOTFILESIZE
1361 CONFIG_BOOTP_DNS
1362 CONFIG_BOOTP_DNS2
1363 CONFIG_BOOTP_SEND_HOSTNAME
1364 CONFIG_BOOTP_NTPSERVER
1365 CONFIG_BOOTP_TIMEOFFSET
1366 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001367
Wilson Callan5d110f02007-07-28 10:56:13 -04001368 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1369 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001370
1371 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1372 serverip from a DHCP server, it is possible that more
1373 than one DNS serverip is offered to the client.
1374 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1375 serverip will be stored in the additional environment
1376 variable "dnsip2". The first DNS serverip is always
1377 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001378 is defined.
stroesefe389a82003-08-28 14:17:32 +00001379
1380 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1381 to do a dynamic update of a DNS server. To do this, they
1382 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001383 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001384 of the "hostname" environment variable is passed as
1385 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001386
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001387 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1388
1389 A 32bit value in microseconds for a delay between
1390 receiving a "DHCP Offer" and sending the "DHCP Request".
1391 This fixes a problem with certain DHCP servers that don't
1392 respond 100% of the time to a "DHCP request". E.g. On an
1393 AT91RM9200 processor running at 180MHz, this delay needed
1394 to be *at least* 15,000 usec before a Windows Server 2003
1395 DHCP server would reply 100% of the time. I recommend at
1396 least 50,000 usec to be safe. The alternative is to hope
1397 that one of the retries will be successful but note that
1398 the DHCP timeout and retry process takes a longer than
1399 this delay.
1400
wdenka3d991b2004-04-15 21:48:45 +00001401 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001402 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001403
1404 The device id used in CDP trigger frames.
1405
1406 CONFIG_CDP_DEVICE_ID_PREFIX
1407
1408 A two character string which is prefixed to the MAC address
1409 of the device.
1410
1411 CONFIG_CDP_PORT_ID
1412
1413 A printf format string which contains the ascii name of
1414 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001415 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001416
1417 CONFIG_CDP_CAPABILITIES
1418
1419 A 32bit integer which indicates the device capabilities;
1420 0x00000010 for a normal host which does not forwards.
1421
1422 CONFIG_CDP_VERSION
1423
1424 An ascii string containing the version of the software.
1425
1426 CONFIG_CDP_PLATFORM
1427
1428 An ascii string containing the name of the platform.
1429
1430 CONFIG_CDP_TRIGGER
1431
1432 A 32bit integer sent on the trigger.
1433
1434 CONFIG_CDP_POWER_CONSUMPTION
1435
1436 A 16bit integer containing the power consumption of the
1437 device in .1 of milliwatts.
1438
1439 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1440
1441 A byte containing the id of the VLAN.
1442
wdenkc6097192002-11-03 00:24:07 +00001443- Status LED: CONFIG_STATUS_LED
1444
1445 Several configurations allow to display the current
1446 status using a LED. For instance, the LED will blink
1447 fast while running U-Boot code, stop blinking as
1448 soon as a reply to a BOOTP request was received, and
1449 start blinking slow once the Linux kernel is running
1450 (supported by a status LED driver in the Linux
1451 kernel). Defining CONFIG_STATUS_LED enables this
1452 feature in U-Boot.
1453
1454- CAN Support: CONFIG_CAN_DRIVER
1455
1456 Defining CONFIG_CAN_DRIVER enables CAN driver support
1457 on those systems that support this (optional)
1458 feature, like the TQM8xxL modules.
1459
1460- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1461
wdenkb37c7e52003-06-30 16:24:52 +00001462 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001463 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001464 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001465
wdenk945af8d2003-07-16 21:53:01 +00001466 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001467 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001468 CONFIG_COMMANDS) and communicate with i2c based realtime
1469 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001470 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001471
Ben Warrenbb99ad62006-09-07 16:50:54 -04001472 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001473
wdenk945af8d2003-07-16 21:53:01 +00001474 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001475 bit-banging) driver instead of CPM or similar hardware
1476 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001477
wdenk945af8d2003-07-16 21:53:01 +00001478 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001479 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001481 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001482 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001483 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001484 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001485
Peter Tyser8d321b82010-04-12 22:28:21 -05001486 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001487 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001488 and so its address should therefore be cleared to 0 (See,
1489 eg, MPC823e User's Manual p.16-473). So, set
1490 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001491
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001492 CONFIG_SYS_I2C_INIT_MPC5XXX
1493
1494 When a board is reset during an i2c bus transfer
1495 chips might think that the current transfer is still
1496 in progress. Reset the slave devices by sending start
1497 commands until the slave device responds.
1498
wdenk945af8d2003-07-16 21:53:01 +00001499 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001500
1501 If you use the software i2c interface (CONFIG_SOFT_I2C)
1502 then the following macros need to be defined (examples are
1503 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001504
1505 I2C_INIT
1506
wdenkb37c7e52003-06-30 16:24:52 +00001507 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001508 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001509
wdenkba56f622004-02-06 23:19:44 +00001510 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001511
wdenkc6097192002-11-03 00:24:07 +00001512 I2C_PORT
1513
wdenk43d96162003-03-06 00:02:04 +00001514 (Only for MPC8260 CPU). The I/O port to use (the code
1515 assumes both bits are on the same port). Valid values
1516 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001517
1518 I2C_ACTIVE
1519
1520 The code necessary to make the I2C data line active
1521 (driven). If the data line is open collector, this
1522 define can be null.
1523
wdenkb37c7e52003-06-30 16:24:52 +00001524 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1525
wdenkc6097192002-11-03 00:24:07 +00001526 I2C_TRISTATE
1527
1528 The code necessary to make the I2C data line tri-stated
1529 (inactive). If the data line is open collector, this
1530 define can be null.
1531
wdenkb37c7e52003-06-30 16:24:52 +00001532 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1533
wdenkc6097192002-11-03 00:24:07 +00001534 I2C_READ
1535
1536 Code that returns TRUE if the I2C data line is high,
1537 FALSE if it is low.
1538
wdenkb37c7e52003-06-30 16:24:52 +00001539 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1540
wdenkc6097192002-11-03 00:24:07 +00001541 I2C_SDA(bit)
1542
1543 If <bit> is TRUE, sets the I2C data line high. If it
1544 is FALSE, it clears it (low).
1545
wdenkb37c7e52003-06-30 16:24:52 +00001546 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001547 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001548 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001549
wdenkc6097192002-11-03 00:24:07 +00001550 I2C_SCL(bit)
1551
1552 If <bit> is TRUE, sets the I2C clock line high. If it
1553 is FALSE, it clears it (low).
1554
wdenkb37c7e52003-06-30 16:24:52 +00001555 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001556 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001557 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001558
wdenkc6097192002-11-03 00:24:07 +00001559 I2C_DELAY
1560
1561 This delay is invoked four times per clock cycle so this
1562 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001563 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001564 like:
1565
wdenkb37c7e52003-06-30 16:24:52 +00001566 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001567
Mike Frysinger793b5722010-07-21 13:38:02 -04001568 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1569
1570 If your arch supports the generic GPIO framework (asm/gpio.h),
1571 then you may alternatively define the two GPIOs that are to be
1572 used as SCL / SDA. Any of the previous I2C_xxx macros will
1573 have GPIO-based defaults assigned to them as appropriate.
1574
1575 You should define these to the GPIO value as given directly to
1576 the generic GPIO functions.
1577
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001578 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001579
wdenk8bde7f72003-06-27 21:31:46 +00001580 When a board is reset during an i2c bus transfer
1581 chips might think that the current transfer is still
1582 in progress. On some boards it is possible to access
1583 the i2c SCLK line directly, either by using the
1584 processor pin as a GPIO or by having a second pin
1585 connected to the bus. If this option is defined a
1586 custom i2c_init_board() routine in boards/xxx/board.c
1587 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001588
Richard Retanubun26a33502010-04-12 15:08:17 -04001589 CONFIG_SYS_I2C_BOARD_LATE_INIT
1590
1591 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1592 defined a custom i2c_board_late_init() routine in
1593 boards/xxx/board.c is run AFTER the operations in i2c_init()
1594 is completed. This callpoint can be used to unreset i2c bus
1595 using CPU i2c controller register accesses for CPUs whose i2c
1596 controller provide such a method. It is called at the end of
1597 i2c_init() to allow i2c_init operations to setup the i2c bus
1598 controller on the CPU (e.g. setting bus speed & slave address).
1599
wdenk17ea1172004-06-06 21:51:03 +00001600 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1601
1602 This option enables configuration of bi_iic_fast[] flags
1603 in u-boot bd_info structure based on u-boot environment
1604 variable "i2cfast". (see also i2cfast)
1605
Ben Warrenbb99ad62006-09-07 16:50:54 -04001606 CONFIG_I2C_MULTI_BUS
1607
1608 This option allows the use of multiple I2C buses, each of which
1609 must have a controller. At any point in time, only one bus is
1610 active. To switch to a different bus, use the 'i2c dev' command.
1611 Note that bus numbering is zero-based.
1612
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001613 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001614
1615 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001616 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1617 is set, specify a list of bus-device pairs. Otherwise, specify
1618 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001619
1620 e.g.
1621 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001622 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001623
1624 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1625
1626 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001627 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001628
1629 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1630
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001631 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001632
1633 If defined, then this indicates the I2C bus number for DDR SPD.
1634 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1635
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001636 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001637
1638 If defined, then this indicates the I2C bus number for the RTC.
1639 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1640
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001641 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001642
1643 If defined, then this indicates the I2C bus number for the DTT.
1644 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1645
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001646 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001647
1648 If defined, specifies the I2C address of the DTT device.
1649 If not defined, then U-Boot uses predefined value for
1650 specified DTT device.
1651
Timur Tabibe5e6182006-11-03 19:15:00 -06001652 CONFIG_FSL_I2C
1653
1654 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001655 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001656
Heiko Schocher67b23a32008-10-15 09:39:47 +02001657 CONFIG_I2C_MUX
1658
1659 Define this option if you have I2C devices reached over 1 .. n
1660 I2C Muxes like the pca9544a. This option addes a new I2C
1661 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1662 new I2C Bus to the existing I2C Busses. If you select the
1663 new Bus with "i2c dev", u-bbot sends first the commandos for
1664 the muxes to activate this new "bus".
1665
1666 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1667 feature!
1668
1669 Example:
1670 Adding a new I2C Bus reached over 2 pca9544a muxes
1671 The First mux with address 70 and channel 6
1672 The Second mux with address 71 and channel 4
1673
1674 => i2c bus pca9544a:70:6:pca9544a:71:4
1675
1676 Use the "i2c bus" command without parameter, to get a list
1677 of I2C Busses with muxes:
1678
1679 => i2c bus
1680 Busses reached over muxes:
1681 Bus ID: 2
1682 reached over Mux(es):
1683 pca9544a@70 ch: 4
1684 Bus ID: 3
1685 reached over Mux(es):
1686 pca9544a@70 ch: 6
1687 pca9544a@71 ch: 4
1688 =>
1689
1690 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1691 u-boot sends First the Commando to the mux@70 to enable
1692 channel 6, and then the Commando to the mux@71 to enable
1693 the channel 4.
1694
1695 After that, you can use the "normal" i2c commands as
1696 usual, to communicate with your I2C devices behind
1697 the 2 muxes.
1698
1699 This option is actually implemented for the bitbanging
1700 algorithm in common/soft_i2c.c and for the Hardware I2C
1701 Bus on the MPC8260. But it should be not so difficult
1702 to add this option to other architectures.
1703
Andrew Dyer2ac69852008-12-29 17:36:01 -06001704 CONFIG_SOFT_I2C_READ_REPEATED_START
1705
1706 defining this will force the i2c_read() function in
1707 the soft_i2c driver to perform an I2C repeated start
1708 between writing the address pointer and reading the
1709 data. If this define is omitted the default behaviour
1710 of doing a stop-start sequence will be used. Most I2C
1711 devices can use either method, but some require one or
1712 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001713
wdenkc6097192002-11-03 00:24:07 +00001714- SPI Support: CONFIG_SPI
1715
1716 Enables SPI driver (so far only tested with
1717 SPI EEPROM, also an instance works with Crystal A/D and
1718 D/As on the SACSng board)
1719
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001720 CONFIG_SH_SPI
1721
1722 Enables the driver for SPI controller on SuperH. Currently
1723 only SH7757 is supported.
1724
wdenkc6097192002-11-03 00:24:07 +00001725 CONFIG_SPI_X
1726
1727 Enables extended (16-bit) SPI EEPROM addressing.
1728 (symmetrical to CONFIG_I2C_X)
1729
1730 CONFIG_SOFT_SPI
1731
wdenk43d96162003-03-06 00:02:04 +00001732 Enables a software (bit-bang) SPI driver rather than
1733 using hardware support. This is a general purpose
1734 driver that only requires three general I/O port pins
1735 (two outputs, one input) to function. If this is
1736 defined, the board configuration must define several
1737 SPI configuration items (port pins to use, etc). For
1738 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001739
Ben Warren04a9e112008-01-16 22:37:35 -05001740 CONFIG_HARD_SPI
1741
1742 Enables a hardware SPI driver for general-purpose reads
1743 and writes. As with CONFIG_SOFT_SPI, the board configuration
1744 must define a list of chip-select function pointers.
1745 Currently supported on some MPC8xxx processors. For an
1746 example, see include/configs/mpc8349emds.h.
1747
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001748 CONFIG_MXC_SPI
1749
1750 Enables the driver for the SPI controllers on i.MX and MXC
1751 SoCs. Currently only i.MX31 is supported.
1752
Matthias Fuchs01335022007-12-27 17:12:34 +01001753- FPGA Support: CONFIG_FPGA
1754
1755 Enables FPGA subsystem.
1756
1757 CONFIG_FPGA_<vendor>
1758
1759 Enables support for specific chip vendors.
1760 (ALTERA, XILINX)
1761
1762 CONFIG_FPGA_<family>
1763
1764 Enables support for FPGA family.
1765 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1766
1767 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001768
wdenk43d96162003-03-06 00:02:04 +00001769 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001770
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001771 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001772
wdenk8bde7f72003-06-27 21:31:46 +00001773 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001774
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001775 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001776
wdenk43d96162003-03-06 00:02:04 +00001777 Enable checks on FPGA configuration interface busy
1778 status by the configuration function. This option
1779 will require a board or device specific function to
1780 be written.
wdenkc6097192002-11-03 00:24:07 +00001781
1782 CONFIG_FPGA_DELAY
1783
1784 If defined, a function that provides delays in the FPGA
1785 configuration driver.
1786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001787 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001788 Allow Control-C to interrupt FPGA configuration
1789
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001790 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001791
wdenk43d96162003-03-06 00:02:04 +00001792 Check for configuration errors during FPGA bitfile
1793 loading. For example, abort during Virtex II
1794 configuration if the INIT_B line goes low (which
1795 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001797 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001798
wdenk43d96162003-03-06 00:02:04 +00001799 Maximum time to wait for the INIT_B line to deassert
1800 after PROB_B has been deasserted during a Virtex II
1801 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001802 ms.
wdenkc6097192002-11-03 00:24:07 +00001803
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001804 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001805
wdenk43d96162003-03-06 00:02:04 +00001806 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001807 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001808
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001809 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001810
wdenk43d96162003-03-06 00:02:04 +00001811 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001812 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001813
1814- Configuration Management:
1815 CONFIG_IDENT_STRING
1816
wdenk43d96162003-03-06 00:02:04 +00001817 If defined, this string will be added to the U-Boot
1818 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001819
1820- Vendor Parameter Protection:
1821
wdenk43d96162003-03-06 00:02:04 +00001822 U-Boot considers the values of the environment
1823 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001824 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001825 are set once by the board vendor / manufacturer, and
1826 protects these variables from casual modification by
1827 the user. Once set, these variables are read-only,
1828 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001829 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001830
1831 If CONFIG_ENV_OVERWRITE is #defined in your config
1832 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001833 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001834 these parameters.
1835
1836 Alternatively, if you #define _both_ CONFIG_ETHADDR
1837 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001838 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001839 which can be changed exactly ONCE by the user. [The
1840 serial# is unaffected by this, i. e. it remains
1841 read-only.]
1842
1843- Protected RAM:
1844 CONFIG_PRAM
1845
1846 Define this variable to enable the reservation of
1847 "protected RAM", i. e. RAM which is not overwritten
1848 by U-Boot. Define CONFIG_PRAM to hold the number of
1849 kB you want to reserve for pRAM. You can overwrite
1850 this default value by defining an environment
1851 variable "pram" to the number of kB you want to
1852 reserve. Note that the board info structure will
1853 still show the full amount of RAM. If pRAM is
1854 reserved, a new environment variable "mem" will
1855 automatically be defined to hold the amount of
1856 remaining RAM in a form that can be passed as boot
1857 argument to Linux, for instance like that:
1858
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001859 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001860 saveenv
1861
1862 This way you can tell Linux not to use this memory,
1863 either, which results in a memory region that will
1864 not be affected by reboots.
1865
1866 *WARNING* If your board configuration uses automatic
1867 detection of the RAM size, you must make sure that
1868 this memory test is non-destructive. So far, the
1869 following board configurations are known to be
1870 "pRAM-clean":
1871
1872 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1873 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001874 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001875
1876- Error Recovery:
1877 CONFIG_PANIC_HANG
1878
1879 Define this variable to stop the system in case of a
1880 fatal error, so that you have to reset it manually.
1881 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001882 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001883 automatically as fast as possible, but it may be
1884 useful during development since you can try to debug
1885 the conditions that lead to the situation.
1886
1887 CONFIG_NET_RETRY_COUNT
1888
wdenk43d96162003-03-06 00:02:04 +00001889 This variable defines the number of retries for
1890 network operations like ARP, RARP, TFTP, or BOOTP
1891 before giving up the operation. If not defined, a
1892 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001893
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001894 CONFIG_ARP_TIMEOUT
1895
1896 Timeout waiting for an ARP reply in milliseconds.
1897
wdenkc6097192002-11-03 00:24:07 +00001898- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001899 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001900
1901 Enable auto completion of commands using TAB.
1902
Wolfgang Denka9398e02006-11-27 15:32:42 +01001903 Note that this feature has NOT been implemented yet
1904 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001905
1906
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001907 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001908
1909 Define this variable to enable the "hush" shell (from
1910 Busybox) as command line interpreter, thus enabling
1911 powerful command line syntax like
1912 if...then...else...fi conditionals or `&&' and '||'
1913 constructs ("shell scripts").
1914
1915 If undefined, you get the old, much simpler behaviour
1916 with a somewhat smaller memory footprint.
1917
1918
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001919 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001920
1921 This defines the secondary prompt string, which is
1922 printed when the command interpreter needs more input
1923 to complete a command. Usually "> ".
1924
1925 Note:
1926
wdenk8bde7f72003-06-27 21:31:46 +00001927 In the current implementation, the local variables
1928 space and global environment variables space are
1929 separated. Local variables are those you define by
1930 simply typing `name=value'. To access a local
1931 variable later on, you have write `$name' or
1932 `${name}'; to execute the contents of a variable
1933 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001934
wdenk43d96162003-03-06 00:02:04 +00001935 Global environment variables are those you use
1936 setenv/printenv to work with. To run a command stored
1937 in such a variable, you need to use the run command,
1938 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001939
1940 To store commands and special characters in a
1941 variable, please use double quotation marks
1942 surrounding the whole text of the variable, instead
1943 of the backslashes before semicolons and special
1944 symbols.
1945
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001946- Commandline Editing and History:
1947 CONFIG_CMDLINE_EDITING
1948
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001949 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001950 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001951
wdenka8c7c702003-12-06 19:49:23 +00001952- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001953 CONFIG_EXTRA_ENV_SETTINGS
1954
wdenk43d96162003-03-06 00:02:04 +00001955 Define this to contain any number of null terminated
1956 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001957 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001958
wdenk43d96162003-03-06 00:02:04 +00001959 For example, place something like this in your
1960 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001961
1962 #define CONFIG_EXTRA_ENV_SETTINGS \
1963 "myvar1=value1\0" \
1964 "myvar2=value2\0"
1965
wdenk43d96162003-03-06 00:02:04 +00001966 Warning: This method is based on knowledge about the
1967 internal format how the environment is stored by the
1968 U-Boot code. This is NOT an official, exported
1969 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001970 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001971 You better know what you are doing here.
1972
wdenk43d96162003-03-06 00:02:04 +00001973 Note: overly (ab)use of the default environment is
1974 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001975 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001976 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001977
wdenka8c7c702003-12-06 19:49:23 +00001978- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001979 CONFIG_HAS_DATAFLASH
1980
wdenk8bde7f72003-06-27 21:31:46 +00001981 Defining this option enables DataFlash features and
1982 allows to read/write in Dataflash via the standard
1983 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001984
wdenk3f85ce22004-02-23 16:11:30 +00001985- SystemACE Support:
1986 CONFIG_SYSTEMACE
1987
1988 Adding this option adds support for Xilinx SystemACE
1989 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001990 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001991 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001992
1993 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001994 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001995
1996 When SystemACE support is added, the "ace" device type
1997 becomes available to the fat commands, i.e. fatls.
1998
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001999- TFTP Fixed UDP Port:
2000 CONFIG_TFTP_PORT
2001
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002002 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002003 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002004 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002005 number generator is used.
2006
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002007 Also, the environment variable tftpdstp is used to supply
2008 the TFTP UDP destination port value. If tftpdstp isn't
2009 defined, the normal port 69 is used.
2010
2011 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002012 blindly start the TFTP transfer using the pre-configured
2013 target IP address and UDP port. This has the effect of
2014 "punching through" the (Windows XP) firewall, allowing
2015 the remainder of the TFTP transfer to proceed normally.
2016 A better solution is to properly configure the firewall,
2017 but sometimes that is not allowed.
2018
wdenka8c7c702003-12-06 19:49:23 +00002019- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002020 CONFIG_SHOW_BOOT_PROGRESS
2021
wdenk43d96162003-03-06 00:02:04 +00002022 Defining this option allows to add some board-
2023 specific code (calling a user-provided function
2024 "show_boot_progress(int)") that enables you to show
2025 the system's boot progress on some display (for
2026 example, some LED's) on your board. At the moment,
2027 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002028
Wolfgang Denk8ae86b72011-02-04 14:25:17 +01002029- Standalone program support:
2030 CONFIG_STANDALONE_LOAD_ADDR
2031
2032 This option allows to define board specific values
2033 for the address where standalone program gets loaded,
2034 thus overwriting the architecutre dependent default
2035 settings.
2036
Minkyu Kangd32a1a42011-04-24 22:22:34 +00002037- Frame Buffer Address:
2038 CONFIG_FB_ADDR
2039
2040 Define CONFIG_FB_ADDR if you want to use specific address for
2041 frame buffer.
2042 Then system will reserve the frame buffer address to defined address
2043 instead of lcd_setmem (this function grab the memory for frame buffer
2044 by panel's size).
2045
2046 Please see board_init_f function.
2047
2048 If you want this config option then,
2049 please define it at your board config file
2050
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002051Legacy uImage format:
2052
wdenkc6097192002-11-03 00:24:07 +00002053 Arg Where When
2054 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002055 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002056 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002057 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002058 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002059 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002060 4 common/cmd_bootm.c Image data has correct checksum
2061 -4 common/cmd_bootm.c Image is for unsupported architecture
2062 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002063 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002064 6 common/cmd_bootm.c Image Type check OK
2065 -6 common/cmd_bootm.c gunzip uncompression error
2066 -7 common/cmd_bootm.c Unimplemented compression type
2067 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002068 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002069 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002070
2071 9 common/image.c Start initial ramdisk verification
2072 -10 common/image.c Ramdisk header has bad magic number
2073 -11 common/image.c Ramdisk header has bad checksum
2074 10 common/image.c Ramdisk header is OK
2075 -12 common/image.c Ramdisk data has bad checksum
2076 11 common/image.c Ramdisk data has correct checksum
2077 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002078 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002079 13 common/image.c Start multifile image verification
2080 14 common/image.c No initial ramdisk, no multifile, continue.
2081
Peter Tyserea0364f2010-04-12 22:28:04 -05002082 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002083
Stefan Roesea47a12b2010-04-15 16:07:28 +02002084 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002085 -31 post/post.c POST test failed, detected by post_output_backlog()
2086 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002087
Heiko Schocher566a4942007-06-22 19:11:54 +02002088 34 common/cmd_doc.c before loading a Image from a DOC device
2089 -35 common/cmd_doc.c Bad usage of "doc" command
2090 35 common/cmd_doc.c correct usage of "doc" command
2091 -36 common/cmd_doc.c No boot device
2092 36 common/cmd_doc.c correct boot device
2093 -37 common/cmd_doc.c Unknown Chip ID on boot device
2094 37 common/cmd_doc.c correct chip ID found, device available
2095 -38 common/cmd_doc.c Read Error on boot device
2096 38 common/cmd_doc.c reading Image header from DOC device OK
2097 -39 common/cmd_doc.c Image header has bad magic number
2098 39 common/cmd_doc.c Image header has correct magic number
2099 -40 common/cmd_doc.c Error reading Image from DOC device
2100 40 common/cmd_doc.c Image header has correct magic number
2101 41 common/cmd_ide.c before loading a Image from a IDE device
2102 -42 common/cmd_ide.c Bad usage of "ide" command
2103 42 common/cmd_ide.c correct usage of "ide" command
2104 -43 common/cmd_ide.c No boot device
2105 43 common/cmd_ide.c boot device found
2106 -44 common/cmd_ide.c Device not available
2107 44 common/cmd_ide.c Device available
2108 -45 common/cmd_ide.c wrong partition selected
2109 45 common/cmd_ide.c partition selected
2110 -46 common/cmd_ide.c Unknown partition table
2111 46 common/cmd_ide.c valid partition table found
2112 -47 common/cmd_ide.c Invalid partition type
2113 47 common/cmd_ide.c correct partition type
2114 -48 common/cmd_ide.c Error reading Image Header on boot device
2115 48 common/cmd_ide.c reading Image Header from IDE device OK
2116 -49 common/cmd_ide.c Image header has bad magic number
2117 49 common/cmd_ide.c Image header has correct magic number
2118 -50 common/cmd_ide.c Image header has bad checksum
2119 50 common/cmd_ide.c Image header has correct checksum
2120 -51 common/cmd_ide.c Error reading Image from IDE device
2121 51 common/cmd_ide.c reading Image from IDE device OK
2122 52 common/cmd_nand.c before loading a Image from a NAND device
2123 -53 common/cmd_nand.c Bad usage of "nand" command
2124 53 common/cmd_nand.c correct usage of "nand" command
2125 -54 common/cmd_nand.c No boot device
2126 54 common/cmd_nand.c boot device found
2127 -55 common/cmd_nand.c Unknown Chip ID on boot device
2128 55 common/cmd_nand.c correct chip ID found, device available
2129 -56 common/cmd_nand.c Error reading Image Header on boot device
2130 56 common/cmd_nand.c reading Image Header from NAND device OK
2131 -57 common/cmd_nand.c Image header has bad magic number
2132 57 common/cmd_nand.c Image header has correct magic number
2133 -58 common/cmd_nand.c Error reading Image from NAND device
2134 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002135
Heiko Schocher566a4942007-06-22 19:11:54 +02002136 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002137
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002138 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002139 -64 net/eth.c no Ethernet found.
2140 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002141
Heiko Schocher566a4942007-06-22 19:11:54 +02002142 -80 common/cmd_net.c usage wrong
2143 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002144 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002145 81 common/cmd_net.c NetLoop() back without error
2146 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2147 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002148 83 common/cmd_net.c running "source" command
2149 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002150 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002151
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002152FIT uImage format:
2153
2154 Arg Where When
2155 100 common/cmd_bootm.c Kernel FIT Image has correct format
2156 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2157 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2158 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2159 102 common/cmd_bootm.c Kernel unit name specified
2160 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002161 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002162 104 common/cmd_bootm.c Got kernel subimage node offset
2163 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2164 105 common/cmd_bootm.c Kernel subimage hash verification OK
2165 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2166 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002167 -106 common/cmd_bootm.c Kernel subimage has wrong type
2168 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002169 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2170 108 common/cmd_bootm.c Got kernel subimage data/size
2171 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2172 -109 common/cmd_bootm.c Can't get kernel subimage type
2173 -110 common/cmd_bootm.c Can't get kernel subimage comp
2174 -111 common/cmd_bootm.c Can't get kernel subimage os
2175 -112 common/cmd_bootm.c Can't get kernel subimage load address
2176 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2177
2178 120 common/image.c Start initial ramdisk verification
2179 -120 common/image.c Ramdisk FIT image has incorrect format
2180 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002181 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002182 -122 common/image.c Can't get configuration for ramdisk subimage
2183 123 common/image.c Ramdisk unit name specified
2184 -124 common/image.c Can't get ramdisk subimage node offset
2185 125 common/image.c Got ramdisk subimage node offset
2186 -125 common/image.c Ramdisk subimage hash verification failed
2187 126 common/image.c Ramdisk subimage hash verification OK
2188 -126 common/image.c Ramdisk subimage for unsupported architecture
2189 127 common/image.c Architecture check OK
2190 -127 common/image.c Can't get ramdisk subimage data/size
2191 128 common/image.c Got ramdisk subimage data/size
2192 129 common/image.c Can't get ramdisk load address
2193 -129 common/image.c Got ramdisk load address
2194
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002195 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002196 131 common/cmd_doc.c FIT image format OK
2197
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002198 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002199 141 common/cmd_ide.c FIT image format OK
2200
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002201 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002202 151 common/cmd_nand.c FIT image format OK
2203
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002204- Automatic software updates via TFTP server
2205 CONFIG_UPDATE_TFTP
2206 CONFIG_UPDATE_TFTP_CNT_MAX
2207 CONFIG_UPDATE_TFTP_MSEC_MAX
2208
2209 These options enable and control the auto-update feature;
2210 for a more detailed description refer to doc/README.update.
2211
2212- MTD Support (mtdparts command, UBI support)
2213 CONFIG_MTD_DEVICE
2214
2215 Adds the MTD device infrastructure from the Linux kernel.
2216 Needed for mtdparts command support.
2217
2218 CONFIG_MTD_PARTITIONS
2219
2220 Adds the MTD partitioning infrastructure from the Linux
2221 kernel. Needed for UBI support.
2222
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002223
wdenkc6097192002-11-03 00:24:07 +00002224Modem Support:
2225--------------
2226
wdenk85ec0bc2003-03-31 16:34:49 +00002227[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002228
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002229- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002230 CONFIG_MODEM_SUPPORT
2231
2232- RTS/CTS Flow control enable:
2233 CONFIG_HWFLOW
2234
2235- Modem debug support:
2236 CONFIG_MODEM_SUPPORT_DEBUG
2237
wdenk43d96162003-03-06 00:02:04 +00002238 Enables debugging stuff (char screen[1024], dbg())
2239 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002240
wdenka8c7c702003-12-06 19:49:23 +00002241- Interrupt support (PPC):
2242
wdenkd4ca31c2004-01-02 14:00:00 +00002243 There are common interrupt_init() and timer_interrupt()
2244 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002245 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002246 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002247 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002248 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002249 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002250 specific handling. If board has watchdog / status_led
2251 / other_activity_monitor it works automatically from
2252 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002253
wdenkc6097192002-11-03 00:24:07 +00002254- General:
2255
wdenk43d96162003-03-06 00:02:04 +00002256 In the target system modem support is enabled when a
2257 specific key (key combination) is pressed during
2258 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002259 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002260 board_init(). Currently key_pressed() is a dummy
2261 function, returning 1 and thus enabling modem
2262 initialization.
wdenkc6097192002-11-03 00:24:07 +00002263
wdenk43d96162003-03-06 00:02:04 +00002264 If there are no modem init strings in the
2265 environment, U-Boot proceed to autoboot; the
2266 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002267 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002268
2269 See also: doc/README.Modem
2270
2271
wdenkc6097192002-11-03 00:24:07 +00002272Configuration Settings:
2273-----------------------
2274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002275- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002276 undefine this when you're short of memory.
2277
Peter Tyser2fb26042009-01-27 18:03:12 -06002278- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2279 width of the commands listed in the 'help' command output.
2280
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002281- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002282 prompt for user input.
2283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002284- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002286- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002287
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002288- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002289
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002290- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002291 the application (usually a Linux kernel) when it is
2292 booted
2293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002294- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002295 List of legal baudrate settings for this board.
2296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002297- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002298 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002299
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002300- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002301 If the board specific function
2302 extern int overwrite_console (void);
2303 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002304 serial port, else the settings in the environment are used.
2305
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002306- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002307 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002309- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002310 Enable overwrite of previous console environment settings.
2311
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002312- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002313 Begin and End addresses of the area used by the
2314 simple memory test.
2315
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002316- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002317 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002318
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002319- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002320 Scratch address used by the alternate memory test
2321 You only need to set this if address zero isn't writeable
2322
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002323- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2324 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002325 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002326 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002327 fixing up gd->ram_size the Linux kernel should gets passed
2328 the now "corrected" memory size and won't touch it either.
2329 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002330 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002331 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002332 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002333
2334 This option can be used as a workaround for the 440EPx/GRx
2335 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2336 be touched.
2337
2338 WARNING: Please make sure that this value is a multiple of
2339 the Linux page size (normally 4k). If this is not the case,
2340 then the end address of the Linux memory will be located at a
2341 non page size aligned address and this could cause major
2342 problems.
2343
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002344- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002345 Default load address for network file downloads
2346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002347- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002348 Enable temporary baudrate change while serial download
2349
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002350- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002351 Physical start address of SDRAM. _Must_ be 0 here.
2352
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002353- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002354 Physical start address of Motherboard I/O (if using a
2355 Cogent motherboard)
2356
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002357- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002358 Physical start address of Flash memory.
2359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002360- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002361 Physical start address of boot monitor code (set by
2362 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002363 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002364 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002366- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002367 Size of memory reserved for monitor code, used to
2368 determine _at_compile_time_ (!) if the environment is
2369 embedded within the U-Boot image, or in a separate
2370 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002371
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002372- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002373 Size of DRAM reserved for malloc() use.
2374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002375- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002376 Normally compressed uImages are limited to an
2377 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002378 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002379 to adjust this setting to your needs.
2380
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002381- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002382 Maximum size of memory mapped by the startup code of
2383 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002384 the Linux kernel (bd_info, boot arguments, FDT blob if
2385 used) must be put below this limit, unless "bootm_low"
2386 enviroment variable is defined and non-zero. In such case
2387 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002388 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2389 variable "bootm_mapsize" will override the value of
2390 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2391 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002392
John Rigbyfca43cc2010-10-13 13:57:35 -06002393- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2394 Enable initrd_high functionality. If defined then the
2395 initrd_high feature is enabled and the bootm ramdisk subcommand
2396 is enabled.
2397
2398- CONFIG_SYS_BOOT_GET_CMDLINE:
2399 Enables allocating and saving kernel cmdline in space between
2400 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2401
2402- CONFIG_SYS_BOOT_GET_KBD:
2403 Enables allocating and saving a kernel copy of the bd_info in
2404 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2405
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002406- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002407 Max number of Flash memory banks
2408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002410 Max number of sectors on a Flash chip
2411
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002412- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002413 Timeout for Flash erase operations (in ms)
2414
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002415- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002416 Timeout for Flash write operations (in ms)
2417
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002418- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002419 Timeout for Flash set sector lock bit operation (in ms)
2420
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002421- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002422 Timeout for Flash clear lock bits operation (in ms)
2423
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002424- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002425 If defined, hardware flash sectors protection is used
2426 instead of U-Boot software protection.
2427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002428- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002429
2430 Enable TFTP transfers directly to flash memory;
2431 without this option such a download has to be
2432 performed in two steps: (1) download to RAM, and (2)
2433 copy from RAM to flash.
2434
2435 The two-step approach is usually more reliable, since
2436 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002437 the flash, but in some situations (when system RAM is
2438 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002439 downloaded image) this option may be very useful.
2440
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002441- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002442 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002443 common flash structure for storing flash geometry.
2444
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002445- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002446 This option also enables the building of the cfi_flash driver
2447 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002448
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002449- CONFIG_FLASH_CFI_MTD
2450 This option enables the building of the cfi_mtd driver
2451 in the drivers directory. The driver exports CFI flash
2452 to the MTD layer.
2453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002454- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002455 Use buffered writes to flash.
2456
2457- CONFIG_FLASH_SPANSION_S29WS_N
2458 s29ws-n MirrorBit flash has non-standard addresses for buffered
2459 write commands.
2460
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002461- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002462 If this option is defined, the common CFI flash doesn't
2463 print it's warning upon not recognized FLASH banks. This
2464 is useful, if some of the configured banks are only
2465 optionally available.
2466
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002467- CONFIG_FLASH_SHOW_PROGRESS
2468 If defined (must be an integer), print out countdown
2469 digits and dots. Recommended value: 45 (9..1) for 80
2470 column displays, 15 (3..1) for 40 column displays.
2471
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002472- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002473 Defines the number of Ethernet receive buffers. On some
2474 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002475 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2476 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002477 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002478 Defaults to 4 if not defined.
2479
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002480- CONFIG_ENV_MAX_ENTRIES
2481
Wolfgang Denk071bc922010-10-27 22:48:30 +02002482 Maximum number of entries in the hash table that is used
2483 internally to store the environment settings. The default
2484 setting is supposed to be generous and should work in most
2485 cases. This setting can be used to tune behaviour; see
2486 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002487
wdenkc6097192002-11-03 00:24:07 +00002488The following definitions that deal with the placement and management
2489of environment data (variable area); in general, we support the
2490following configurations:
2491
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002492- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002493
2494 Define this if the environment is in flash memory.
2495
2496 a) The environment occupies one whole flash sector, which is
2497 "embedded" in the text segment with the U-Boot code. This
2498 happens usually with "bottom boot sector" or "top boot
2499 sector" type flash chips, which have several smaller
2500 sectors at the start or the end. For instance, such a
2501 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2502 such a case you would place the environment in one of the
2503 4 kB sectors - with U-Boot code before and after it. With
2504 "top boot sector" type flash chips, you would put the
2505 environment in one of the last sectors, leaving a gap
2506 between U-Boot and the environment.
2507
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002508 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002509
2510 Offset of environment data (variable area) to the
2511 beginning of flash memory; for instance, with bottom boot
2512 type flash chips the second sector can be used: the offset
2513 for this sector is given here.
2514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002515 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002516
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002517 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002518
2519 This is just another way to specify the start address of
2520 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002521 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002522
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002523 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002524
2525 Size of the sector containing the environment.
2526
2527
2528 b) Sometimes flash chips have few, equal sized, BIG sectors.
2529 In such a case you don't want to spend a whole sector for
2530 the environment.
2531
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002532 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002533
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002534 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002535 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002536 of this flash sector for the environment. This saves
2537 memory for the RAM copy of the environment.
2538
2539 It may also save flash memory if you decide to use this
2540 when your environment is "embedded" within U-Boot code,
2541 since then the remainder of the flash sector could be used
2542 for U-Boot code. It should be pointed out that this is
2543 STRONGLY DISCOURAGED from a robustness point of view:
2544 updating the environment in flash makes it always
2545 necessary to erase the WHOLE sector. If something goes
2546 wrong before the contents has been restored from a copy in
2547 RAM, your target system will be dead.
2548
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002549 - CONFIG_ENV_ADDR_REDUND
2550 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002551
wdenk43d96162003-03-06 00:02:04 +00002552 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002553 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002554 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002555 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002556
2557BE CAREFUL! Any changes to the flash layout, and some changes to the
2558source code will make it necessary to adapt <board>/u-boot.lds*
2559accordingly!
2560
2561
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002562- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002563
2564 Define this if you have some non-volatile memory device
2565 (NVRAM, battery buffered SRAM) which you want to use for the
2566 environment.
2567
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002568 - CONFIG_ENV_ADDR:
2569 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002570
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002571 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002572 want to use for environment. It is assumed that this memory
2573 can just be read and written to, without any special
2574 provision.
2575
2576BE CAREFUL! The first access to the environment happens quite early
2577in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002578console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002579U-Boot will hang.
2580
2581Please note that even with NVRAM we still use a copy of the
2582environment in RAM: we could work on NVRAM directly, but we want to
2583keep settings there always unmodified except somebody uses "saveenv"
2584to save the current settings.
2585
2586
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002587- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002588
2589 Use this if you have an EEPROM or similar serial access
2590 device and a driver for it.
2591
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002592 - CONFIG_ENV_OFFSET:
2593 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002594
2595 These two #defines specify the offset and size of the
2596 environment area within the total memory of your EEPROM.
2597
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002598 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002599 If defined, specified the chip address of the EEPROM device.
2600 The default address is zero.
2601
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002602 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002603 If defined, the number of bits used to address bytes in a
2604 single page in the EEPROM device. A 64 byte page, for example
2605 would require six bits.
2606
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002607 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002608 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002609 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002611 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002612 The length in bytes of the EEPROM memory array address. Note
2613 that this is NOT the chip address length!
2614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002615 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002616 EEPROM chips that implement "address overflow" are ones
2617 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2618 address and the extra bits end up in the "chip address" bit
2619 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2620 byte chips.
2621
2622 Note that we consider the length of the address field to
2623 still be one byte because the extra address bits are hidden
2624 in the chip address.
2625
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002626 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002627 The size in bytes of the EEPROM device.
2628
Heiko Schocher548738b2010-01-07 08:55:40 +01002629 - CONFIG_ENV_EEPROM_IS_ON_I2C
2630 define this, if you have I2C and SPI activated, and your
2631 EEPROM, which holds the environment, is on the I2C bus.
2632
2633 - CONFIG_I2C_ENV_EEPROM_BUS
2634 if you have an Environment on an EEPROM reached over
2635 I2C muxes, you can define here, how to reach this
2636 EEPROM. For example:
2637
Wolfgang Denka9046b92010-06-13 17:48:15 +02002638 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002639
2640 EEPROM which holds the environment, is reached over
2641 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002642
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002643- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002644
wdenkd4ca31c2004-01-02 14:00:00 +00002645 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002646 want to use for the environment.
2647
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002648 - CONFIG_ENV_OFFSET:
2649 - CONFIG_ENV_ADDR:
2650 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002651
2652 These three #defines specify the offset and size of the
2653 environment area within the total memory of your DataFlash placed
2654 at the specified address.
2655
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002656- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002657
2658 Define this if you have a NAND device which you want to use
2659 for the environment.
2660
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002661 - CONFIG_ENV_OFFSET:
2662 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002663
2664 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002665 area within the first NAND device. CONFIG_ENV_OFFSET must be
2666 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002667
Scott Woodfdd813d2010-09-17 14:38:37 -05002668 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002669
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002670 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002671 size used to hold a redundant copy of the environment data, so
2672 that there is a valid backup copy in case there is a power failure
2673 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2674 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002675
Scott Woodfdd813d2010-09-17 14:38:37 -05002676 - CONFIG_ENV_RANGE (optional):
2677
2678 Specifies the length of the region in which the environment
2679 can be written. This should be a multiple of the NAND device's
2680 block size. Specifying a range with more erase blocks than
2681 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2682 the range to be avoided.
2683
2684 - CONFIG_ENV_OFFSET_OOB (optional):
2685
2686 Enables support for dynamically retrieving the offset of the
2687 environment from block zero's out-of-band data. The
2688 "nand env.oob" command can be used to record this offset.
2689 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2690 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002691
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002692- CONFIG_NAND_ENV_DST
2693
2694 Defines address in RAM to which the nand_spl code should copy the
2695 environment. If redundant environment is used, it will be copied to
2696 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2697
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002698- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002699
2700 Defines offset to the initial SPI buffer area in DPRAM. The
2701 area is used at an early stage (ROM part) if the environment
2702 is configured to reside in the SPI EEPROM: We need a 520 byte
2703 scratch DPRAM area. It is used between the two initialization
2704 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2705 to be a good choice since it makes it far enough from the
2706 start of the data area as well as from the stack pointer.
2707
Bruce Adlere881cb52007-11-02 13:15:42 -07002708Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002709has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002710created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002711until then to read environment variables.
2712
wdenk85ec0bc2003-03-31 16:34:49 +00002713The environment is protected by a CRC32 checksum. Before the monitor
2714is relocated into RAM, as a result of a bad CRC you will be working
2715with the compiled-in default environment - *silently*!!! [This is
2716necessary, because the first environment variable we need is the
2717"baudrate" setting for the console - if we have a bad CRC, we don't
2718have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002719
2720Note: once the monitor has been relocated, then it will complain if
2721the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002722use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002723
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002724- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002725 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002727 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002728 also needs to be defined.
2729
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002730- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002731 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002732
Ron Madridf5675aa2009-02-18 14:30:44 -08002733- CONFIG_NS16550_MIN_FUNCTIONS:
2734 Define this if you desire to only have use of the NS16550_init
2735 and NS16550_putc functions for the serial driver located at
2736 drivers/serial/ns16550.c. This option is useful for saving
2737 space for already greatly restricted images, including but not
2738 limited to NAND_SPL configurations.
2739
wdenkc6097192002-11-03 00:24:07 +00002740Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002741---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002743- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002744 Cache Line Size of the CPU.
2745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002746- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002747 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002748
wdenk42d1f032003-10-15 23:53:47 +00002749 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2750 and RPXsuper) to be able to adjust the position of
2751 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002752
wdenk7f6c2cb2002-11-10 22:06:23 +00002753- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002754 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002755
2756 the default drive number (default value 0)
2757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002758 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002759
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002760 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002761 (default value 1)
2762
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002763 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002764
wdenk43d96162003-03-06 00:02:04 +00002765 defines the offset of register from address. It
2766 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002767 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002769 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2770 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002771 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002772
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002773 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002774 fdc_hw_init() is called at the beginning of the FDC
2775 setup. fdc_hw_init() must be provided by the board
2776 source code. It is used to make hardware dependant
2777 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002778
Macpaul Lin0abddf82011-04-11 20:45:32 +00002779- CONFIG_IDE_AHB:
2780 Most IDE controllers were designed to be connected with PCI
2781 interface. Only few of them were designed for AHB interface.
2782 When software is doing ATA command and data transfer to
2783 IDE devices through IDE-AHB controller, some additional
2784 registers accessing to these kind of IDE-AHB controller
2785 is requierd.
2786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002787- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002788 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002789 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002790
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002791- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002792
wdenk7152b1d2003-09-05 23:19:14 +00002793 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002794 initial data and stack; please note that this must be
2795 writable memory that is working WITHOUT special
2796 initialization, i. e. you CANNOT use normal RAM which
2797 will become available only after programming the
2798 memory controller and running certain initialization
2799 sequences.
2800
2801 U-Boot uses the following memory types:
2802 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2803 - MPC824X: data cache
2804 - PPC4xx: data cache
2805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002806- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002807
2808 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002809 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2810 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002811 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002812 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002813 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2814 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2815 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002816
2817 Note:
2818 On the MPC824X (or other systems that use the data
2819 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002820 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002821 point to an otherwise UNUSED address space between
2822 the top of RAM and the start of the PCI space.
2823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002824- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002825
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002826- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002827
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002828- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002829
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002830- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002832- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002833
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002834- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002836- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002837 SDRAM timing
2838
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002839- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002840 periodic timer for refresh
2841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002842- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002844- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2845 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2846 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2847 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002848 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2849
2850- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002851 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2852 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002853 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2854
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002855- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2856 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002857 Machine Mode Register and Memory Periodic Timer
2858 Prescaler definitions (SDRAM timing)
2859
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002860- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002861 enable I2C microcode relocation patch (MPC8xx);
2862 define relocation offset in DPRAM [DSP2]
2863
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002864- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002865 enable SMC microcode relocation patch (MPC8xx);
2866 define relocation offset in DPRAM [SMC1]
2867
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002868- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002869 enable SPI microcode relocation patch (MPC8xx);
2870 define relocation offset in DPRAM [SCC4]
2871
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002872- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002873 Use OSCM clock mode on MBX8xx board. Be careful,
2874 wrong setting might damage your board. Read
2875 doc/README.MBX before setting this variable!
2876
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002877- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002878 Offset of the bootmode word in DPRAM used by post
2879 (Power On Self Tests). This definition overrides
2880 #define'd default value in commproc.h resp.
2881 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002882
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002883- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2884 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2885 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2886 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2887 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2888 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2889 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2890 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02002891 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00002892
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002893- CONFIG_PCI_DISABLE_PCIE:
2894 Disable PCI-Express on systems where it is supported but not
2895 required.
2896
Kumar Galaa09b9b62010-12-30 12:09:53 -06002897- CONFIG_SYS_SRIO:
2898 Chip has SRIO or not
2899
2900- CONFIG_SRIO1:
2901 Board has SRIO 1 port available
2902
2903- CONFIG_SRIO2:
2904 Board has SRIO 2 port available
2905
2906- CONFIG_SYS_SRIOn_MEM_VIRT:
2907 Virtual Address of SRIO port 'n' memory region
2908
2909- CONFIG_SYS_SRIOn_MEM_PHYS:
2910 Physical Address of SRIO port 'n' memory region
2911
2912- CONFIG_SYS_SRIOn_MEM_SIZE:
2913 Size of SRIO port 'n' memory region
2914
Ben Warrenbb99ad62006-09-07 16:50:54 -04002915- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002916 Get DDR timing information from an I2C EEPROM. Common
2917 with pluggable memory modules such as SODIMMs
2918
Ben Warrenbb99ad62006-09-07 16:50:54 -04002919 SPD_EEPROM_ADDRESS
2920 I2C address of the SPD EEPROM
2921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002922- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002923 If SPD EEPROM is on an I2C bus other than the first
2924 one, specify here. Note that the value must resolve
2925 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002926
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002927- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002928 Only for 83xx systems. If specified, then DDR should
2929 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002930
wdenkc26e4542004-04-18 10:13:26 +00002931- CONFIG_ETHER_ON_FEC[12]
2932 Define to enable FEC[12] on a 8xx series processor.
2933
2934- CONFIG_FEC[12]_PHY
2935 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002936 to the given FEC; i. e.
2937 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002938 means that the PHY with address 4 is connected to FEC1
2939
2940 When set to -1, means to probe for first available.
2941
2942- CONFIG_FEC[12]_PHY_NORXERR
2943 The PHY does not have a RXERR line (RMII only).
2944 (so program the FEC to ignore it).
2945
2946- CONFIG_RMII
2947 Enable RMII mode for all FECs.
2948 Note that this is a global option, we can't
2949 have one FEC in standard MII mode and another in RMII mode.
2950
wdenk5cf91d62004-04-23 20:32:05 +00002951- CONFIG_CRC32_VERIFY
2952 Add a verify option to the crc32 command.
2953 The syntax is:
2954
2955 => crc32 -v <address> <count> <crc32>
2956
2957 Where address/count indicate a memory area
2958 and crc32 is the correct crc32 which the
2959 area should have.
2960
wdenk56523f12004-07-11 17:40:54 +00002961- CONFIG_LOOPW
2962 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002963 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002964
stroese7b466642004-12-16 18:46:55 +00002965- CONFIG_MX_CYCLIC
2966 Add the "mdc" and "mwc" memory commands. These are cyclic
2967 "md/mw" commands.
2968 Examples:
2969
wdenkefe2a4d2004-12-16 21:44:03 +00002970 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002971 This command will print 4 bytes (10,11,12,13) each 500 ms.
2972
wdenkefe2a4d2004-12-16 21:44:03 +00002973 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002974 This command will write 12345678 to address 100 all 10 ms.
2975
wdenkefe2a4d2004-12-16 21:44:03 +00002976 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002977 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002978
wdenk8aa1a2d2005-04-04 12:44:11 +00002979- CONFIG_SKIP_LOWLEVEL_INIT
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002980 [ARM only] If this variable is defined, then certain
2981 low level initializations (like setting up the memory
2982 controller) are omitted and/or U-Boot does not
2983 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00002984
Wolfgang Denk844f07d2010-11-27 23:30:56 +01002985 Normally this variable MUST NOT be defined. The only
2986 exception is when U-Boot is loaded (to RAM) by some
2987 other boot loader or by a debugger which performs
2988 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002989
Magnus Liljadf812382009-06-13 20:50:00 +02002990- CONFIG_PRELOADER
Magnus Liljadf812382009-06-13 20:50:00 +02002991 Modifies the behaviour of start.S when compiling a loader
2992 that is executed before the actual U-Boot. E.g. when
2993 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002994
Matthias Weisserd8834a12011-03-10 21:36:32 +00002995- CONFIG_USE_ARCH_MEMCPY
2996 CONFIG_USE_ARCH_MEMSET
2997 If these options are used a optimized version of memcpy/memset will
2998 be used if available. These functions may be faster under some
2999 conditions but may increase the binary size.
3000
wdenkc6097192002-11-03 00:24:07 +00003001Building the Software:
3002======================
3003
Wolfgang Denk218ca722008-03-26 10:40:12 +01003004Building U-Boot has been tested in several native build environments
3005and in many different cross environments. Of course we cannot support
3006all possibly existing versions of cross development tools in all
3007(potentially obsolete) versions. In case of tool chain problems we
3008recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3009which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003010
Wolfgang Denk218ca722008-03-26 10:40:12 +01003011If you are not using a native environment, it is assumed that you
3012have GNU cross compiling tools available in your path. In this case,
3013you must set the environment variable CROSS_COMPILE in your shell.
3014Note that no changes to the Makefile or any other source files are
3015necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003016
Wolfgang Denk218ca722008-03-26 10:40:12 +01003017 $ CROSS_COMPILE=ppc_4xx-
3018 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003019
Peter Tyser2f8d3962009-03-13 18:54:51 -05003020Note: If you wish to generate Windows versions of the utilities in
3021 the tools directory you can use the MinGW toolchain
3022 (http://www.mingw.org). Set your HOST tools to the MinGW
3023 toolchain and execute 'make tools'. For example:
3024
3025 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3026
3027 Binaries such as tools/mkimage.exe will be created which can
3028 be executed on computers running Windows.
3029
Wolfgang Denk218ca722008-03-26 10:40:12 +01003030U-Boot is intended to be simple to build. After installing the
3031sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003032is done by typing:
3033
3034 make NAME_config
3035
Wolfgang Denk218ca722008-03-26 10:40:12 +01003036where "NAME_config" is the name of one of the existing configu-
3037rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003038
wdenk2729af92004-05-03 20:45:30 +00003039Note: for some board special configuration names may exist; check if
3040 additional information is available from the board vendor; for
3041 instance, the TQM823L systems are available without (standard)
3042 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003043 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003044
wdenk2729af92004-05-03 20:45:30 +00003045 make TQM823L_config
3046 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003047
wdenk2729af92004-05-03 20:45:30 +00003048 make TQM823L_LCD_config
3049 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003050
wdenk2729af92004-05-03 20:45:30 +00003051 etc.
wdenkc6097192002-11-03 00:24:07 +00003052
wdenkc6097192002-11-03 00:24:07 +00003053
wdenk2729af92004-05-03 20:45:30 +00003054Finally, type "make all", and you should get some working U-Boot
3055images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003056
wdenk2729af92004-05-03 20:45:30 +00003057- "u-boot.bin" is a raw binary image
3058- "u-boot" is an image in ELF binary format
3059- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003060
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003061By default the build is performed locally and the objects are saved
3062in the source directory. One of the two methods can be used to change
3063this behavior and build U-Boot to some external directory:
3064
30651. Add O= to the make command line invocations:
3066
3067 make O=/tmp/build distclean
3068 make O=/tmp/build NAME_config
3069 make O=/tmp/build all
3070
30712. Set environment variable BUILD_DIR to point to the desired location:
3072
3073 export BUILD_DIR=/tmp/build
3074 make distclean
3075 make NAME_config
3076 make all
3077
3078Note that the command line "O=" setting overrides the BUILD_DIR environment
3079variable.
3080
wdenkc6097192002-11-03 00:24:07 +00003081
wdenk2729af92004-05-03 20:45:30 +00003082Please be aware that the Makefiles assume you are using GNU make, so
3083for instance on NetBSD you might need to use "gmake" instead of
3084native "make".
wdenkc6097192002-11-03 00:24:07 +00003085
wdenkc6097192002-11-03 00:24:07 +00003086
wdenk2729af92004-05-03 20:45:30 +00003087If the system board that you have is not listed, then you will need
3088to port U-Boot to your hardware platform. To do this, follow these
3089steps:
wdenkc6097192002-11-03 00:24:07 +00003090
wdenk2729af92004-05-03 20:45:30 +000030911. Add a new configuration option for your board to the toplevel
3092 "Makefile" and to the "MAKEALL" script, using the existing
3093 entries as examples. Note that here and at many other places
3094 boards and other names are listed in alphabetical sort order. Please
3095 keep this order.
30962. Create a new directory to hold your board specific code. Add any
3097 files you need. In your board directory, you will need at least
3098 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
30993. Create a new configuration file "include/configs/<board>.h" for
3100 your board
31013. If you're porting U-Boot to a new CPU, then also create a new
3102 directory to hold your CPU specific code. Add any files you need.
31034. Run "make <board>_config" with your new name.
31045. Type "make", and you should get a working "u-boot.srec" file
3105 to be installed on your target system.
31066. Debug and solve any problems that might arise.
3107 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003108
wdenkc6097192002-11-03 00:24:07 +00003109
wdenk2729af92004-05-03 20:45:30 +00003110Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3111==============================================================
wdenkc6097192002-11-03 00:24:07 +00003112
Wolfgang Denk218ca722008-03-26 10:40:12 +01003113If you have modified U-Boot sources (for instance added a new board
3114or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003115provide feedback to the other developers. The feedback normally takes
3116the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003117official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003118
Wolfgang Denk218ca722008-03-26 10:40:12 +01003119But before you submit such a patch, please verify that your modifi-
3120cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003121the supported boards compile WITHOUT ANY compiler warnings. To do so,
3122just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003123for ALL supported system. Be warned, this will take a while. You can
3124select which (cross) compiler to use by passing a `CROSS_COMPILE'
3125environment variable to the script, i. e. to use the ELDK cross tools
3126you can type
wdenkc6097192002-11-03 00:24:07 +00003127
wdenk2729af92004-05-03 20:45:30 +00003128 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003129
wdenk2729af92004-05-03 20:45:30 +00003130or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003131
wdenk2729af92004-05-03 20:45:30 +00003132 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003133
Wolfgang Denk218ca722008-03-26 10:40:12 +01003134When using the MAKEALL script, the default behaviour is to build
3135U-Boot in the source directory. This location can be changed by
3136setting the BUILD_DIR environment variable. Also, for each target
3137built, the MAKEALL script saves two log files (<target>.ERR and
3138<target>.MAKEALL) in the <source dir>/LOG directory. This default
3139location can be changed by setting the MAKEALL_LOGDIR environment
3140variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003141
3142 export BUILD_DIR=/tmp/build
3143 export MAKEALL_LOGDIR=/tmp/log
3144 CROSS_COMPILE=ppc_8xx- MAKEALL
3145
Wolfgang Denk218ca722008-03-26 10:40:12 +01003146With the above settings build objects are saved in the /tmp/build,
3147log files are saved in the /tmp/log and the source tree remains clean
3148during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003149
3150
wdenk2729af92004-05-03 20:45:30 +00003151See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003152
wdenkc6097192002-11-03 00:24:07 +00003153
wdenk2729af92004-05-03 20:45:30 +00003154Monitor Commands - Overview:
3155============================
wdenkc6097192002-11-03 00:24:07 +00003156
wdenk2729af92004-05-03 20:45:30 +00003157go - start application at address 'addr'
3158run - run commands in an environment variable
3159bootm - boot application image from memory
3160bootp - boot image via network using BootP/TFTP protocol
3161tftpboot- boot image via network using TFTP protocol
3162 and env variables "ipaddr" and "serverip"
3163 (and eventually "gatewayip")
3164rarpboot- boot image via network using RARP/TFTP protocol
3165diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3166loads - load S-Record file over serial line
3167loadb - load binary file over serial line (kermit mode)
3168md - memory display
3169mm - memory modify (auto-incrementing)
3170nm - memory modify (constant address)
3171mw - memory write (fill)
3172cp - memory copy
3173cmp - memory compare
3174crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003175i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003176sspi - SPI utility commands
3177base - print or set address offset
3178printenv- print environment variables
3179setenv - set environment variables
3180saveenv - save environment variables to persistent storage
3181protect - enable or disable FLASH write protection
3182erase - erase FLASH memory
3183flinfo - print FLASH memory information
3184bdinfo - print Board Info structure
3185iminfo - print header information for application image
3186coninfo - print console devices and informations
3187ide - IDE sub-system
3188loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003189loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003190mtest - simple RAM test
3191icache - enable or disable instruction cache
3192dcache - enable or disable data cache
3193reset - Perform RESET of the CPU
3194echo - echo args to console
3195version - print monitor version
3196help - print online help
3197? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003198
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk2729af92004-05-03 20:45:30 +00003200Monitor Commands - Detailed Description:
3201========================================
wdenkc6097192002-11-03 00:24:07 +00003202
wdenk2729af92004-05-03 20:45:30 +00003203TODO.
wdenkc6097192002-11-03 00:24:07 +00003204
wdenk2729af92004-05-03 20:45:30 +00003205For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003206
3207
wdenk2729af92004-05-03 20:45:30 +00003208Environment Variables:
3209======================
wdenkc6097192002-11-03 00:24:07 +00003210
wdenk2729af92004-05-03 20:45:30 +00003211U-Boot supports user configuration using Environment Variables which
3212can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003213
wdenk2729af92004-05-03 20:45:30 +00003214Environment Variables are set using "setenv", printed using
3215"printenv", and saved to Flash using "saveenv". Using "setenv"
3216without a value can be used to delete a variable from the
3217environment. As long as you don't save the environment you are
3218working with an in-memory copy. In case the Flash area containing the
3219environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003220
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003221Some configuration options can be set using Environment Variables.
3222
3223List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003224
wdenk2729af92004-05-03 20:45:30 +00003225 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003226
wdenk2729af92004-05-03 20:45:30 +00003227 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk2729af92004-05-03 20:45:30 +00003229 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003230
wdenk2729af92004-05-03 20:45:30 +00003231 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003232
wdenk2729af92004-05-03 20:45:30 +00003233 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003234
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003235 bootm_low - Memory range available for image processing in the bootm
3236 command can be restricted. This variable is given as
3237 a hexadecimal number and defines lowest address allowed
3238 for use by the bootm command. See also "bootm_size"
3239 environment variable. Address defined by "bootm_low" is
3240 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003241 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3242 bootm_mapsize.
3243
3244 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3245 This variable is given as a hexadecimal number and it
3246 defines the size of the memory region starting at base
3247 address bootm_low that is accessible by the Linux kernel
3248 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3249 as the default value if it is defined, and bootm_size is
3250 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003251
3252 bootm_size - Memory range available for image processing in the bootm
3253 command can be restricted. This variable is given as
3254 a hexadecimal number and defines the size of the region
3255 allowed for use by the bootm command. See also "bootm_low"
3256 environment variable.
3257
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003258 updatefile - Location of the software update file on a TFTP server, used
3259 by the automatic software update feature. Please refer to
3260 documentation in doc/README.update for more details.
3261
wdenk2729af92004-05-03 20:45:30 +00003262 autoload - if set to "no" (any string beginning with 'n'),
3263 "bootp" will just load perform a lookup of the
3264 configuration from the BOOTP server, but not try to
3265 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003266
wdenk2729af92004-05-03 20:45:30 +00003267 autostart - if set to "yes", an image loaded using the "bootp",
3268 "rarpboot", "tftpboot" or "diskboot" commands will
3269 be automatically started (by internally calling
3270 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003271
wdenk2729af92004-05-03 20:45:30 +00003272 If set to "no", a standalone image passed to the
3273 "bootm" command will be copied to the load address
3274 (and eventually uncompressed), but NOT be started.
3275 This can be used to load and uncompress arbitrary
3276 data.
wdenkc6097192002-11-03 00:24:07 +00003277
wdenk17ea1172004-06-06 21:51:03 +00003278 i2cfast - (PPC405GP|PPC405EP only)
3279 if set to 'y' configures Linux I2C driver for fast
3280 mode (400kHZ). This environment variable is used in
3281 initialization code. So, for changes to be effective
3282 it must be saved and board must be reset.
3283
wdenk2729af92004-05-03 20:45:30 +00003284 initrd_high - restrict positioning of initrd images:
3285 If this variable is not set, initrd images will be
3286 copied to the highest possible address in RAM; this
3287 is usually what you want since it allows for
3288 maximum initrd size. If for some reason you want to
3289 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003290 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003291 variable to a value of "no" or "off" or "0".
3292 Alternatively, you can set it to a maximum upper
3293 address to use (U-Boot will still check that it
3294 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003295
wdenk2729af92004-05-03 20:45:30 +00003296 For instance, when you have a system with 16 MB
3297 RAM, and want to reserve 4 MB from use by Linux,
3298 you can do this by adding "mem=12M" to the value of
3299 the "bootargs" variable. However, now you must make
3300 sure that the initrd image is placed in the first
3301 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003304
wdenk2729af92004-05-03 20:45:30 +00003305 If you set initrd_high to 0xFFFFFFFF, this is an
3306 indication to U-Boot that all addresses are legal
3307 for the Linux kernel, including addresses in flash
3308 memory. In this case U-Boot will NOT COPY the
3309 ramdisk at all. This may be useful to reduce the
3310 boot time on your system, but requires that this
3311 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003312
wdenk2729af92004-05-03 20:45:30 +00003313 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003314
wdenk2729af92004-05-03 20:45:30 +00003315 loadaddr - Default load address for commands like "bootp",
3316 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003317
wdenk2729af92004-05-03 20:45:30 +00003318 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003319
wdenk2729af92004-05-03 20:45:30 +00003320 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003321
wdenk2729af92004-05-03 20:45:30 +00003322 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003323
wdenk2729af92004-05-03 20:45:30 +00003324 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003325
wdenk2729af92004-05-03 20:45:30 +00003326 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003327
wdenk2729af92004-05-03 20:45:30 +00003328 ethprime - When CONFIG_NET_MULTI is enabled controls which
3329 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk2729af92004-05-03 20:45:30 +00003331 ethact - When CONFIG_NET_MULTI is enabled controls which
3332 interface is currently active. For example you
3333 can do the following
wdenkc6097192002-11-03 00:24:07 +00003334
Heiko Schocher48690d82010-07-20 17:45:02 +02003335 => setenv ethact FEC
3336 => ping 192.168.0.1 # traffic sent on FEC
3337 => setenv ethact SCC
3338 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003339
Matthias Fuchse1692572008-01-17 07:45:05 +01003340 ethrotate - When set to "no" U-Boot does not go through all
3341 available network interfaces.
3342 It just stays at the currently selected interface.
3343
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003344 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003345 either succeed or fail without retrying.
3346 When set to "once" the network operation will
3347 fail when all the available network interfaces
3348 are tried once without success.
3349 Useful on scripts which control the retry operation
3350 themselves.
wdenkc6097192002-11-03 00:24:07 +00003351
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003352 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003353
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003354 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003355 UDP source port.
3356
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003357 tftpdstport - If this is set, the value is used for TFTP's UDP
3358 destination port instead of the Well Know Port 69.
3359
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003360 tftpblocksize - Block size to use for TFTP transfers; if not set,
3361 we use the TFTP server's default block size
3362
3363 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3364 seconds, minimum value is 1000 = 1 second). Defines
3365 when a packet is considered to be lost so it has to
3366 be retransmitted. The default is 5000 = 5 seconds.
3367 Lowering this value may make downloads succeed
3368 faster in networks with high packet loss rates or
3369 with unreliable TFTP servers.
3370
3371 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003372 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003373 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003374
wdenk2729af92004-05-03 20:45:30 +00003375The following environment variables may be used and automatically
3376updated by the network boot commands ("bootp" and "rarpboot"),
3377depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003378
wdenk2729af92004-05-03 20:45:30 +00003379 bootfile - see above
3380 dnsip - IP address of your Domain Name Server
3381 dnsip2 - IP address of your secondary Domain Name Server
3382 gatewayip - IP address of the Gateway (Router) to use
3383 hostname - Target hostname
3384 ipaddr - see above
3385 netmask - Subnet Mask
3386 rootpath - Pathname of the root filesystem on the NFS server
3387 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003388
wdenka3d991b2004-04-15 21:48:45 +00003389
wdenk2729af92004-05-03 20:45:30 +00003390There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003391
wdenk2729af92004-05-03 20:45:30 +00003392 serial# - contains hardware identification information such
3393 as type string and/or serial number
3394 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003395
wdenk2729af92004-05-03 20:45:30 +00003396These variables can be set only once (usually during manufacturing of
3397the board). U-Boot refuses to delete or overwrite these variables
3398once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003399
3400
wdenk2729af92004-05-03 20:45:30 +00003401Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403 ver - Contains the U-Boot version string as printed
3404 with the "version" command. This variable is
3405 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003406
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk2729af92004-05-03 20:45:30 +00003408Please note that changes to some configuration parameters may take
3409only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003410
stroesec1551ea2003-04-04 15:53:41 +00003411
wdenk2729af92004-05-03 20:45:30 +00003412Command Line Parsing:
3413=====================
stroesec1551ea2003-04-04 15:53:41 +00003414
wdenk2729af92004-05-03 20:45:30 +00003415There are two different command line parsers available with U-Boot:
3416the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003417
wdenk2729af92004-05-03 20:45:30 +00003418Old, simple command line parser:
3419--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003420
wdenk2729af92004-05-03 20:45:30 +00003421- supports environment variables (through setenv / saveenv commands)
3422- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003423- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003424- special characters ('$', ';') can be escaped by prefixing with '\',
3425 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003426 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003427- You can also escape text by enclosing in single apostrophes, for example:
3428 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003429
wdenk2729af92004-05-03 20:45:30 +00003430Hush shell:
3431-----------
wdenkf07771c2003-05-28 08:06:31 +00003432
wdenk2729af92004-05-03 20:45:30 +00003433- similar to Bourne shell, with control structures like
3434 if...then...else...fi, for...do...done; while...do...done,
3435 until...do...done, ...
3436- supports environment ("global") variables (through setenv / saveenv
3437 commands) and local shell variables (through standard shell syntax
3438 "name=value"); only environment variables can be used with "run"
3439 command
wdenkf07771c2003-05-28 08:06:31 +00003440
wdenk2729af92004-05-03 20:45:30 +00003441General rules:
3442--------------
wdenkf07771c2003-05-28 08:06:31 +00003443
wdenk2729af92004-05-03 20:45:30 +00003444(1) If a command line (or an environment variable executed by a "run"
3445 command) contains several commands separated by semicolon, and
3446 one of these commands fails, then the remaining commands will be
3447 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003448
wdenk2729af92004-05-03 20:45:30 +00003449(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003450 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003451 command will cause "run" to terminate, i. e. the remaining
3452 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003453
wdenk2729af92004-05-03 20:45:30 +00003454Note for Redundant Ethernet Interfaces:
3455=======================================
wdenkf07771c2003-05-28 08:06:31 +00003456
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003457Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003458such configurations and is capable of automatic selection of a
3459"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003460
wdenk2729af92004-05-03 20:45:30 +00003461Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3462MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3463"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003464
wdenk2729af92004-05-03 20:45:30 +00003465If the network interface stores some valid MAC address (for instance
3466in SROM), this is used as default address if there is NO correspon-
3467ding setting in the environment; if the corresponding environment
3468variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003469
wdenk2729af92004-05-03 20:45:30 +00003470o If the SROM has a valid MAC address, and there is no address in the
3471 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003472
wdenk2729af92004-05-03 20:45:30 +00003473o If there is no valid address in the SROM, and a definition in the
3474 environment exists, then the value from the environment variable is
3475 used.
wdenkc6097192002-11-03 00:24:07 +00003476
wdenk2729af92004-05-03 20:45:30 +00003477o If both the SROM and the environment contain a MAC address, and
3478 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk2729af92004-05-03 20:45:30 +00003480o If both the SROM and the environment contain a MAC address, and the
3481 addresses differ, the value from the environment is used and a
3482 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484o If neither SROM nor the environment contain a MAC address, an error
3485 is raised.
wdenkc6097192002-11-03 00:24:07 +00003486
Ben Warrenecee9322010-04-26 11:11:46 -07003487If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3488will be programmed into hardware as part of the initialization process. This
3489may be skipped by setting the appropriate 'ethmacskip' environment variable.
3490The naming convention is as follows:
3491"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003492
wdenk2729af92004-05-03 20:45:30 +00003493Image Formats:
3494==============
wdenkc6097192002-11-03 00:24:07 +00003495
Marian Balakowicz3310c542008-03-12 12:13:13 +01003496U-Boot is capable of booting (and performing other auxiliary operations on)
3497images in two formats:
3498
3499New uImage format (FIT)
3500-----------------------
3501
3502Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3503to Flattened Device Tree). It allows the use of images with multiple
3504components (several kernels, ramdisks, etc.), with contents protected by
3505SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3506
3507
3508Old uImage format
3509-----------------
3510
3511Old image format is based on binary files which can be basically anything,
3512preceded by a special header; see the definitions in include/image.h for
3513details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003514
wdenk2729af92004-05-03 20:45:30 +00003515* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3516 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003517 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3518 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3519 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003520* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003521 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3522 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003523* Compression Type (uncompressed, gzip, bzip2)
3524* Load Address
3525* Entry Point
3526* Image Name
3527* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003528
wdenk2729af92004-05-03 20:45:30 +00003529The header is marked by a special Magic Number, and both the header
3530and the data portions of the image are secured against corruption by
3531CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003532
wdenkc6097192002-11-03 00:24:07 +00003533
wdenk2729af92004-05-03 20:45:30 +00003534Linux Support:
3535==============
wdenkc6097192002-11-03 00:24:07 +00003536
wdenk2729af92004-05-03 20:45:30 +00003537Although U-Boot should support any OS or standalone application
3538easily, the main focus has always been on Linux during the design of
3539U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003540
wdenk2729af92004-05-03 20:45:30 +00003541U-Boot includes many features that so far have been part of some
3542special "boot loader" code within the Linux kernel. Also, any
3543"initrd" images to be used are no longer part of one big Linux image;
3544instead, kernel and "initrd" are separate images. This implementation
3545serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003546
wdenk2729af92004-05-03 20:45:30 +00003547- the same features can be used for other OS or standalone
3548 applications (for instance: using compressed images to reduce the
3549 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003550
wdenk2729af92004-05-03 20:45:30 +00003551- it becomes much easier to port new Linux kernel versions because
3552 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003553
wdenk2729af92004-05-03 20:45:30 +00003554- the same Linux kernel image can now be used with different "initrd"
3555 images; of course this also means that different kernel images can
3556 be run with the same "initrd". This makes testing easier (you don't
3557 have to build a new "zImage.initrd" Linux image when you just
3558 change a file in your "initrd"). Also, a field-upgrade of the
3559 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003560
wdenkc6097192002-11-03 00:24:07 +00003561
wdenk2729af92004-05-03 20:45:30 +00003562Linux HOWTO:
3563============
wdenkc6097192002-11-03 00:24:07 +00003564
wdenk2729af92004-05-03 20:45:30 +00003565Porting Linux to U-Boot based systems:
3566---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003567
wdenk2729af92004-05-03 20:45:30 +00003568U-Boot cannot save you from doing all the necessary modifications to
3569configure the Linux device drivers for use with your target hardware
3570(no, we don't intend to provide a full virtual machine interface to
3571Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003572
Stefan Roesea47a12b2010-04-15 16:07:28 +02003573But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003574
wdenk2729af92004-05-03 20:45:30 +00003575Just make sure your machine specific header file (for instance
3576include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003577Information structure as we define in include/asm-<arch>/u-boot.h,
3578and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003579as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003580
wdenkc6097192002-11-03 00:24:07 +00003581
wdenk2729af92004-05-03 20:45:30 +00003582Configuring the Linux kernel:
3583-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003584
wdenk2729af92004-05-03 20:45:30 +00003585No specific requirements for U-Boot. Make sure you have some root
3586device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003587
wdenkc6097192002-11-03 00:24:07 +00003588
wdenk2729af92004-05-03 20:45:30 +00003589Building a Linux Image:
3590-----------------------
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk2729af92004-05-03 20:45:30 +00003592With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3593not used. If you use recent kernel source, a new build target
3594"uImage" will exist which automatically builds an image usable by
3595U-Boot. Most older kernels also have support for a "pImage" target,
3596which was introduced for our predecessor project PPCBoot and uses a
3597100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003598
wdenk2729af92004-05-03 20:45:30 +00003599Example:
wdenkc6097192002-11-03 00:24:07 +00003600
wdenk2729af92004-05-03 20:45:30 +00003601 make TQM850L_config
3602 make oldconfig
3603 make dep
3604 make uImage
wdenkc6097192002-11-03 00:24:07 +00003605
wdenk2729af92004-05-03 20:45:30 +00003606The "uImage" build target uses a special tool (in 'tools/mkimage') to
3607encapsulate a compressed Linux kernel image with header information,
3608CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003609
wdenk2729af92004-05-03 20:45:30 +00003610* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003611
wdenk2729af92004-05-03 20:45:30 +00003612* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003613
wdenk2729af92004-05-03 20:45:30 +00003614 ${CROSS_COMPILE}-objcopy -O binary \
3615 -R .note -R .comment \
3616 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003617
wdenk2729af92004-05-03 20:45:30 +00003618* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003619
wdenk2729af92004-05-03 20:45:30 +00003620 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003621
wdenk2729af92004-05-03 20:45:30 +00003622* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003623
wdenk2729af92004-05-03 20:45:30 +00003624 mkimage -A ppc -O linux -T kernel -C gzip \
3625 -a 0 -e 0 -n "Linux Kernel Image" \
3626 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003627
wdenk24ee89b2002-11-03 17:56:27 +00003628
wdenk2729af92004-05-03 20:45:30 +00003629The "mkimage" tool can also be used to create ramdisk images for use
3630with U-Boot, either separated from the Linux kernel image, or
3631combined into one file. "mkimage" encapsulates the images with a 64
3632byte header containing information about target architecture,
3633operating system, image type, compression method, entry points, time
3634stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003635
wdenk2729af92004-05-03 20:45:30 +00003636"mkimage" can be called in two ways: to verify existing images and
3637print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003638
wdenk2729af92004-05-03 20:45:30 +00003639In the first form (with "-l" option) mkimage lists the information
3640contained in the header of an existing U-Boot image; this includes
3641checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003642
wdenk2729af92004-05-03 20:45:30 +00003643 tools/mkimage -l image
3644 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003645
wdenk2729af92004-05-03 20:45:30 +00003646The second form (with "-d" option) is used to build a U-Boot image
3647from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003648
wdenk2729af92004-05-03 20:45:30 +00003649 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3650 -n name -d data_file image
3651 -A ==> set architecture to 'arch'
3652 -O ==> set operating system to 'os'
3653 -T ==> set image type to 'type'
3654 -C ==> set compression type 'comp'
3655 -a ==> set load address to 'addr' (hex)
3656 -e ==> set entry point to 'ep' (hex)
3657 -n ==> set image name to 'name'
3658 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003659
wdenk69459792004-05-29 16:53:29 +00003660Right now, all Linux kernels for PowerPC systems use the same load
3661address (0x00000000), but the entry point address depends on the
3662kernel version:
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk2729af92004-05-03 20:45:30 +00003664- 2.2.x kernels have the entry point at 0x0000000C,
3665- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003668
wdenk2729af92004-05-03 20:45:30 +00003669 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3670 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003671 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003672 > examples/uImage.TQM850L
3673 Image Name: 2.4.4 kernel for TQM850L
3674 Created: Wed Jul 19 02:34:59 2000
3675 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3676 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3677 Load Address: 0x00000000
3678 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003679
wdenk2729af92004-05-03 20:45:30 +00003680To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003681
wdenk2729af92004-05-03 20:45:30 +00003682 -> tools/mkimage -l examples/uImage.TQM850L
3683 Image Name: 2.4.4 kernel for TQM850L
3684 Created: Wed Jul 19 02:34:59 2000
3685 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3686 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3687 Load Address: 0x00000000
3688 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003689
wdenk2729af92004-05-03 20:45:30 +00003690NOTE: for embedded systems where boot time is critical you can trade
3691speed for memory and install an UNCOMPRESSED image instead: this
3692needs more space in Flash, but boots much faster since it does not
3693need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003694
Stefan Roesea47a12b2010-04-15 16:07:28 +02003695 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003696 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3697 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003698 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003699 > examples/uImage.TQM850L-uncompressed
3700 Image Name: 2.4.4 kernel for TQM850L
3701 Created: Wed Jul 19 02:34:59 2000
3702 Image Type: PowerPC Linux Kernel Image (uncompressed)
3703 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3704 Load Address: 0x00000000
3705 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003706
wdenkc6097192002-11-03 00:24:07 +00003707
wdenk2729af92004-05-03 20:45:30 +00003708Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3709when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003710
wdenk2729af92004-05-03 20:45:30 +00003711 -> tools/mkimage -n 'Simple Ramdisk Image' \
3712 > -A ppc -O linux -T ramdisk -C gzip \
3713 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3714 Image Name: Simple Ramdisk Image
3715 Created: Wed Jan 12 14:01:50 2000
3716 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3717 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3718 Load Address: 0x00000000
3719 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003720
wdenkdb01a2e2004-04-15 23:14:49 +00003721
wdenk2729af92004-05-03 20:45:30 +00003722Installing a Linux Image:
3723-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003724
wdenk2729af92004-05-03 20:45:30 +00003725To downloading a U-Boot image over the serial (console) interface,
3726you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003727
wdenk2729af92004-05-03 20:45:30 +00003728 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003729
wdenk2729af92004-05-03 20:45:30 +00003730The 'objcopy' does not understand the information in the U-Boot
3731image header, so the resulting S-Record file will be relative to
3732address 0x00000000. To load it to a given address, you need to
3733specify the target address as 'offset' parameter with the 'loads'
3734command.
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk2729af92004-05-03 20:45:30 +00003736Example: install the image to address 0x40100000 (which on the
3737TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk2729af92004-05-03 20:45:30 +00003739 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003740
wdenk2729af92004-05-03 20:45:30 +00003741 .......... done
3742 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003743
wdenk2729af92004-05-03 20:45:30 +00003744 => loads 40100000
3745 ## Ready for S-Record download ...
3746 ~>examples/image.srec
3747 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3748 ...
3749 15989 15990 15991 15992
3750 [file transfer complete]
3751 [connected]
3752 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003753
3754
wdenk2729af92004-05-03 20:45:30 +00003755You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003756this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003757corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003760
wdenk2729af92004-05-03 20:45:30 +00003761 ## Checking Image at 40100000 ...
3762 Image Name: 2.2.13 for initrd on TQM850L
3763 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3764 Data Size: 335725 Bytes = 327 kB = 0 MB
3765 Load Address: 00000000
3766 Entry Point: 0000000c
3767 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003768
3769
wdenk2729af92004-05-03 20:45:30 +00003770Boot Linux:
3771-----------
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773The "bootm" command is used to boot an application that is stored in
3774memory (RAM or Flash). In case of a Linux kernel image, the contents
3775of the "bootargs" environment variable is passed to the kernel as
3776parameters. You can check and modify this variable using the
3777"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003778
3779
wdenk2729af92004-05-03 20:45:30 +00003780 => printenv bootargs
3781 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003782
wdenk2729af92004-05-03 20:45:30 +00003783 => 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 +00003784
wdenk2729af92004-05-03 20:45:30 +00003785 => printenv bootargs
3786 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 +00003787
wdenk2729af92004-05-03 20:45:30 +00003788 => bootm 40020000
3789 ## Booting Linux kernel at 40020000 ...
3790 Image Name: 2.2.13 for NFS on TQM850L
3791 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3792 Data Size: 381681 Bytes = 372 kB = 0 MB
3793 Load Address: 00000000
3794 Entry Point: 0000000c
3795 Verifying Checksum ... OK
3796 Uncompressing Kernel Image ... OK
3797 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
3798 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3799 time_init: decrementer frequency = 187500000/60
3800 Calibrating delay loop... 49.77 BogoMIPS
3801 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3802 ...
wdenkc6097192002-11-03 00:24:07 +00003803
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003804If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003805the memory addresses of both the kernel and the initrd image (PPBCOOT
3806format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003807
wdenk2729af92004-05-03 20:45:30 +00003808 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003809
wdenk2729af92004-05-03 20:45:30 +00003810 ## Checking Image at 40100000 ...
3811 Image Name: 2.2.13 for initrd on TQM850L
3812 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3813 Data Size: 335725 Bytes = 327 kB = 0 MB
3814 Load Address: 00000000
3815 Entry Point: 0000000c
3816 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003817
wdenk2729af92004-05-03 20:45:30 +00003818 ## Checking Image at 40200000 ...
3819 Image Name: Simple Ramdisk Image
3820 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3821 Data Size: 566530 Bytes = 553 kB = 0 MB
3822 Load Address: 00000000
3823 Entry Point: 00000000
3824 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003825
wdenk2729af92004-05-03 20:45:30 +00003826 => bootm 40100000 40200000
3827 ## Booting Linux kernel at 40100000 ...
3828 Image Name: 2.2.13 for initrd on TQM850L
3829 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3830 Data Size: 335725 Bytes = 327 kB = 0 MB
3831 Load Address: 00000000
3832 Entry Point: 0000000c
3833 Verifying Checksum ... OK
3834 Uncompressing Kernel Image ... OK
3835 ## Loading RAMDisk Image at 40200000 ...
3836 Image Name: Simple Ramdisk Image
3837 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3838 Data Size: 566530 Bytes = 553 kB = 0 MB
3839 Load Address: 00000000
3840 Entry Point: 00000000
3841 Verifying Checksum ... OK
3842 Loading Ramdisk ... OK
3843 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
3844 Boot arguments: root=/dev/ram
3845 time_init: decrementer frequency = 187500000/60
3846 Calibrating delay loop... 49.77 BogoMIPS
3847 ...
3848 RAMDISK: Compressed image found at block 0
3849 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851 bash#
wdenkc6097192002-11-03 00:24:07 +00003852
Matthew McClintock02677682006-06-28 10:41:37 -05003853Boot Linux and pass a flat device tree:
3854-----------
3855
3856First, U-Boot must be compiled with the appropriate defines. See the section
3857titled "Linux Kernel Interface" above for a more in depth explanation. The
3858following is an example of how to start a kernel and pass an updated
3859flat device tree:
3860
3861=> print oftaddr
3862oftaddr=0x300000
3863=> print oft
3864oft=oftrees/mpc8540ads.dtb
3865=> tftp $oftaddr $oft
3866Speed: 1000, full duplex
3867Using TSEC0 device
3868TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3869Filename 'oftrees/mpc8540ads.dtb'.
3870Load address: 0x300000
3871Loading: #
3872done
3873Bytes transferred = 4106 (100a hex)
3874=> tftp $loadaddr $bootfile
3875Speed: 1000, full duplex
3876Using TSEC0 device
3877TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3878Filename 'uImage'.
3879Load address: 0x200000
3880Loading:############
3881done
3882Bytes transferred = 1029407 (fb51f hex)
3883=> print loadaddr
3884loadaddr=200000
3885=> print oftaddr
3886oftaddr=0x300000
3887=> bootm $loadaddr - $oftaddr
3888## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003889 Image Name: Linux-2.6.17-dirty
3890 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3891 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003892 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003893 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003894 Verifying Checksum ... OK
3895 Uncompressing Kernel Image ... OK
3896Booting using flat device tree at 0x300000
3897Using MPC85xx ADS machine description
3898Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3899[snip]
3900
3901
wdenk2729af92004-05-03 20:45:30 +00003902More About U-Boot Image Types:
3903------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003904
wdenk2729af92004-05-03 20:45:30 +00003905U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003906
wdenk2729af92004-05-03 20:45:30 +00003907 "Standalone Programs" are directly runnable in the environment
3908 provided by U-Boot; it is expected that (if they behave
3909 well) you can continue to work in U-Boot after return from
3910 the Standalone Program.
3911 "OS Kernel Images" are usually images of some Embedded OS which
3912 will take over control completely. Usually these programs
3913 will install their own set of exception handlers, device
3914 drivers, set up the MMU, etc. - this means, that you cannot
3915 expect to re-enter U-Boot except by resetting the CPU.
3916 "RAMDisk Images" are more or less just data blocks, and their
3917 parameters (address, size) are passed to an OS kernel that is
3918 being started.
3919 "Multi-File Images" contain several images, typically an OS
3920 (Linux) kernel image and one or more data images like
3921 RAMDisks. This construct is useful for instance when you want
3922 to boot over the network using BOOTP etc., where the boot
3923 server provides just a single image file, but you want to get
3924 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003925
wdenk2729af92004-05-03 20:45:30 +00003926 "Multi-File Images" start with a list of image sizes, each
3927 image size (in bytes) specified by an "uint32_t" in network
3928 byte order. This list is terminated by an "(uint32_t)0".
3929 Immediately after the terminating 0 follow the images, one by
3930 one, all aligned on "uint32_t" boundaries (size rounded up to
3931 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003932
wdenk2729af92004-05-03 20:45:30 +00003933 "Firmware Images" are binary images containing firmware (like
3934 U-Boot or FPGA images) which usually will be programmed to
3935 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937 "Script files" are command sequences that will be executed by
3938 U-Boot's command interpreter; this feature is especially
3939 useful when you configure U-Boot to use a real shell (hush)
3940 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003941
wdenkc6097192002-11-03 00:24:07 +00003942
wdenk2729af92004-05-03 20:45:30 +00003943Standalone HOWTO:
3944=================
wdenkc6097192002-11-03 00:24:07 +00003945
wdenk2729af92004-05-03 20:45:30 +00003946One of the features of U-Boot is that you can dynamically load and
3947run "standalone" applications, which can use some resources of
3948U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003949
wdenk2729af92004-05-03 20:45:30 +00003950Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003951
wdenk2729af92004-05-03 20:45:30 +00003952"Hello World" Demo:
3953-------------------
wdenkc6097192002-11-03 00:24:07 +00003954
wdenk2729af92004-05-03 20:45:30 +00003955'examples/hello_world.c' contains a small "Hello World" Demo
3956application; it is automatically compiled when you build U-Boot.
3957It's configured to run at address 0x00040004, so you can play with it
3958like that:
wdenkc6097192002-11-03 00:24:07 +00003959
wdenk2729af92004-05-03 20:45:30 +00003960 => loads
3961 ## Ready for S-Record download ...
3962 ~>examples/hello_world.srec
3963 1 2 3 4 5 6 7 8 9 10 11 ...
3964 [file transfer complete]
3965 [connected]
3966 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003967
wdenk2729af92004-05-03 20:45:30 +00003968 => go 40004 Hello World! This is a test.
3969 ## Starting application at 0x00040004 ...
3970 Hello World
3971 argc = 7
3972 argv[0] = "40004"
3973 argv[1] = "Hello"
3974 argv[2] = "World!"
3975 argv[3] = "This"
3976 argv[4] = "is"
3977 argv[5] = "a"
3978 argv[6] = "test."
3979 argv[7] = "<NULL>"
3980 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003981
wdenk2729af92004-05-03 20:45:30 +00003982 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003983
wdenk2729af92004-05-03 20:45:30 +00003984Another example, which demonstrates how to register a CPM interrupt
3985handler with the U-Boot code, can be found in 'examples/timer.c'.
3986Here, a CPM timer is set up to generate an interrupt every second.
3987The interrupt service routine is trivial, just printing a '.'
3988character, but this is just a demo program. The application can be
3989controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003990
wdenk2729af92004-05-03 20:45:30 +00003991 ? - print current values og the CPM Timer registers
3992 b - enable interrupts and start timer
3993 e - stop timer and disable interrupts
3994 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003995
wdenk2729af92004-05-03 20:45:30 +00003996 => loads
3997 ## Ready for S-Record download ...
3998 ~>examples/timer.srec
3999 1 2 3 4 5 6 7 8 9 10 11 ...
4000 [file transfer complete]
4001 [connected]
4002 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004003
wdenk2729af92004-05-03 20:45:30 +00004004 => go 40004
4005 ## Starting application at 0x00040004 ...
4006 TIMERS=0xfff00980
4007 Using timer 1
4008 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk2729af92004-05-03 20:45:30 +00004010Hit 'b':
4011 [q, b, e, ?] Set interval 1000000 us
4012 Enabling timer
4013Hit '?':
4014 [q, b, e, ?] ........
4015 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4016Hit '?':
4017 [q, b, e, ?] .
4018 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4019Hit '?':
4020 [q, b, e, ?] .
4021 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4022Hit '?':
4023 [q, b, e, ?] .
4024 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4025Hit 'e':
4026 [q, b, e, ?] ...Stopping timer
4027Hit 'q':
4028 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004029
4030
wdenk2729af92004-05-03 20:45:30 +00004031Minicom warning:
4032================
wdenk85ec0bc2003-03-31 16:34:49 +00004033
wdenk2729af92004-05-03 20:45:30 +00004034Over time, many people have reported problems when trying to use the
4035"minicom" terminal emulation program for serial download. I (wd)
4036consider minicom to be broken, and recommend not to use it. Under
4037Unix, I recommend to use C-Kermit for general purpose use (and
4038especially for kermit binary protocol download ("loadb" command), and
4039use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004040
wdenk2729af92004-05-03 20:45:30 +00004041Nevertheless, if you absolutely want to use it try adding this
4042configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004043
wdenk2729af92004-05-03 20:45:30 +00004044 Name Program Name U/D FullScr IO-Red. Multi
4045 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4046 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004047
4048
wdenk2729af92004-05-03 20:45:30 +00004049NetBSD Notes:
4050=============
wdenkc6097192002-11-03 00:24:07 +00004051
wdenk2729af92004-05-03 20:45:30 +00004052Starting at version 0.9.2, U-Boot supports NetBSD both as host
4053(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004054
wdenk2729af92004-05-03 20:45:30 +00004055Building requires a cross environment; it is known to work on
4056NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4057need gmake since the Makefiles are not compatible with BSD make).
4058Note that the cross-powerpc package does not install include files;
4059attempting to build U-Boot will fail because <machine/ansi.h> is
4060missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004061
wdenk2729af92004-05-03 20:45:30 +00004062 # cd /usr/pkg/cross/powerpc-netbsd/include
4063 # mkdir powerpc
4064 # ln -s powerpc machine
4065 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4066 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk2729af92004-05-03 20:45:30 +00004068Native builds *don't* work due to incompatibilities between native
4069and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071Booting assumes that (the first part of) the image booted is a
4072stage-2 loader which in turn loads and then invokes the kernel
4073proper. Loader sources will eventually appear in the NetBSD source
4074tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004075meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004076
4077
wdenk2729af92004-05-03 20:45:30 +00004078Implementation Internals:
4079=========================
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081The following is not intended to be a complete description of every
4082implementation detail. However, it should help to understand the
4083inner workings of U-Boot and make it easier to port it to custom
4084hardware.
wdenkc6097192002-11-03 00:24:07 +00004085
4086
wdenk2729af92004-05-03 20:45:30 +00004087Initial Stack, Global Data:
4088---------------------------
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk2729af92004-05-03 20:45:30 +00004090The implementation of U-Boot is complicated by the fact that U-Boot
4091starts running out of ROM (flash memory), usually without access to
4092system RAM (because the memory controller is not initialized yet).
4093This means that we don't have writable Data or BSS segments, and BSS
4094is not initialized as zero. To be able to get a C environment working
4095at all, we have to allocate at least a minimal stack. Implementation
4096options for this are defined and restricted by the CPU used: Some CPU
4097models provide on-chip memory (like the IMMR area on MPC8xx and
4098MPC826x processors), on others (parts of) the data cache can be
4099locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004100
Wolfgang Denk218ca722008-03-26 10:40:12 +01004101 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004102 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004103
wdenk2729af92004-05-03 20:45:30 +00004104 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4105 From: "Chris Hallinan" <clh@net1plus.com>
4106 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4107 ...
wdenk43d96162003-03-06 00:02:04 +00004108
wdenk2729af92004-05-03 20:45:30 +00004109 Correct me if I'm wrong, folks, but the way I understand it
4110 is this: Using DCACHE as initial RAM for Stack, etc, does not
4111 require any physical RAM backing up the cache. The cleverness
4112 is that the cache is being used as a temporary supply of
4113 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004114 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004115 can see how this works by studying the cache architecture and
4116 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004117
wdenk2729af92004-05-03 20:45:30 +00004118 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4119 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004120 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004121 option should work for you. Using CS 4 should be fine if your
4122 board designers haven't used it for something that would
4123 cause you grief during the initial boot! It is frequently not
4124 used.
wdenk43d96162003-03-06 00:02:04 +00004125
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004126 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004127 with your processor/board/system design. The default value
4128 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004129 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004130 than your SDRAM module. If you have a 64MB SDRAM module, set
4131 it above 400_0000. Just make sure your board has no resources
4132 that are supposed to respond to that address! That code in
4133 start.S has been around a while and should work as is when
4134 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004135
wdenk2729af92004-05-03 20:45:30 +00004136 -Chris Hallinan
4137 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004138
wdenk2729af92004-05-03 20:45:30 +00004139It is essential to remember this, since it has some impact on the C
4140code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004141
wdenk2729af92004-05-03 20:45:30 +00004142* Initialized global data (data segment) is read-only. Do not attempt
4143 to write it.
wdenkc6097192002-11-03 00:24:07 +00004144
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004145* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004146 as zero data - BSS segment) at all - this is undefined, initiali-
4147 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004148
wdenk2729af92004-05-03 20:45:30 +00004149* Stack space is very limited. Avoid big data buffers or things like
4150 that.
wdenkc6097192002-11-03 00:24:07 +00004151
wdenk2729af92004-05-03 20:45:30 +00004152Having only the stack as writable memory limits means we cannot use
4153normal global data to share information beween the code. But it
4154turned out that the implementation of U-Boot can be greatly
4155simplified by making a global data structure (gd_t) available to all
4156functions. We could pass a pointer to this data as argument to _all_
4157functions, but this would bloat the code. Instead we use a feature of
4158the GCC compiler (Global Register Variables) to share the data: we
4159place a pointer (gd) to the global data into a register which we
4160reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162When choosing a register for such a purpose we are restricted by the
4163relevant (E)ABI specifications for the current architecture, and by
4164GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166For PowerPC, the following registers have specific use:
4167 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004168 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004169 R3-R4: parameter passing and return values
4170 R5-R10: parameter passing
4171 R13: small data area pointer
4172 R30: GOT pointer
4173 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004174
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004175 (U-Boot also uses R12 as internal GOT pointer. r12
4176 is a volatile register so r12 needs to be reset when
4177 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004178
Wolfgang Denke7670f62008-02-14 22:43:22 +01004179 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004180
wdenk2729af92004-05-03 20:45:30 +00004181 Note: on PPC, we could use a static initializer (since the
4182 address of the global data structure is known at compile time),
4183 but it turned out that reserving a register results in somewhat
4184 smaller code - although the code savings are not that big (on
4185 average for all boards 752 bytes for the whole U-Boot image,
4186 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004187
Robin Getzc4db3352009-08-17 15:23:02 +00004188On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004189 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4190
Robin Getzc4db3352009-08-17 15:23:02 +00004191 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004192
wdenk2729af92004-05-03 20:45:30 +00004193On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004194
wdenk2729af92004-05-03 20:45:30 +00004195 R0: function argument word/integer result
4196 R1-R3: function argument word
4197 R9: GOT pointer
4198 R10: stack limit (used only if stack checking if enabled)
4199 R11: argument (frame) pointer
4200 R12: temporary workspace
4201 R13: stack pointer
4202 R14: link register
4203 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004204
wdenk2729af92004-05-03 20:45:30 +00004205 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004206
Thomas Chou0df01fd2010-05-21 11:08:03 +08004207On Nios II, the ABI is documented here:
4208 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4209
4210 ==> U-Boot will use gp to hold a pointer to the global data
4211
4212 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4213 to access small data sections, so gp is free.
4214
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004215NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4216or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004217
wdenk2729af92004-05-03 20:45:30 +00004218Memory Management:
4219------------------
wdenkc6097192002-11-03 00:24:07 +00004220
wdenk2729af92004-05-03 20:45:30 +00004221U-Boot runs in system state and uses physical addresses, i.e. the
4222MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004223
wdenk2729af92004-05-03 20:45:30 +00004224The available memory is mapped to fixed addresses using the memory
4225controller. In this process, a contiguous block is formed for each
4226memory type (Flash, SDRAM, SRAM), even when it consists of several
4227physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229U-Boot is installed in the first 128 kB of the first Flash bank (on
4230TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4231booting and sizing and initializing DRAM, the code relocates itself
4232to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004233memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004234configuration setting]. Below that, a structure with global Board
4235Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004236
wdenk2729af92004-05-03 20:45:30 +00004237Additionally, some exception handler code is copied to the low 8 kB
4238of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004239
wdenk2729af92004-05-03 20:45:30 +00004240So a typical memory configuration with 16 MB of DRAM could look like
4241this:
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243 0x0000 0000 Exception Vector code
4244 :
4245 0x0000 1FFF
4246 0x0000 2000 Free for Application Use
4247 :
4248 :
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk2729af92004-05-03 20:45:30 +00004250 :
4251 :
4252 0x00FB FF20 Monitor Stack (Growing downward)
4253 0x00FB FFAC Board Info Data and permanent copy of global data
4254 0x00FC 0000 Malloc Arena
4255 :
4256 0x00FD FFFF
4257 0x00FE 0000 RAM Copy of Monitor Code
4258 ... eventually: LCD or video framebuffer
4259 ... eventually: pRAM (Protected RAM - unchanged by reset)
4260 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004261
4262
wdenk2729af92004-05-03 20:45:30 +00004263System Initialization:
4264----------------------
wdenkc6097192002-11-03 00:24:07 +00004265
wdenk2729af92004-05-03 20:45:30 +00004266In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004267(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004268configuration for CS0# this is a mirror of the onboard Flash memory.
4269To be able to re-map memory U-Boot then jumps to its link address.
4270To be able to implement the initialization code in C, a (small!)
4271initial stack is set up in the internal Dual Ported RAM (in case CPUs
4272which provide such a feature like MPC8xx or MPC8260), or in a locked
4273part of the data cache. After that, U-Boot initializes the CPU core,
4274the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004275
wdenk2729af92004-05-03 20:45:30 +00004276Next, all (potentially) available memory banks are mapped using a
4277preliminary mapping. For example, we put them on 512 MB boundaries
4278(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4279on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4280programmed for SDRAM access. Using the temporary configuration, a
4281simple memory test is run that determines the size of the SDRAM
4282banks.
wdenkc6097192002-11-03 00:24:07 +00004283
wdenk2729af92004-05-03 20:45:30 +00004284When there is more than one SDRAM bank, and the banks are of
4285different size, the largest is mapped first. For equal size, the first
4286bank (CS2#) is mapped first. The first mapping is always for address
42870x00000000, with any additional banks following immediately to create
4288contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004289
wdenk2729af92004-05-03 20:45:30 +00004290Then, the monitor installs itself at the upper end of the SDRAM area
4291and allocates memory for use by malloc() and for the global Board
4292Info data; also, the exception vector code is copied to the low RAM
4293pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004294
wdenk2729af92004-05-03 20:45:30 +00004295Only after this relocation will you have a "normal" C environment;
4296until that you are restricted in several ways, mostly because you are
4297running from ROM, and because the code will have to be relocated to a
4298new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004299
4300
wdenk2729af92004-05-03 20:45:30 +00004301U-Boot Porting Guide:
4302----------------------
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk2729af92004-05-03 20:45:30 +00004304[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4305list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004306
4307
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004308int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004309{
4310 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004311
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004312 signal(SIGALRM, no_more_time);
4313 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk2729af92004-05-03 20:45:30 +00004315 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004316 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004317 return 0;
4318 }
4319
wdenk2729af92004-05-03 20:45:30 +00004320 Download latest U-Boot source;
4321
Wolfgang Denk06682362008-12-30 22:56:11 +01004322 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004323
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004324 if (clueless)
4325 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327 while (learning) {
4328 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004329 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4330 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004331 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004332 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004333 }
wdenkc6097192002-11-03 00:24:07 +00004334
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004335 if (available_money > toLocalCurrency ($2500))
4336 Buy a BDI3000;
4337 else
wdenk2729af92004-05-03 20:45:30 +00004338 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004339
4340 if (a similar board exists) { /* hopefully... */
4341 cp -a board/<similar> board/<myboard>
4342 cp include/configs/<similar>.h include/configs/<myboard>.h
4343 } else {
4344 Create your own board support subdirectory;
4345 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004346 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004347 Edit new board/<myboard> files
4348 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004349
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004350 while (!accepted) {
4351 while (!running) {
4352 do {
4353 Add / modify source code;
4354 } until (compiles);
4355 Debug;
4356 if (clueless)
4357 email("Hi, I am having problems...");
4358 }
4359 Send patch file to the U-Boot email list;
4360 if (reasonable critiques)
4361 Incorporate improvements from email list code review;
4362 else
4363 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004364 }
wdenkc6097192002-11-03 00:24:07 +00004365
wdenk2729af92004-05-03 20:45:30 +00004366 return 0;
4367}
4368
4369void no_more_time (int sig)
4370{
4371 hire_a_guru();
4372}
wdenkc6097192002-11-03 00:24:07 +00004373
4374
wdenk2729af92004-05-03 20:45:30 +00004375Coding Standards:
4376-----------------
wdenkc6097192002-11-03 00:24:07 +00004377
wdenk2729af92004-05-03 20:45:30 +00004378All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004379coding style; see the file "Documentation/CodingStyle" and the script
4380"scripts/Lindent" in your Linux kernel source directory. In sources
4381originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4382spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004383
Detlev Zundel2c051652006-09-01 15:39:02 +02004384Source files originating from a different project (for example the
4385MTD subsystem) are generally exempt from these guidelines and are not
4386reformated to ease subsequent migration to newer versions of those
4387sources.
4388
4389Please note that U-Boot is implemented in C (and to some small parts in
4390Assembler); no C++ is used, so please do not use C++ style comments (//)
4391in your code.
wdenk2729af92004-05-03 20:45:30 +00004392
4393Please also stick to the following formatting rules:
4394- remove any trailing white space
4395- use TAB characters for indentation, not spaces
4396- make sure NOT to use DOS '\r\n' line feeds
4397- do not add more than 2 empty lines to source files
4398- do not add trailing empty lines to source files
4399
4400Submissions which do not conform to the standards may be returned
4401with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004402
4403
wdenk2729af92004-05-03 20:45:30 +00004404Submitting Patches:
4405-------------------
wdenkc6097192002-11-03 00:24:07 +00004406
wdenk2729af92004-05-03 20:45:30 +00004407Since the number of patches for U-Boot is growing, we need to
4408establish some rules. Submissions which do not conform to these rules
4409may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004410
Magnus Lilja0d28f342008-08-06 19:32:33 +02004411Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004412
Wolfgang Denk06682362008-12-30 22:56:11 +01004413Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4414see http://lists.denx.de/mailman/listinfo/u-boot
4415
wdenk2729af92004-05-03 20:45:30 +00004416When you send a patch, please include the following information with
4417it:
wdenkc6097192002-11-03 00:24:07 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419* For bug fixes: a description of the bug and how your patch fixes
4420 this bug. Please try to include a way of demonstrating that the
4421 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004422
wdenk2729af92004-05-03 20:45:30 +00004423* For new features: a description of the feature and your
4424 implementation.
wdenkc6097192002-11-03 00:24:07 +00004425
wdenk2729af92004-05-03 20:45:30 +00004426* A CHANGELOG entry as plaintext (separate from the patch)
4427
4428* For major contributions, your entry to the CREDITS file
4429
4430* When you add support for a new board, don't forget to add this
4431 board to the MAKEALL script, too.
4432
4433* If your patch adds new configuration options, don't forget to
4434 document these in the README file.
4435
Wolfgang Denk218ca722008-03-26 10:40:12 +01004436* The patch itself. If you are using git (which is *strongly*
4437 recommended) you can easily generate the patch using the
4438 "git-format-patch". If you then use "git-send-email" to send it to
4439 the U-Boot mailing list, you will avoid most of the common problems
4440 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004441
Wolfgang Denk218ca722008-03-26 10:40:12 +01004442 If you cannot use git, use "diff -purN OLD NEW". If your version of
4443 diff does not support these options, then get the latest version of
4444 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004445
Wolfgang Denk218ca722008-03-26 10:40:12 +01004446 The current directory when running this command shall be the parent
4447 directory of the U-Boot source tree (i. e. please make sure that
4448 your patch includes sufficient directory information for the
4449 affected files).
4450
4451 We prefer patches as plain text. MIME attachments are discouraged,
4452 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004453
4454* If one logical set of modifications affects or creates several
4455 files, all these changes shall be submitted in a SINGLE patch file.
4456
4457* Changesets that contain different, unrelated modifications shall be
4458 submitted as SEPARATE patches, one patch per changeset.
4459
4460
4461Notes:
4462
4463* Before sending the patch, run the MAKEALL script on your patched
4464 source tree and make sure that no errors or warnings are reported
4465 for any of the boards.
4466
4467* Keep your modifications to the necessary minimum: A patch
4468 containing several unrelated changes or arbitrary reformats will be
4469 returned with a request to re-formatting / split it.
4470
4471* If you modify existing code, make sure that your new code does not
4472 add to the memory footprint of the code ;-) Small is beautiful!
4473 When adding new features, these should compile conditionally only
4474 (using #ifdef), and the resulting code with the new feature
4475 disabled must not need more memory than the old code without your
4476 modification.
wdenk90dc6702005-05-03 14:12:25 +00004477
Wolfgang Denk06682362008-12-30 22:56:11 +01004478* Remember that there is a size limit of 100 kB per message on the
4479 u-boot mailing list. Bigger patches will be moderated. If they are
4480 reasonable and not too big, they will be acknowledged. But patches
4481 bigger than the size limit should be avoided.