blob: 3a8938f4e3cb6d52a9ad16a707f35f6e43d796ce [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
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200151 /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
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /nios2 Files generic to Altera NIOS2 architecture
186 /cpu CPU specific files
187 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200188 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500189 /cpu CPU specific files
190 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
191 /mpc5xx Files specific to Freescale MPC5xx CPUs
192 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
193 /mpc8xx Files specific to Freescale MPC8xx CPUs
194 /mpc8220 Files specific to Freescale MPC8220 CPUs
195 /mpc824x Files specific to Freescale MPC824x CPUs
196 /mpc8260 Files specific to Freescale MPC8260 CPUs
197 /mpc85xx Files specific to Freescale MPC85xx CPUs
198 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
199 /lib Architecture specific library files
200 /sh Files generic to SH architecture
201 /cpu CPU specific files
202 /sh2 Files specific to sh2 CPUs
203 /sh3 Files specific to sh3 CPUs
204 /sh4 Files specific to sh4 CPUs
205 /lib Architecture specific library files
206 /sparc Files generic to SPARC architecture
207 /cpu CPU specific files
208 /leon2 Files specific to Gaisler LEON2 SPARC CPU
209 /leon3 Files specific to Gaisler LEON3 SPARC CPU
210 /lib Architecture specific library files
211/api Machine/arch independent API for external apps
212/board Board dependent files
213/common Misc architecture independent functions
214/disk Code for disk drive partition handling
215/doc Documentation (don't expect too much)
216/drivers Commonly used device drivers
217/examples Example code for standalone applications, etc.
218/fs Filesystem code (cramfs, ext2, jffs2, etc.)
219/include Header Files
220/lib Files generic to all architectures
221 /libfdt Library files to support flattened device trees
222 /lzma Library files to support LZMA decompression
223 /lzo Library files to support LZO decompression
224/net Networking code
225/post Power On Self Test
226/rtc Real Time Clock drivers
227/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000228
wdenkc6097192002-11-03 00:24:07 +0000229Software Configuration:
230=======================
231
232Configuration is usually done using C preprocessor defines; the
233rationale behind that is to avoid dead code whenever possible.
234
235There are two classes of configuration variables:
236
237* Configuration _OPTIONS_:
238 These are selectable by the user and have names beginning with
239 "CONFIG_".
240
241* Configuration _SETTINGS_:
242 These depend on the hardware etc. and should not be meddled with if
243 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200244 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000245
246Later we will add a configuration tool - probably similar to or even
247identical to what's used for the Linux kernel. Right now, we have to
248do the configuration by hand, which means creating some symbolic
249links and editing some configuration files. We use the TQM8xxL boards
250as an example here.
251
252
253Selection of Processor Architecture and Board Type:
254---------------------------------------------------
255
256For all supported boards there are ready-to-use default
257configurations available; just type "make <board_name>_config".
258
259Example: For a TQM823L module type:
260
261 cd u-boot
262 make TQM823L_config
263
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200264For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000265e.g. "make cogent_mpc8xx_config". And also configure the cogent
266directory according to the instructions in cogent/README.
267
268
269Configuration Options:
270----------------------
271
272Configuration depends on the combination of board and CPU type; all
273such information is kept in a configuration file
274"include/configs/<board_name>.h".
275
276Example: For a TQM823L module, all configuration settings are in
277"include/configs/TQM823L.h".
278
279
wdenk7f6c2cb2002-11-10 22:06:23 +0000280Many of the options are named exactly as the corresponding Linux
281kernel configuration options. The intention is to make it easier to
282build a config tool - later.
283
284
wdenkc6097192002-11-03 00:24:07 +0000285The following options need to be configured:
286
Kim Phillips26281142007-08-10 13:28:25 -0500287- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000288
Kim Phillips26281142007-08-10 13:28:25 -0500289- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200290
291- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100292 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000293
294- CPU Module Type: (if CONFIG_COGENT is defined)
295 Define exactly one of
296 CONFIG_CMA286_60_OLD
297--- FIXME --- not tested yet:
298 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
299 CONFIG_CMA287_23, CONFIG_CMA287_50
300
301- Motherboard Type: (if CONFIG_COGENT is defined)
302 Define exactly one of
303 CONFIG_CMA101, CONFIG_CMA102
304
305- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
306 Define one or more of
307 CONFIG_CMA302
308
309- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
310 Define one or more of
311 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200312 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000313 a "rotator" |\-/|\-/
314
wdenk2535d602003-07-17 23:16:40 +0000315- Board flavour: (if CONFIG_MPC8260ADS is defined)
316 CONFIG_ADSTYPE
317 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200318 CONFIG_SYS_8260ADS - original MPC8260ADS
319 CONFIG_SYS_8266ADS - MPC8266ADS
320 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
321 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000322
Lei Wencf946c62011-02-09 18:06:58 +0530323- Marvell Family Member
324 CONFIG_SYS_MVFS - define it if you want to enable
325 multiple fs option at one time
326 for marvell soc family
327
wdenkc6097192002-11-03 00:24:07 +0000328- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000329 Define exactly one of
330 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000331
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200332- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000333 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
334 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000335 e.g. if there is no 32KHz
336 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000337 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
338 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000339
wdenk66ca92a2004-09-28 17:59:53 +0000340- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200341 CONFIG_SYS_8xx_CPUCLK_MIN
342 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000343 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000344 See doc/README.MPC866
345
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000347
wdenkba56f622004-02-06 23:19:44 +0000348 Define this to measure the actual CPU clock instead
349 of relying on the correctness of the configured
350 values. Mostly useful for board bringup to make sure
351 the PLL is locked at the intended frequency. Note
352 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200353 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000354
Heiko Schocher506f3912009-03-12 07:37:15 +0100355 CONFIG_SYS_DELAYED_ICACHE
356
357 Define this option if you want to enable the
358 ICache only when Code runs from RAM.
359
Kumar Gala66412c62011-02-18 05:40:54 -0600360- 85xx CPU Options:
361 CONFIG_SYS_FSL_TBCLK_DIV
362
363 Defines the core time base clock divider ratio compared to the
364 system clock. On most PQ3 devices this is 8, on newer QorIQ
365 devices it can be 16 or 32. The ratio varies from SoC to Soc.
366
Kumar Gala8f290842011-05-20 00:39:21 -0500367 CONFIG_SYS_FSL_PCIE_COMPAT
368
369 Defines the string to utilize when trying to match PCIe device
370 tree nodes for the given platform.
371
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100372- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200373 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100374
375 Defines the Monahans run mode to oscillator
376 ratio. Valid values are 8, 16, 24, 31. The core
377 frequency is this value multiplied by 13 MHz.
378
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200379 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200380
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100381 Defines the Monahans turbo mode to oscillator
382 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200383 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100384 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200385
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200386- MIPS CPU options:
387 CONFIG_SYS_INIT_SP_OFFSET
388
389 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
390 pointer. This is needed for the temporary stack before
391 relocation.
392
393 CONFIG_SYS_MIPS_CACHE_MODE
394
395 Cache operation mode for the MIPS CPU.
396 See also arch/mips/include/asm/mipsregs.h.
397 Possible values are:
398 CONF_CM_CACHABLE_NO_WA
399 CONF_CM_CACHABLE_WA
400 CONF_CM_UNCACHED
401 CONF_CM_CACHABLE_NONCOHERENT
402 CONF_CM_CACHABLE_CE
403 CONF_CM_CACHABLE_COW
404 CONF_CM_CACHABLE_CUW
405 CONF_CM_CACHABLE_ACCELERATED
406
407 CONFIG_SYS_XWAY_EBU_BOOTCFG
408
409 Special option for Lantiq XWAY SoCs for booting from NOR flash.
410 See also arch/mips/cpu/mips32/start.S.
411
412 CONFIG_XWAY_SWAP_BYTES
413
414 Enable compilation of tools/xway-swap-bytes needed for Lantiq
415 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
416 be swapped if a flash programmer is used.
417
wdenk5da627a2003-10-09 20:09:04 +0000418- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000419 CONFIG_CLOCKS_IN_MHZ
420
421 U-Boot stores all clock information in Hz
422 internally. For binary compatibility with older Linux
423 kernels (which expect the clocks passed in the
424 bd_info data to be in MHz) the environment variable
425 "clocks_in_mhz" can be defined so that U-Boot
426 converts clock data to MHZ before passing it to the
427 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000428 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100429 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000430 default environment.
431
wdenk5da627a2003-10-09 20:09:04 +0000432 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
433
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200434 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000435 expect it to be in bytes, others in MB.
436 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
437
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400438 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200439
440 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400441 passed using flattened device trees (based on open firmware
442 concepts).
443
444 CONFIG_OF_LIBFDT
445 * New libfdt-based support
446 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500447 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400448
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200449 OF_CPU - The proper name of the cpus node (only required for
450 MPC512X and MPC5xxx based boards).
451 OF_SOC - The proper name of the soc node (only required for
452 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200453 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600454 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200455
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200456 boards with QUICC Engines require OF_QE to set UCC MAC
457 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500458
Kumar Gala4e253132006-01-11 13:54:17 -0600459 CONFIG_OF_BOARD_SETUP
460
461 Board code has addition modification that it wants to make
462 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000463
Matthew McClintock02677682006-06-28 10:41:37 -0500464 CONFIG_OF_BOOT_CPU
465
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200466 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500467 param header, the default value is zero if undefined.
468
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200469 CONFIG_OF_IDE_FIXUP
470
471 U-Boot can detect if an IDE device is present or not.
472 If not, and this new config option is activated, U-Boot
473 removes the ATA node from the DTS before booting Linux,
474 so the Linux IDE driver does not probe the device and
475 crash. This is needed for buggy hardware (uc101) where
476 no pull down resistor is connected to the signal IDE5V_DD7.
477
Igor Grinberg7eb29392011-07-14 05:45:07 +0000478 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
479
480 This setting is mandatory for all boards that have only one
481 machine type and must be used to specify the machine type
482 number as it appears in the ARM machine registry
483 (see http://www.arm.linux.org.uk/developer/machines/).
484 Only boards that have multiple machine types supported
485 in a single configuration file and the machine type is
486 runtime discoverable, do not have to use this setting.
487
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100488- vxWorks boot parameters:
489
490 bootvx constructs a valid bootline using the following
491 environments variables: bootfile, ipaddr, serverip, hostname.
492 It loads the vxWorks image pointed bootfile.
493
494 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
495 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
496 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
497 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
498
499 CONFIG_SYS_VXWORKS_ADD_PARAMS
500
501 Add it at the end of the bootline. E.g "u=username pw=secret"
502
503 Note: If a "bootargs" environment is defined, it will overwride
504 the defaults discussed just above.
505
Aneesh V2c451f72011-06-16 23:30:47 +0000506- Cache Configuration:
507 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
508 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
509 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
510
Aneesh V93bc2192011-06-16 23:30:51 +0000511- Cache Configuration for ARM:
512 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
513 controller
514 CONFIG_SYS_PL310_BASE - Physical base address of PL310
515 controller register space
516
wdenk6705d812004-08-02 23:22:59 +0000517- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200518 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000519
520 Define this if you want support for Amba PrimeCell PL010 UARTs.
521
Andreas Engel48d01922008-09-08 14:30:53 +0200522 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000523
524 Define this if you want support for Amba PrimeCell PL011 UARTs.
525
526 CONFIG_PL011_CLOCK
527
528 If you have Amba PrimeCell PL011 UARTs, set this variable to
529 the clock speed of the UARTs.
530
531 CONFIG_PL01x_PORTS
532
533 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
534 define this to a list of base addresses for each (supported)
535 port. See e.g. include/configs/versatile.h
536
John Rigby910f1ae2011-04-19 10:42:39 +0000537 CONFIG_PL011_SERIAL_RLCR
538
539 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
540 have separate receive and transmit line control registers. Set
541 this variable to initialize the extra register.
542
543 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
544
545 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
546 boot loader that has already initialized the UART. Define this
547 variable to flush the UART at init time.
548
wdenk6705d812004-08-02 23:22:59 +0000549
wdenkc6097192002-11-03 00:24:07 +0000550- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000551 Depending on board, define exactly one serial port
552 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
553 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
554 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000555
556 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
557 port routines must be defined elsewhere
558 (i.e. serial_init(), serial_getc(), ...)
559
560 CONFIG_CFB_CONSOLE
561 Enables console device for a color framebuffer. Needs following
562 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
563 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
564 (default big endian)
565 VIDEO_HW_RECTFILL graphic chip supports
566 rectangle fill
567 (cf. smiLynxEM)
568 VIDEO_HW_BITBLT graphic chip supports
569 bit-blit (cf. smiLynxEM)
570 VIDEO_VISIBLE_COLS visible pixel columns
571 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000572 VIDEO_VISIBLE_ROWS visible pixel rows
573 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000574 VIDEO_DATA_FORMAT graphic data format
575 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000576 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000577 VIDEO_KBD_INIT_FCT keyboard int fct
578 (i.e. i8042_kbd_init())
579 VIDEO_TSTC_FCT test char fct
580 (i.e. i8042_tstc)
581 VIDEO_GETC_FCT get char fct
582 (i.e. i8042_getc)
583 CONFIG_CONSOLE_CURSOR cursor drawing on/off
584 (requires blink timer
585 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200586 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000587 CONFIG_CONSOLE_TIME display time/date info in
588 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500589 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000590 CONFIG_VIDEO_LOGO display Linux logo in
591 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000592 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
593 linux_logo.h for logo.
594 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000595 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200596 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000597 the logo
598
wdenk43d96162003-03-06 00:02:04 +0000599 When CONFIG_CFB_CONSOLE is defined, video console is
600 default i/o. Serial console can be forced with
601 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000602
wdenkd4ca31c2004-01-02 14:00:00 +0000603 When CONFIG_SILENT_CONSOLE is defined, all console
604 messages (by U-Boot and Linux!) can be silenced with
605 the "silent" environment variable. See
606 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000607
wdenkc6097192002-11-03 00:24:07 +0000608- Console Baudrate:
609 CONFIG_BAUDRATE - in bps
610 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200611 CONFIG_SYS_BAUDRATE_TABLE, see below.
612 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000613
Heiko Schocherc92fac92009-01-30 12:55:38 +0100614- Console Rx buffer length
615 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
616 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100617 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100618 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
619 must be defined, to setup the maximum idle timeout for
620 the SMC.
621
Graeme Russ9558b482011-09-01 00:48:27 +0000622- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200623 Prior to the console being initialised (i.e. serial UART
624 initialised etc) all console output is silently discarded.
625 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
626 buffer any console messages prior to the console being
627 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
628 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
629 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200630 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200631 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000632
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200633 'Sane' compilers will generate smaller code if
634 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000635
wdenkc6097192002-11-03 00:24:07 +0000636- Boot Delay: CONFIG_BOOTDELAY - in seconds
637 Delay before automatically booting the default image;
638 set to -1 to disable autoboot.
639
640 See doc/README.autoboot for these options that
641 work with CONFIG_BOOTDELAY. None are required.
642 CONFIG_BOOT_RETRY_TIME
643 CONFIG_BOOT_RETRY_MIN
644 CONFIG_AUTOBOOT_KEYED
645 CONFIG_AUTOBOOT_PROMPT
646 CONFIG_AUTOBOOT_DELAY_STR
647 CONFIG_AUTOBOOT_STOP_STR
648 CONFIG_AUTOBOOT_DELAY_STR2
649 CONFIG_AUTOBOOT_STOP_STR2
650 CONFIG_ZERO_BOOTDELAY_CHECK
651 CONFIG_RESET_TO_RETRY
652
653- Autoboot Command:
654 CONFIG_BOOTCOMMAND
655 Only needed when CONFIG_BOOTDELAY is enabled;
656 define a command string that is automatically executed
657 when no character is read on the console interface
658 within "Boot Delay" after reset.
659
660 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000661 This can be used to pass arguments to the bootm
662 command. The value of CONFIG_BOOTARGS goes into the
663 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000664
665 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000666 The value of these goes into the environment as
667 "ramboot" and "nfsboot" respectively, and can be used
668 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200669 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000670
671- Pre-Boot Commands:
672 CONFIG_PREBOOT
673
674 When this option is #defined, the existence of the
675 environment variable "preboot" will be checked
676 immediately before starting the CONFIG_BOOTDELAY
677 countdown and/or running the auto-boot command resp.
678 entering interactive mode.
679
680 This feature is especially useful when "preboot" is
681 automatically generated or modified. For an example
682 see the LWMON board specific code: here "preboot" is
683 modified when the user holds down a certain
684 combination of keys on the (special) keyboard when
685 booting the systems
686
687- Serial Download Echo Mode:
688 CONFIG_LOADS_ECHO
689 If defined to 1, all characters received during a
690 serial download (using the "loads" command) are
691 echoed back. This might be needed by some terminal
692 emulations (like "cu"), but may as well just take
693 time on others. This setting #define's the initial
694 value of the "loads_echo" environment variable.
695
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500696- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000697 CONFIG_KGDB_BAUDRATE
698 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200699 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000700
701- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500702 Monitor commands can be included or excluded
703 from the build by using the #include files
704 "config_cmd_all.h" and #undef'ing unwanted
705 commands, or using "config_cmd_default.h"
706 and augmenting with additional #define's
707 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000708
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500709 The default command configuration includes all commands
710 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000711
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500712 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500713 CONFIG_CMD_BDI bdinfo
714 CONFIG_CMD_BEDBUG * Include BedBug Debugger
715 CONFIG_CMD_BMP * BMP support
716 CONFIG_CMD_BSP * Board specific commands
717 CONFIG_CMD_BOOTD bootd
718 CONFIG_CMD_CACHE * icache, dcache
719 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500720 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500721 CONFIG_CMD_DATE * support for RTC, date/time...
722 CONFIG_CMD_DHCP * DHCP support
723 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600724 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
725 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
726 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
727 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500728 CONFIG_CMD_DTT * Digital Therm and Thermostat
729 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500730 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500731 CONFIG_CMD_EEPROM * EEPROM read/write support
732 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500733 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500734 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500735 CONFIG_CMD_FDC * Floppy Disk Support
736 CONFIG_CMD_FAT * FAT partition support
737 CONFIG_CMD_FDOS * Dos diskette Support
738 CONFIG_CMD_FLASH flinfo, erase, protect
739 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500740 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000741 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500742 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
743 CONFIG_CMD_I2C * I2C serial bus support
744 CONFIG_CMD_IDE * IDE harddisk support
745 CONFIG_CMD_IMI iminfo
746 CONFIG_CMD_IMLS List all found images
747 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500748 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500749 CONFIG_CMD_IRQ * irqinfo
750 CONFIG_CMD_ITEST Integer/string test of 2 values
751 CONFIG_CMD_JFFS2 * JFFS2 Support
752 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500753 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754 CONFIG_CMD_LOADB loadb
755 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400756 CONFIG_CMD_MD5SUM print md5 message digest
757 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500758 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
759 loop, loopw, mtest
760 CONFIG_CMD_MISC Misc functions like sleep etc
761 CONFIG_CMD_MMC * MMC memory mapped support
762 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100763 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500764 CONFIG_CMD_NAND * NAND support
765 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600766 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
767 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500768 CONFIG_CMD_PCI * pciinfo
769 CONFIG_CMD_PCMCIA * PCMCIA support
770 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
771 host
772 CONFIG_CMD_PORTIO * Port I/O
773 CONFIG_CMD_REGINFO * Register dump
774 CONFIG_CMD_RUN run command in env variable
775 CONFIG_CMD_SAVES * save S record dump
776 CONFIG_CMD_SCSI * SCSI Support
777 CONFIG_CMD_SDRAM * print SDRAM configuration information
778 (requires CONFIG_CMD_I2C)
779 CONFIG_CMD_SETGETDCR Support for DCR Register access
780 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100781 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400782 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200783 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500784 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000785 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Che-liang Chiouca366d02011-10-06 23:40:48 +0000786 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500787 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500788 CONFIG_CMD_CDP * Cisco Discover Protocol support
789 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000790
wdenkc6097192002-11-03 00:24:07 +0000791
792 EXAMPLE: If you want all functions except of network
793 support you can write:
794
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500795 #include "config_cmd_all.h"
796 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000797
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400798 Other Commands:
799 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000800
801 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500802 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000803 what you (and your U-Boot users) are doing. Data
804 cache cannot be enabled on systems like the 8xx or
805 8260 (where accesses to the IMMR region must be
806 uncached), and it cannot be disabled on all other
807 systems where we (mis-) use the data cache to hold an
808 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000809
810
811 XXX - this list needs to get updated!
812
813- Watchdog:
814 CONFIG_WATCHDOG
815 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000816 support for the SoC. There must be support in the SoC
817 specific code for a watchdog. For the 8xx and 8260
818 CPUs, the SIU Watchdog feature is enabled in the SYPCR
819 register. When supported for a specific SoC is
820 available, then no further board specific code should
821 be needed to use it.
822
823 CONFIG_HW_WATCHDOG
824 When using a watchdog circuitry external to the used
825 SoC, then define this variable and provide board
826 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000827
stroesec1551ea2003-04-04 15:53:41 +0000828- U-Boot Version:
829 CONFIG_VERSION_VARIABLE
830 If this variable is defined, an environment variable
831 named "ver" is created by U-Boot showing the U-Boot
832 version as printed by the "version" command.
833 This variable is readonly.
834
wdenkc6097192002-11-03 00:24:07 +0000835- Real-Time Clock:
836
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500837 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000838 has to be selected, too. Define exactly one of the
839 following options:
840
841 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
842 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200843 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000844 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000845 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000846 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000847 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000848 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100849 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000850 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200851 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200852 CONFIG_SYS_RV3029_TCR - enable trickle charger on
853 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000854
wdenkb37c7e52003-06-30 16:24:52 +0000855 Note that if the RTC uses I2C, then the I2C interface
856 must also be configured. See I2C Support, below.
857
Peter Tysere92739d2008-12-17 16:36:21 -0600858- GPIO Support:
859 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
860 CONFIG_PCA953X_INFO - enable pca953x info command
861
Chris Packham5dec49c2010-12-19 10:12:13 +0000862 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
863 chip-ngpio pairs that tell the PCA953X driver the number of
864 pins supported by a particular chip.
865
Peter Tysere92739d2008-12-17 16:36:21 -0600866 Note that if the GPIO device uses I2C, then the I2C interface
867 must also be configured. See I2C Support, below.
868
wdenkc6097192002-11-03 00:24:07 +0000869- Timestamp Support:
870
wdenk43d96162003-03-06 00:02:04 +0000871 When CONFIG_TIMESTAMP is selected, the timestamp
872 (date and time) of an image is printed by image
873 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500874 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000875
876- Partition Support:
877 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400878 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000879
Wolfgang Denk218ca722008-03-26 10:40:12 +0100880 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
881 CONFIG_CMD_SCSI) you must configure support for at
882 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000883
884- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000885 CONFIG_IDE_RESET_ROUTINE - this is defined in several
886 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000887
wdenk4d13cba2004-03-14 14:09:05 +0000888 CONFIG_IDE_RESET - is this is defined, IDE Reset will
889 be performed by calling the function
890 ide_set_reset(int reset)
891 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000892
893- ATAPI Support:
894 CONFIG_ATAPI
895
896 Set this to enable ATAPI support.
897
wdenkc40b2952004-03-13 23:29:43 +0000898- LBA48 Support
899 CONFIG_LBA48
900
901 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100902 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000903 Whithout these , LBA48 support uses 32bit variables and will 'only'
904 support disks up to 2.1TB.
905
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200906 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000907 When enabled, makes the IDE subsystem use 64bit sector addresses.
908 Default is 32bit.
909
wdenkc6097192002-11-03 00:24:07 +0000910- SCSI Support:
911 At the moment only there is only support for the
912 SYM53C8XX SCSI controller; define
913 CONFIG_SCSI_SYM53C8XX to enable it.
914
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200915 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
916 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
917 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000918 maximum numbers of LUNs, SCSI ID's and target
919 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200920 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000921
922- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000923 CONFIG_E1000
924 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000925
Andre Schwarzac3315c2008-03-06 16:45:44 +0100926 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200927 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100928
wdenkc6097192002-11-03 00:24:07 +0000929 CONFIG_EEPRO100
930 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200931 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000932 write routine for first time initialisation.
933
934 CONFIG_TULIP
935 Support for Digital 2114x chips.
936 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
937 modem chip initialisation (KS8761/QS6611).
938
939 CONFIG_NATSEMI
940 Support for National dp83815 chips.
941
942 CONFIG_NS8382X
943 Support for National dp8382[01] gigabit chips.
944
wdenk45219c42003-05-12 21:50:16 +0000945- NETWORK Support (other):
946
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100947 CONFIG_DRIVER_AT91EMAC
948 Support for AT91RM9200 EMAC.
949
950 CONFIG_RMII
951 Define this to use reduced MII inteface
952
953 CONFIG_DRIVER_AT91EMAC_QUIET
954 If this defined, the driver is quiet.
955 The driver doen't show link status messages.
956
wdenk45219c42003-05-12 21:50:16 +0000957 CONFIG_DRIVER_LAN91C96
958 Support for SMSC's LAN91C96 chips.
959
960 CONFIG_LAN91C96_BASE
961 Define this to hold the physical address
962 of the LAN91C96's I/O space
963
964 CONFIG_LAN91C96_USE_32_BIT
965 Define this to enable 32 bit addressing
966
wdenkf39748a2004-06-09 13:37:52 +0000967 CONFIG_DRIVER_SMC91111
968 Support for SMSC's LAN91C111 chip
969
970 CONFIG_SMC91111_BASE
971 Define this to hold the physical address
972 of the device (I/O space)
973
974 CONFIG_SMC_USE_32_BIT
975 Define this if data bus is 32 bits
976
977 CONFIG_SMC_USE_IOFUNCS
978 Define this to use i/o functions instead of macros
979 (some hardware wont work with macros)
980
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800981 CONFIG_FTGMAC100
982 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
983
984 CONFIG_FTGMAC100_EGIGA
985 Define this to use GE link update with gigabit PHY.
986 Define this if FTGMAC100 is connected to gigabit PHY.
987 If your system has 10/100 PHY only, it might not occur
988 wrong behavior. Because PHY usually return timeout or
989 useless data when polling gigabit status and gigabit
990 control registers. This behavior won't affect the
991 correctnessof 10/100 link speed update.
992
Mike Rapoportc2fff332009-11-11 10:03:03 +0200993 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200994 Support for SMSC's LAN911x and LAN921x chips
995
Mike Rapoportc2fff332009-11-11 10:03:03 +0200996 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200997 Define this to hold the physical address
998 of the device (I/O space)
999
Mike Rapoportc2fff332009-11-11 10:03:03 +02001000 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001001 Define this if data bus is 32 bits
1002
Mike Rapoportc2fff332009-11-11 10:03:03 +02001003 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001004 Define this if data bus is 16 bits. If your processor
1005 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001006 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001007
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001008 CONFIG_SH_ETHER
1009 Support for Renesas on-chip Ethernet controller
1010
1011 CONFIG_SH_ETHER_USE_PORT
1012 Define the number of ports to be used
1013
1014 CONFIG_SH_ETHER_PHY_ADDR
1015 Define the ETH PHY's address
1016
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001017 CONFIG_SH_ETHER_CACHE_WRITEBACK
1018 If this option is set, the driver enables cache flush.
1019
wdenkc6097192002-11-03 00:24:07 +00001020- USB Support:
1021 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001022 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001023 CONFIG_USB_UHCI to enable it.
1024 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001025 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001026 storage devices.
1027 Note:
1028 Supported are USB Keyboards and USB Floppy drives
1029 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001030 MPC5200 USB requires additional defines:
1031 CONFIG_USB_CLOCK
1032 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001033 CONFIG_PSC3_USB
1034 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001035 CONFIG_USB_CONFIG
1036 for differential drivers: 0x00001000
1037 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001038 for differential drivers on PSC3: 0x00000100
1039 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001040 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001041 May be defined to allow interrupt polling
1042 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001043
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001044- USB Device:
1045 Define the below if you wish to use the USB console.
1046 Once firmware is rebuilt from a serial console issue the
1047 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001048 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001049 it has found a new device. The environment variable usbtty
1050 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001051 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001052 Common Device Class Abstract Control Model serial device.
1053 If you select usbtty = gserial you should be able to enumerate
1054 a Linux host by
1055 # modprobe usbserial vendor=0xVendorID product=0xProductID
1056 else if using cdc_acm, simply setting the environment
1057 variable usbtty to be cdc_acm should suffice. The following
1058 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001059
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001060 CONFIG_USB_DEVICE
1061 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001062
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001063 CONFIG_USB_TTY
1064 Define this to have a tty type of device available to
1065 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001066
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001067 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001068 Define this if you want stdin, stdout &/or stderr to
1069 be set to usbtty.
1070
1071 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001072 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001073 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001074 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001075
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001076 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001077 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001078 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001079
Wolfgang Denk386eda02006-06-14 18:14:56 +02001080 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001081 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001082 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001083 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1084 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1085 should pretend to be a Linux device to it's target host.
1086
1087 CONFIG_USBD_MANUFACTURER
1088 Define this string as the name of your company for
1089 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001090
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001091 CONFIG_USBD_PRODUCT_NAME
1092 Define this string as the name of your product
1093 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1094
1095 CONFIG_USBD_VENDORID
1096 Define this as your assigned Vendor ID from the USB
1097 Implementors Forum. This *must* be a genuine Vendor ID
1098 to avoid polluting the USB namespace.
1099 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001100
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001101 CONFIG_USBD_PRODUCTID
1102 Define this as the unique Product ID
1103 for your device
1104 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001105
1106
1107- MMC Support:
1108 The MMC controller on the Intel PXA is supported. To
1109 enable this define CONFIG_MMC. The MMC can be
1110 accessed from the boot prompt by mapping the device
1111 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001112 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1113 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001114
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001115 CONFIG_SH_MMCIF
1116 Support for Renesas on-chip MMCIF controller
1117
1118 CONFIG_SH_MMCIF_ADDR
1119 Define the base address of MMCIF registers
1120
1121 CONFIG_SH_MMCIF_CLK
1122 Define the clock frequency for MMCIF
1123
wdenk6705d812004-08-02 23:22:59 +00001124- Journaling Flash filesystem support:
1125 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1126 CONFIG_JFFS2_NAND_DEV
1127 Define these for a default partition on a NAND device
1128
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001129 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1130 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001131 Define these for a default partition on a NOR device
1132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001133 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001134 Define this to create an own partition. You have to provide a
1135 function struct part_info* jffs2_part_info(int part_num)
1136
1137 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001138 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001139 to disable the command chpart. This is the default when you
1140 have not defined a custom partition
1141
wdenkc6097192002-11-03 00:24:07 +00001142- Keyboard Support:
1143 CONFIG_ISA_KEYBOARD
1144
1145 Define this to enable standard (PC-Style) keyboard
1146 support
1147
1148 CONFIG_I8042_KBD
1149 Standard PC keyboard driver with US (is default) and
1150 GERMAN key layout (switch via environment 'keymap=de') support.
1151 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1152 for cfb_console. Supports cursor blinking.
1153
1154- Video support:
1155 CONFIG_VIDEO
1156
1157 Define this to enable video support (for output to
1158 video).
1159
1160 CONFIG_VIDEO_CT69000
1161
1162 Enable Chips & Technologies 69000 Video chip
1163
1164 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001165 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001166 video output is selected via environment 'videoout'
1167 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1168 assumed.
wdenkc6097192002-11-03 00:24:07 +00001169
wdenkb79a11c2004-03-25 15:14:43 +00001170 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001171 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001172 are possible:
1173 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001174 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001175
1176 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1177 -------------+---------------------------------------------
1178 8 bits | 0x301* 0x303 0x305 0x161 0x307
1179 15 bits | 0x310 0x313 0x316 0x162 0x319
1180 16 bits | 0x311 0x314 0x317 0x163 0x31A
1181 24 bits | 0x312 0x315 0x318 ? 0x31B
1182 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001183 (i.e. setenv videomode 317; saveenv; reset;)
1184
wdenkb79a11c2004-03-25 15:14:43 +00001185 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001186 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001187
1188
stroesec1551ea2003-04-04 15:53:41 +00001189 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001190 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001191 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1192 or CONFIG_VIDEO_SED13806_16BPP
1193
Timur Tabi7d3053f2011-02-15 17:09:19 -06001194 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001195 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001196 SOCs that have a DIU should define this macro to enable DIU
1197 support, and should also define these other macros:
1198
1199 CONFIG_SYS_DIU_ADDR
1200 CONFIG_VIDEO
1201 CONFIG_CMD_BMP
1202 CONFIG_CFB_CONSOLE
1203 CONFIG_VIDEO_SW_CURSOR
1204 CONFIG_VGA_AS_SINGLE_DEVICE
1205 CONFIG_VIDEO_LOGO
1206 CONFIG_VIDEO_BMP_LOGO
1207
Timur Tabiba8e76b2011-04-11 14:18:22 -05001208 The DIU driver will look for the 'video-mode' environment
1209 variable, and if defined, enable the DIU as a console during
1210 boot. See the documentation file README.video for a
1211 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001212
wdenk682011f2003-06-03 23:54:09 +00001213- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001214 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001215
wdenk8bde7f72003-06-27 21:31:46 +00001216 Define this to enable a custom keyboard support.
1217 This simply calls drv_keyboard_init() which must be
1218 defined in your board-specific files.
1219 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001220
wdenkc6097192002-11-03 00:24:07 +00001221- LCD Support: CONFIG_LCD
1222
1223 Define this to enable LCD support (for output to LCD
1224 display); also select one of the supported displays
1225 by defining one of these:
1226
Stelian Pop39cf4802008-05-09 21:57:18 +02001227 CONFIG_ATMEL_LCD:
1228
1229 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1230
wdenkfd3103b2003-11-25 16:55:19 +00001231 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001232
wdenkfd3103b2003-11-25 16:55:19 +00001233 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001234
wdenkfd3103b2003-11-25 16:55:19 +00001235 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001236
wdenkfd3103b2003-11-25 16:55:19 +00001237 NEC NL6448BC20-08. 6.5", 640x480.
1238 Active, color, single scan.
1239
1240 CONFIG_NEC_NL6448BC33_54
1241
1242 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001243 Active, color, single scan.
1244
1245 CONFIG_SHARP_16x9
1246
1247 Sharp 320x240. Active, color, single scan.
1248 It isn't 16x9, and I am not sure what it is.
1249
1250 CONFIG_SHARP_LQ64D341
1251
1252 Sharp LQ64D341 display, 640x480.
1253 Active, color, single scan.
1254
1255 CONFIG_HLD1045
1256
1257 HLD1045 display, 640x480.
1258 Active, color, single scan.
1259
1260 CONFIG_OPTREX_BW
1261
1262 Optrex CBL50840-2 NF-FW 99 22 M5
1263 or
1264 Hitachi LMG6912RPFC-00T
1265 or
1266 Hitachi SP14Q002
1267
1268 320x240. Black & white.
1269
1270 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001271 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001272
wdenk7152b1d2003-09-05 23:19:14 +00001273- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001274
wdenk8bde7f72003-06-27 21:31:46 +00001275 If this option is set, the environment is checked for
1276 a variable "splashimage". If found, the usual display
1277 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001278 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001279 specified in "splashimage" is loaded instead. The
1280 console is redirected to the "nulldev", too. This
1281 allows for a "silent" boot where a splash screen is
1282 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001283
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001284 CONFIG_SPLASH_SCREEN_ALIGN
1285
1286 If this option is set the splash image can be freely positioned
1287 on the screen. Environment variable "splashpos" specifies the
1288 position as "x,y". If a positive number is given it is used as
1289 number of pixel from left/top. If a negative number is given it
1290 is used as number of pixel from right/bottom. You can also
1291 specify 'm' for centering the image.
1292
1293 Example:
1294 setenv splashpos m,m
1295 => image at center of screen
1296
1297 setenv splashpos 30,20
1298 => image at x = 30 and y = 20
1299
1300 setenv splashpos -10,m
1301 => vertically centered image
1302 at x = dspWidth - bmpWidth - 9
1303
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001304- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1305
1306 If this option is set, additionally to standard BMP
1307 images, gzipped BMP images can be displayed via the
1308 splashscreen support or the bmp command.
1309
Anatolij Gustschind5011762010-03-15 14:50:25 +01001310- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1311
1312 If this option is set, 8-bit RLE compressed BMP images
1313 can be displayed via the splashscreen support or the
1314 bmp command.
1315
wdenkc29fdfc2003-08-29 20:57:53 +00001316- Compression support:
1317 CONFIG_BZIP2
1318
1319 If this option is set, support for bzip2 compressed
1320 images is included. If not, only uncompressed and gzip
1321 compressed images are supported.
1322
wdenk42d1f032003-10-15 23:53:47 +00001323 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001324 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001325 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001326
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001327 CONFIG_LZMA
1328
1329 If this option is set, support for lzma compressed
1330 images is included.
1331
1332 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1333 requires an amount of dynamic memory that is given by the
1334 formula:
1335
1336 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1337
1338 Where lc and lp stand for, respectively, Literal context bits
1339 and Literal pos bits.
1340
1341 This value is upper-bounded by 14MB in the worst case. Anyway,
1342 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1343 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1344 a very small buffer.
1345
1346 Use the lzmainfo tool to determinate the lc and lp values and
1347 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001348 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001349
wdenk17ea1172004-06-06 21:51:03 +00001350- MII/PHY support:
1351 CONFIG_PHY_ADDR
1352
1353 The address of PHY on MII bus.
1354
1355 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1356
1357 The clock frequency of the MII bus
1358
1359 CONFIG_PHY_GIGE
1360
1361 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001362 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001363
1364 CONFIG_PHY_RESET_DELAY
1365
1366 Some PHY like Intel LXT971A need extra delay after
1367 reset before any MII register access is possible.
1368 For such PHY, set this option to the usec delay
1369 required. (minimum 300usec for LXT971A)
1370
1371 CONFIG_PHY_CMD_DELAY (ppc4xx)
1372
1373 Some PHY like Intel LXT971A need extra delay after
1374 command issued before MII status register can be read
1375
wdenkc6097192002-11-03 00:24:07 +00001376- Ethernet address:
1377 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001378 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001379 CONFIG_ETH2ADDR
1380 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001381 CONFIG_ETH4ADDR
1382 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001383
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001384 Define a default value for Ethernet address to use
1385 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001386 is not determined automatically.
1387
1388- IP address:
1389 CONFIG_IPADDR
1390
1391 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001392 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001393 determined through e.g. bootp.
1394
1395- Server IP address:
1396 CONFIG_SERVERIP
1397
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001398 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001399 server to contact when using the "tftboot" command.
1400
Robin Getz97cfe862009-07-21 12:15:28 -04001401 CONFIG_KEEP_SERVERADDR
1402
1403 Keeps the server's MAC address, in the env 'serveraddr'
1404 for passing to bootargs (like Linux's netconsole option)
1405
David Updegraff53a5c422007-06-11 10:41:07 -05001406- Multicast TFTP Mode:
1407 CONFIG_MCAST_TFTP
1408
1409 Defines whether you want to support multicast TFTP as per
1410 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001411 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001412 driver in use must provide a function: mcast() to join/leave a
1413 multicast group.
1414
wdenkc6097192002-11-03 00:24:07 +00001415- BOOTP Recovery Mode:
1416 CONFIG_BOOTP_RANDOM_DELAY
1417
1418 If you have many targets in a network that try to
1419 boot using BOOTP, you may want to avoid that all
1420 systems send out BOOTP requests at precisely the same
1421 moment (which would happen for instance at recovery
1422 from a power failure, when all systems will try to
1423 boot, thus flooding the BOOTP server. Defining
1424 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1425 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001426 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001427
1428 1st BOOTP request: delay 0 ... 1 sec
1429 2nd BOOTP request: delay 0 ... 2 sec
1430 3rd BOOTP request: delay 0 ... 4 sec
1431 4th and following
1432 BOOTP requests: delay 0 ... 8 sec
1433
stroesefe389a82003-08-28 14:17:32 +00001434- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001435 You can fine tune the DHCP functionality by defining
1436 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001437
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001438 CONFIG_BOOTP_SUBNETMASK
1439 CONFIG_BOOTP_GATEWAY
1440 CONFIG_BOOTP_HOSTNAME
1441 CONFIG_BOOTP_NISDOMAIN
1442 CONFIG_BOOTP_BOOTPATH
1443 CONFIG_BOOTP_BOOTFILESIZE
1444 CONFIG_BOOTP_DNS
1445 CONFIG_BOOTP_DNS2
1446 CONFIG_BOOTP_SEND_HOSTNAME
1447 CONFIG_BOOTP_NTPSERVER
1448 CONFIG_BOOTP_TIMEOFFSET
1449 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001450
Wilson Callan5d110f02007-07-28 10:56:13 -04001451 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1452 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001453
1454 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1455 serverip from a DHCP server, it is possible that more
1456 than one DNS serverip is offered to the client.
1457 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1458 serverip will be stored in the additional environment
1459 variable "dnsip2". The first DNS serverip is always
1460 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001461 is defined.
stroesefe389a82003-08-28 14:17:32 +00001462
1463 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1464 to do a dynamic update of a DNS server. To do this, they
1465 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001466 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001467 of the "hostname" environment variable is passed as
1468 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001469
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001470 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1471
1472 A 32bit value in microseconds for a delay between
1473 receiving a "DHCP Offer" and sending the "DHCP Request".
1474 This fixes a problem with certain DHCP servers that don't
1475 respond 100% of the time to a "DHCP request". E.g. On an
1476 AT91RM9200 processor running at 180MHz, this delay needed
1477 to be *at least* 15,000 usec before a Windows Server 2003
1478 DHCP server would reply 100% of the time. I recommend at
1479 least 50,000 usec to be safe. The alternative is to hope
1480 that one of the retries will be successful but note that
1481 the DHCP timeout and retry process takes a longer than
1482 this delay.
1483
wdenka3d991b2004-04-15 21:48:45 +00001484 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001485 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001486
1487 The device id used in CDP trigger frames.
1488
1489 CONFIG_CDP_DEVICE_ID_PREFIX
1490
1491 A two character string which is prefixed to the MAC address
1492 of the device.
1493
1494 CONFIG_CDP_PORT_ID
1495
1496 A printf format string which contains the ascii name of
1497 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001498 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001499
1500 CONFIG_CDP_CAPABILITIES
1501
1502 A 32bit integer which indicates the device capabilities;
1503 0x00000010 for a normal host which does not forwards.
1504
1505 CONFIG_CDP_VERSION
1506
1507 An ascii string containing the version of the software.
1508
1509 CONFIG_CDP_PLATFORM
1510
1511 An ascii string containing the name of the platform.
1512
1513 CONFIG_CDP_TRIGGER
1514
1515 A 32bit integer sent on the trigger.
1516
1517 CONFIG_CDP_POWER_CONSUMPTION
1518
1519 A 16bit integer containing the power consumption of the
1520 device in .1 of milliwatts.
1521
1522 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1523
1524 A byte containing the id of the VLAN.
1525
wdenkc6097192002-11-03 00:24:07 +00001526- Status LED: CONFIG_STATUS_LED
1527
1528 Several configurations allow to display the current
1529 status using a LED. For instance, the LED will blink
1530 fast while running U-Boot code, stop blinking as
1531 soon as a reply to a BOOTP request was received, and
1532 start blinking slow once the Linux kernel is running
1533 (supported by a status LED driver in the Linux
1534 kernel). Defining CONFIG_STATUS_LED enables this
1535 feature in U-Boot.
1536
1537- CAN Support: CONFIG_CAN_DRIVER
1538
1539 Defining CONFIG_CAN_DRIVER enables CAN driver support
1540 on those systems that support this (optional)
1541 feature, like the TQM8xxL modules.
1542
1543- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1544
wdenkb37c7e52003-06-30 16:24:52 +00001545 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001546 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001547 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001548
wdenk945af8d2003-07-16 21:53:01 +00001549 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001550 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001551 CONFIG_COMMANDS) and communicate with i2c based realtime
1552 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001553 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001554
Ben Warrenbb99ad62006-09-07 16:50:54 -04001555 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001556
wdenk945af8d2003-07-16 21:53:01 +00001557 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001558 bit-banging) driver instead of CPM or similar hardware
1559 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001560
wdenk945af8d2003-07-16 21:53:01 +00001561 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001562 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001564 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001565 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001566 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001567 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001568
Peter Tyser8d321b82010-04-12 22:28:21 -05001569 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001570 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001571 and so its address should therefore be cleared to 0 (See,
1572 eg, MPC823e User's Manual p.16-473). So, set
1573 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001574
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001575 CONFIG_SYS_I2C_INIT_MPC5XXX
1576
1577 When a board is reset during an i2c bus transfer
1578 chips might think that the current transfer is still
1579 in progress. Reset the slave devices by sending start
1580 commands until the slave device responds.
1581
wdenk945af8d2003-07-16 21:53:01 +00001582 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001583
1584 If you use the software i2c interface (CONFIG_SOFT_I2C)
1585 then the following macros need to be defined (examples are
1586 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001587
1588 I2C_INIT
1589
wdenkb37c7e52003-06-30 16:24:52 +00001590 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001591 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001592
wdenkba56f622004-02-06 23:19:44 +00001593 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001594
wdenkc6097192002-11-03 00:24:07 +00001595 I2C_PORT
1596
wdenk43d96162003-03-06 00:02:04 +00001597 (Only for MPC8260 CPU). The I/O port to use (the code
1598 assumes both bits are on the same port). Valid values
1599 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001600
1601 I2C_ACTIVE
1602
1603 The code necessary to make the I2C data line active
1604 (driven). If the data line is open collector, this
1605 define can be null.
1606
wdenkb37c7e52003-06-30 16:24:52 +00001607 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1608
wdenkc6097192002-11-03 00:24:07 +00001609 I2C_TRISTATE
1610
1611 The code necessary to make the I2C data line tri-stated
1612 (inactive). If the data line is open collector, this
1613 define can be null.
1614
wdenkb37c7e52003-06-30 16:24:52 +00001615 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1616
wdenkc6097192002-11-03 00:24:07 +00001617 I2C_READ
1618
1619 Code that returns TRUE if the I2C data line is high,
1620 FALSE if it is low.
1621
wdenkb37c7e52003-06-30 16:24:52 +00001622 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1623
wdenkc6097192002-11-03 00:24:07 +00001624 I2C_SDA(bit)
1625
1626 If <bit> is TRUE, sets the I2C data line high. If it
1627 is FALSE, it clears it (low).
1628
wdenkb37c7e52003-06-30 16:24:52 +00001629 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001630 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001631 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001632
wdenkc6097192002-11-03 00:24:07 +00001633 I2C_SCL(bit)
1634
1635 If <bit> is TRUE, sets the I2C clock line high. If it
1636 is FALSE, it clears it (low).
1637
wdenkb37c7e52003-06-30 16:24:52 +00001638 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001639 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001640 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001641
wdenkc6097192002-11-03 00:24:07 +00001642 I2C_DELAY
1643
1644 This delay is invoked four times per clock cycle so this
1645 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001646 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001647 like:
1648
wdenkb37c7e52003-06-30 16:24:52 +00001649 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001650
Mike Frysinger793b5722010-07-21 13:38:02 -04001651 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1652
1653 If your arch supports the generic GPIO framework (asm/gpio.h),
1654 then you may alternatively define the two GPIOs that are to be
1655 used as SCL / SDA. Any of the previous I2C_xxx macros will
1656 have GPIO-based defaults assigned to them as appropriate.
1657
1658 You should define these to the GPIO value as given directly to
1659 the generic GPIO functions.
1660
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001661 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001662
wdenk8bde7f72003-06-27 21:31:46 +00001663 When a board is reset during an i2c bus transfer
1664 chips might think that the current transfer is still
1665 in progress. On some boards it is possible to access
1666 the i2c SCLK line directly, either by using the
1667 processor pin as a GPIO or by having a second pin
1668 connected to the bus. If this option is defined a
1669 custom i2c_init_board() routine in boards/xxx/board.c
1670 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001671
Richard Retanubun26a33502010-04-12 15:08:17 -04001672 CONFIG_SYS_I2C_BOARD_LATE_INIT
1673
1674 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1675 defined a custom i2c_board_late_init() routine in
1676 boards/xxx/board.c is run AFTER the operations in i2c_init()
1677 is completed. This callpoint can be used to unreset i2c bus
1678 using CPU i2c controller register accesses for CPUs whose i2c
1679 controller provide such a method. It is called at the end of
1680 i2c_init() to allow i2c_init operations to setup the i2c bus
1681 controller on the CPU (e.g. setting bus speed & slave address).
1682
wdenk17ea1172004-06-06 21:51:03 +00001683 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1684
1685 This option enables configuration of bi_iic_fast[] flags
1686 in u-boot bd_info structure based on u-boot environment
1687 variable "i2cfast". (see also i2cfast)
1688
Ben Warrenbb99ad62006-09-07 16:50:54 -04001689 CONFIG_I2C_MULTI_BUS
1690
1691 This option allows the use of multiple I2C buses, each of which
1692 must have a controller. At any point in time, only one bus is
1693 active. To switch to a different bus, use the 'i2c dev' command.
1694 Note that bus numbering is zero-based.
1695
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001696 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001697
1698 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001699 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1700 is set, specify a list of bus-device pairs. Otherwise, specify
1701 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001702
1703 e.g.
1704 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001705 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001706
1707 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1708
1709 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001710 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001711
1712 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001714 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06001715
1716 If defined, then this indicates the I2C bus number for DDR SPD.
1717 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001719 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001720
1721 If defined, then this indicates the I2C bus number for the RTC.
1722 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1723
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001724 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001725
1726 If defined, then this indicates the I2C bus number for the DTT.
1727 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001729 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001730
1731 If defined, specifies the I2C address of the DTT device.
1732 If not defined, then U-Boot uses predefined value for
1733 specified DTT device.
1734
Timur Tabibe5e61812006-11-03 19:15:00 -06001735 CONFIG_FSL_I2C
1736
1737 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001738 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e61812006-11-03 19:15:00 -06001739
Heiko Schocher67b23a32008-10-15 09:39:47 +02001740 CONFIG_I2C_MUX
1741
1742 Define this option if you have I2C devices reached over 1 .. n
1743 I2C Muxes like the pca9544a. This option addes a new I2C
1744 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1745 new I2C Bus to the existing I2C Busses. If you select the
1746 new Bus with "i2c dev", u-bbot sends first the commandos for
1747 the muxes to activate this new "bus".
1748
1749 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1750 feature!
1751
1752 Example:
1753 Adding a new I2C Bus reached over 2 pca9544a muxes
1754 The First mux with address 70 and channel 6
1755 The Second mux with address 71 and channel 4
1756
1757 => i2c bus pca9544a:70:6:pca9544a:71:4
1758
1759 Use the "i2c bus" command without parameter, to get a list
1760 of I2C Busses with muxes:
1761
1762 => i2c bus
1763 Busses reached over muxes:
1764 Bus ID: 2
1765 reached over Mux(es):
1766 pca9544a@70 ch: 4
1767 Bus ID: 3
1768 reached over Mux(es):
1769 pca9544a@70 ch: 6
1770 pca9544a@71 ch: 4
1771 =>
1772
1773 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001774 u-boot first sends the command to the mux@70 to enable
1775 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001776 the channel 4.
1777
1778 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001779 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001780 the 2 muxes.
1781
1782 This option is actually implemented for the bitbanging
1783 algorithm in common/soft_i2c.c and for the Hardware I2C
1784 Bus on the MPC8260. But it should be not so difficult
1785 to add this option to other architectures.
1786
Andrew Dyer2ac69852008-12-29 17:36:01 -06001787 CONFIG_SOFT_I2C_READ_REPEATED_START
1788
1789 defining this will force the i2c_read() function in
1790 the soft_i2c driver to perform an I2C repeated start
1791 between writing the address pointer and reading the
1792 data. If this define is omitted the default behaviour
1793 of doing a stop-start sequence will be used. Most I2C
1794 devices can use either method, but some require one or
1795 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06001796
wdenkc6097192002-11-03 00:24:07 +00001797- SPI Support: CONFIG_SPI
1798
1799 Enables SPI driver (so far only tested with
1800 SPI EEPROM, also an instance works with Crystal A/D and
1801 D/As on the SACSng board)
1802
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001803 CONFIG_SH_SPI
1804
1805 Enables the driver for SPI controller on SuperH. Currently
1806 only SH7757 is supported.
1807
wdenkc6097192002-11-03 00:24:07 +00001808 CONFIG_SPI_X
1809
1810 Enables extended (16-bit) SPI EEPROM addressing.
1811 (symmetrical to CONFIG_I2C_X)
1812
1813 CONFIG_SOFT_SPI
1814
wdenk43d96162003-03-06 00:02:04 +00001815 Enables a software (bit-bang) SPI driver rather than
1816 using hardware support. This is a general purpose
1817 driver that only requires three general I/O port pins
1818 (two outputs, one input) to function. If this is
1819 defined, the board configuration must define several
1820 SPI configuration items (port pins to use, etc). For
1821 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001822
Ben Warren04a9e112008-01-16 22:37:35 -05001823 CONFIG_HARD_SPI
1824
1825 Enables a hardware SPI driver for general-purpose reads
1826 and writes. As with CONFIG_SOFT_SPI, the board configuration
1827 must define a list of chip-select function pointers.
1828 Currently supported on some MPC8xxx processors. For an
1829 example, see include/configs/mpc8349emds.h.
1830
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001831 CONFIG_MXC_SPI
1832
1833 Enables the driver for the SPI controllers on i.MX and MXC
1834 SoCs. Currently only i.MX31 is supported.
1835
Matthias Fuchs01335022007-12-27 17:12:34 +01001836- FPGA Support: CONFIG_FPGA
1837
1838 Enables FPGA subsystem.
1839
1840 CONFIG_FPGA_<vendor>
1841
1842 Enables support for specific chip vendors.
1843 (ALTERA, XILINX)
1844
1845 CONFIG_FPGA_<family>
1846
1847 Enables support for FPGA family.
1848 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1849
1850 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001851
wdenk43d96162003-03-06 00:02:04 +00001852 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001853
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001854 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001855
wdenk8bde7f72003-06-27 21:31:46 +00001856 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001857
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001858 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001859
wdenk43d96162003-03-06 00:02:04 +00001860 Enable checks on FPGA configuration interface busy
1861 status by the configuration function. This option
1862 will require a board or device specific function to
1863 be written.
wdenkc6097192002-11-03 00:24:07 +00001864
1865 CONFIG_FPGA_DELAY
1866
1867 If defined, a function that provides delays in the FPGA
1868 configuration driver.
1869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001870 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001871 Allow Control-C to interrupt FPGA configuration
1872
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001873 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001874
wdenk43d96162003-03-06 00:02:04 +00001875 Check for configuration errors during FPGA bitfile
1876 loading. For example, abort during Virtex II
1877 configuration if the INIT_B line goes low (which
1878 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001879
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001880 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001881
wdenk43d96162003-03-06 00:02:04 +00001882 Maximum time to wait for the INIT_B line to deassert
1883 after PROB_B has been deasserted during a Virtex II
1884 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001885 ms.
wdenkc6097192002-11-03 00:24:07 +00001886
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001887 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001888
wdenk43d96162003-03-06 00:02:04 +00001889 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001890 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001891
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001892 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001893
wdenk43d96162003-03-06 00:02:04 +00001894 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001895 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001896
1897- Configuration Management:
1898 CONFIG_IDENT_STRING
1899
wdenk43d96162003-03-06 00:02:04 +00001900 If defined, this string will be added to the U-Boot
1901 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001902
1903- Vendor Parameter Protection:
1904
wdenk43d96162003-03-06 00:02:04 +00001905 U-Boot considers the values of the environment
1906 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001907 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001908 are set once by the board vendor / manufacturer, and
1909 protects these variables from casual modification by
1910 the user. Once set, these variables are read-only,
1911 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001912 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001913
1914 If CONFIG_ENV_OVERWRITE is #defined in your config
1915 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001916 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001917 these parameters.
1918
1919 Alternatively, if you #define _both_ CONFIG_ETHADDR
1920 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001921 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001922 which can be changed exactly ONCE by the user. [The
1923 serial# is unaffected by this, i. e. it remains
1924 read-only.]
1925
1926- Protected RAM:
1927 CONFIG_PRAM
1928
1929 Define this variable to enable the reservation of
1930 "protected RAM", i. e. RAM which is not overwritten
1931 by U-Boot. Define CONFIG_PRAM to hold the number of
1932 kB you want to reserve for pRAM. You can overwrite
1933 this default value by defining an environment
1934 variable "pram" to the number of kB you want to
1935 reserve. Note that the board info structure will
1936 still show the full amount of RAM. If pRAM is
1937 reserved, a new environment variable "mem" will
1938 automatically be defined to hold the amount of
1939 remaining RAM in a form that can be passed as boot
1940 argument to Linux, for instance like that:
1941
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001942 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001943 saveenv
1944
1945 This way you can tell Linux not to use this memory,
1946 either, which results in a memory region that will
1947 not be affected by reboots.
1948
1949 *WARNING* If your board configuration uses automatic
1950 detection of the RAM size, you must make sure that
1951 this memory test is non-destructive. So far, the
1952 following board configurations are known to be
1953 "pRAM-clean":
1954
1955 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1956 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001957 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001958
1959- Error Recovery:
1960 CONFIG_PANIC_HANG
1961
1962 Define this variable to stop the system in case of a
1963 fatal error, so that you have to reset it manually.
1964 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001965 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001966 automatically as fast as possible, but it may be
1967 useful during development since you can try to debug
1968 the conditions that lead to the situation.
1969
1970 CONFIG_NET_RETRY_COUNT
1971
wdenk43d96162003-03-06 00:02:04 +00001972 This variable defines the number of retries for
1973 network operations like ARP, RARP, TFTP, or BOOTP
1974 before giving up the operation. If not defined, a
1975 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001976
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001977 CONFIG_ARP_TIMEOUT
1978
1979 Timeout waiting for an ARP reply in milliseconds.
1980
wdenkc6097192002-11-03 00:24:07 +00001981- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001982 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001983
1984 Enable auto completion of commands using TAB.
1985
Wolfgang Denka9398e02006-11-27 15:32:42 +01001986 Note that this feature has NOT been implemented yet
1987 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001988
1989
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001990 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001991
1992 Define this variable to enable the "hush" shell (from
1993 Busybox) as command line interpreter, thus enabling
1994 powerful command line syntax like
1995 if...then...else...fi conditionals or `&&' and '||'
1996 constructs ("shell scripts").
1997
1998 If undefined, you get the old, much simpler behaviour
1999 with a somewhat smaller memory footprint.
2000
2001
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002002 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002003
2004 This defines the secondary prompt string, which is
2005 printed when the command interpreter needs more input
2006 to complete a command. Usually "> ".
2007
2008 Note:
2009
wdenk8bde7f72003-06-27 21:31:46 +00002010 In the current implementation, the local variables
2011 space and global environment variables space are
2012 separated. Local variables are those you define by
2013 simply typing `name=value'. To access a local
2014 variable later on, you have write `$name' or
2015 `${name}'; to execute the contents of a variable
2016 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002017
wdenk43d96162003-03-06 00:02:04 +00002018 Global environment variables are those you use
2019 setenv/printenv to work with. To run a command stored
2020 in such a variable, you need to use the run command,
2021 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002022
2023 To store commands and special characters in a
2024 variable, please use double quotation marks
2025 surrounding the whole text of the variable, instead
2026 of the backslashes before semicolons and special
2027 symbols.
2028
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002029- Commandline Editing and History:
2030 CONFIG_CMDLINE_EDITING
2031
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002032 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002033 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002034
wdenka8c7c702003-12-06 19:49:23 +00002035- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002036 CONFIG_EXTRA_ENV_SETTINGS
2037
wdenk43d96162003-03-06 00:02:04 +00002038 Define this to contain any number of null terminated
2039 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002040 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002041
wdenk43d96162003-03-06 00:02:04 +00002042 For example, place something like this in your
2043 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002044
2045 #define CONFIG_EXTRA_ENV_SETTINGS \
2046 "myvar1=value1\0" \
2047 "myvar2=value2\0"
2048
wdenk43d96162003-03-06 00:02:04 +00002049 Warning: This method is based on knowledge about the
2050 internal format how the environment is stored by the
2051 U-Boot code. This is NOT an official, exported
2052 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002053 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002054 You better know what you are doing here.
2055
wdenk43d96162003-03-06 00:02:04 +00002056 Note: overly (ab)use of the default environment is
2057 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002058 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002059 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002060
wdenka8c7c702003-12-06 19:49:23 +00002061- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002062 CONFIG_HAS_DATAFLASH
2063
wdenk8bde7f72003-06-27 21:31:46 +00002064 Defining this option enables DataFlash features and
2065 allows to read/write in Dataflash via the standard
2066 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002067
wdenk3f85ce22004-02-23 16:11:30 +00002068- SystemACE Support:
2069 CONFIG_SYSTEMACE
2070
2071 Adding this option adds support for Xilinx SystemACE
2072 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002073 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002074 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002075
2076 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002077 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002078
2079 When SystemACE support is added, the "ace" device type
2080 becomes available to the fat commands, i.e. fatls.
2081
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002082- TFTP Fixed UDP Port:
2083 CONFIG_TFTP_PORT
2084
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002085 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002086 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002087 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002088 number generator is used.
2089
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002090 Also, the environment variable tftpdstp is used to supply
2091 the TFTP UDP destination port value. If tftpdstp isn't
2092 defined, the normal port 69 is used.
2093
2094 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002095 blindly start the TFTP transfer using the pre-configured
2096 target IP address and UDP port. This has the effect of
2097 "punching through" the (Windows XP) firewall, allowing
2098 the remainder of the TFTP transfer to proceed normally.
2099 A better solution is to properly configure the firewall,
2100 but sometimes that is not allowed.
2101
wdenka8c7c702003-12-06 19:49:23 +00002102- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002103 CONFIG_SHOW_BOOT_PROGRESS
2104
wdenk43d96162003-03-06 00:02:04 +00002105 Defining this option allows to add some board-
2106 specific code (calling a user-provided function
2107 "show_boot_progress(int)") that enables you to show
2108 the system's boot progress on some display (for
2109 example, some LED's) on your board. At the moment,
2110 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002111
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002112Legacy uImage format:
2113
wdenkc6097192002-11-03 00:24:07 +00002114 Arg Where When
2115 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002116 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002117 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002118 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002119 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002120 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002121 4 common/cmd_bootm.c Image data has correct checksum
2122 -4 common/cmd_bootm.c Image is for unsupported architecture
2123 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002124 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002125 6 common/cmd_bootm.c Image Type check OK
2126 -6 common/cmd_bootm.c gunzip uncompression error
2127 -7 common/cmd_bootm.c Unimplemented compression type
2128 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002129 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002130 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002131
2132 9 common/image.c Start initial ramdisk verification
2133 -10 common/image.c Ramdisk header has bad magic number
2134 -11 common/image.c Ramdisk header has bad checksum
2135 10 common/image.c Ramdisk header is OK
2136 -12 common/image.c Ramdisk data has bad checksum
2137 11 common/image.c Ramdisk data has correct checksum
2138 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002139 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002140 13 common/image.c Start multifile image verification
2141 14 common/image.c No initial ramdisk, no multifile, continue.
2142
Peter Tyserea0364f2010-04-12 22:28:04 -05002143 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002144
Stefan Roesea47a12b2010-04-15 16:07:28 +02002145 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002146 -31 post/post.c POST test failed, detected by post_output_backlog()
2147 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002148
Heiko Schocher566a4942007-06-22 19:11:54 +02002149 34 common/cmd_doc.c before loading a Image from a DOC device
2150 -35 common/cmd_doc.c Bad usage of "doc" command
2151 35 common/cmd_doc.c correct usage of "doc" command
2152 -36 common/cmd_doc.c No boot device
2153 36 common/cmd_doc.c correct boot device
2154 -37 common/cmd_doc.c Unknown Chip ID on boot device
2155 37 common/cmd_doc.c correct chip ID found, device available
2156 -38 common/cmd_doc.c Read Error on boot device
2157 38 common/cmd_doc.c reading Image header from DOC device OK
2158 -39 common/cmd_doc.c Image header has bad magic number
2159 39 common/cmd_doc.c Image header has correct magic number
2160 -40 common/cmd_doc.c Error reading Image from DOC device
2161 40 common/cmd_doc.c Image header has correct magic number
2162 41 common/cmd_ide.c before loading a Image from a IDE device
2163 -42 common/cmd_ide.c Bad usage of "ide" command
2164 42 common/cmd_ide.c correct usage of "ide" command
2165 -43 common/cmd_ide.c No boot device
2166 43 common/cmd_ide.c boot device found
2167 -44 common/cmd_ide.c Device not available
2168 44 common/cmd_ide.c Device available
2169 -45 common/cmd_ide.c wrong partition selected
2170 45 common/cmd_ide.c partition selected
2171 -46 common/cmd_ide.c Unknown partition table
2172 46 common/cmd_ide.c valid partition table found
2173 -47 common/cmd_ide.c Invalid partition type
2174 47 common/cmd_ide.c correct partition type
2175 -48 common/cmd_ide.c Error reading Image Header on boot device
2176 48 common/cmd_ide.c reading Image Header from IDE device OK
2177 -49 common/cmd_ide.c Image header has bad magic number
2178 49 common/cmd_ide.c Image header has correct magic number
2179 -50 common/cmd_ide.c Image header has bad checksum
2180 50 common/cmd_ide.c Image header has correct checksum
2181 -51 common/cmd_ide.c Error reading Image from IDE device
2182 51 common/cmd_ide.c reading Image from IDE device OK
2183 52 common/cmd_nand.c before loading a Image from a NAND device
2184 -53 common/cmd_nand.c Bad usage of "nand" command
2185 53 common/cmd_nand.c correct usage of "nand" command
2186 -54 common/cmd_nand.c No boot device
2187 54 common/cmd_nand.c boot device found
2188 -55 common/cmd_nand.c Unknown Chip ID on boot device
2189 55 common/cmd_nand.c correct chip ID found, device available
2190 -56 common/cmd_nand.c Error reading Image Header on boot device
2191 56 common/cmd_nand.c reading Image Header from NAND device OK
2192 -57 common/cmd_nand.c Image header has bad magic number
2193 57 common/cmd_nand.c Image header has correct magic number
2194 -58 common/cmd_nand.c Error reading Image from NAND device
2195 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002196
Heiko Schocher566a4942007-06-22 19:11:54 +02002197 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002198
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002199 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002200 -64 net/eth.c no Ethernet found.
2201 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002202
Heiko Schocher566a4942007-06-22 19:11:54 +02002203 -80 common/cmd_net.c usage wrong
2204 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002205 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002206 81 common/cmd_net.c NetLoop() back without error
2207 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2208 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002209 83 common/cmd_net.c running "source" command
2210 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002211 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002212
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002213FIT uImage format:
2214
2215 Arg Where When
2216 100 common/cmd_bootm.c Kernel FIT Image has correct format
2217 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2218 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2219 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2220 102 common/cmd_bootm.c Kernel unit name specified
2221 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002222 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002223 104 common/cmd_bootm.c Got kernel subimage node offset
2224 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2225 105 common/cmd_bootm.c Kernel subimage hash verification OK
2226 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2227 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002228 -106 common/cmd_bootm.c Kernel subimage has wrong type
2229 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002230 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2231 108 common/cmd_bootm.c Got kernel subimage data/size
2232 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2233 -109 common/cmd_bootm.c Can't get kernel subimage type
2234 -110 common/cmd_bootm.c Can't get kernel subimage comp
2235 -111 common/cmd_bootm.c Can't get kernel subimage os
2236 -112 common/cmd_bootm.c Can't get kernel subimage load address
2237 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2238
2239 120 common/image.c Start initial ramdisk verification
2240 -120 common/image.c Ramdisk FIT image has incorrect format
2241 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002242 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002243 -122 common/image.c Can't get configuration for ramdisk subimage
2244 123 common/image.c Ramdisk unit name specified
2245 -124 common/image.c Can't get ramdisk subimage node offset
2246 125 common/image.c Got ramdisk subimage node offset
2247 -125 common/image.c Ramdisk subimage hash verification failed
2248 126 common/image.c Ramdisk subimage hash verification OK
2249 -126 common/image.c Ramdisk subimage for unsupported architecture
2250 127 common/image.c Architecture check OK
2251 -127 common/image.c Can't get ramdisk subimage data/size
2252 128 common/image.c Got ramdisk subimage data/size
2253 129 common/image.c Can't get ramdisk load address
2254 -129 common/image.c Got ramdisk load address
2255
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002256 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002257 131 common/cmd_doc.c FIT image format OK
2258
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002259 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002260 141 common/cmd_ide.c FIT image format OK
2261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002262 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002263 151 common/cmd_nand.c FIT image format OK
2264
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002265- Standalone program support:
2266 CONFIG_STANDALONE_LOAD_ADDR
2267
Wolfgang Denk6feff892011-10-09 21:06:34 +02002268 This option defines a board specific value for the
2269 address where standalone program gets loaded, thus
2270 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002271 settings.
2272
2273- Frame Buffer Address:
2274 CONFIG_FB_ADDR
2275
2276 Define CONFIG_FB_ADDR if you want to use specific
2277 address for frame buffer.
2278 Then system will reserve the frame buffer address to
2279 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002280 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002281
2282 Please see board_init_f function.
2283
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002284- Automatic software updates via TFTP server
2285 CONFIG_UPDATE_TFTP
2286 CONFIG_UPDATE_TFTP_CNT_MAX
2287 CONFIG_UPDATE_TFTP_MSEC_MAX
2288
2289 These options enable and control the auto-update feature;
2290 for a more detailed description refer to doc/README.update.
2291
2292- MTD Support (mtdparts command, UBI support)
2293 CONFIG_MTD_DEVICE
2294
2295 Adds the MTD device infrastructure from the Linux kernel.
2296 Needed for mtdparts command support.
2297
2298 CONFIG_MTD_PARTITIONS
2299
2300 Adds the MTD partitioning infrastructure from the Linux
2301 kernel. Needed for UBI support.
2302
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002303- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002304 CONFIG_SPL
2305 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002306
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002307 CONFIG_SPL_TEXT_BASE
2308 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002309
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002310 CONFIG_SPL_LDSCRIPT
2311 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002312
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002313 CONFIG_SPL_LIBCOMMON_SUPPORT
2314 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002315
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002316 CONFIG_SPL_LIBDISK_SUPPORT
2317 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002318
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002319 CONFIG_SPL_I2C_SUPPORT
2320 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002321
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002322 CONFIG_SPL_GPIO_SUPPORT
2323 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002324
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002325 CONFIG_SPL_MMC_SUPPORT
2326 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002327
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002328 CONFIG_SPL_SERIAL_SUPPORT
2329 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002330
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002331 CONFIG_SPL_SPI_FLASH_SUPPORT
2332 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002333
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002334 CONFIG_SPL_SPI_SUPPORT
2335 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002336
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002337 CONFIG_SPL_FAT_SUPPORT
2338 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002339
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002340 CONFIG_SPL_LIBGENERIC_SUPPORT
2341 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002342
wdenkc6097192002-11-03 00:24:07 +00002343Modem Support:
2344--------------
2345
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002346[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002347
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002348- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002349 CONFIG_MODEM_SUPPORT
2350
2351- RTS/CTS Flow control enable:
2352 CONFIG_HWFLOW
2353
2354- Modem debug support:
2355 CONFIG_MODEM_SUPPORT_DEBUG
2356
wdenk43d96162003-03-06 00:02:04 +00002357 Enables debugging stuff (char screen[1024], dbg())
2358 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002359
wdenka8c7c702003-12-06 19:49:23 +00002360- Interrupt support (PPC):
2361
wdenkd4ca31c2004-01-02 14:00:00 +00002362 There are common interrupt_init() and timer_interrupt()
2363 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002364 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002365 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002366 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002367 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002368 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002369 specific handling. If board has watchdog / status_led
2370 / other_activity_monitor it works automatically from
2371 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002372
wdenkc6097192002-11-03 00:24:07 +00002373- General:
2374
wdenk43d96162003-03-06 00:02:04 +00002375 In the target system modem support is enabled when a
2376 specific key (key combination) is pressed during
2377 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002378 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002379 board_init(). Currently key_pressed() is a dummy
2380 function, returning 1 and thus enabling modem
2381 initialization.
wdenkc6097192002-11-03 00:24:07 +00002382
wdenk43d96162003-03-06 00:02:04 +00002383 If there are no modem init strings in the
2384 environment, U-Boot proceed to autoboot; the
2385 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002386 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002387
2388 See also: doc/README.Modem
2389
2390
wdenkc6097192002-11-03 00:24:07 +00002391Configuration Settings:
2392-----------------------
2393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002394- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002395 undefine this when you're short of memory.
2396
Peter Tyser2fb26042009-01-27 18:03:12 -06002397- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2398 width of the commands listed in the 'help' command output.
2399
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002400- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002401 prompt for user input.
2402
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002403- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002405- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002406
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002407- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002410 the application (usually a Linux kernel) when it is
2411 booted
2412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002413- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002414 List of legal baudrate settings for this board.
2415
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002416- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002417 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002418
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002419- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002420 If the board specific function
2421 extern int overwrite_console (void);
2422 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002423 serial port, else the settings in the environment are used.
2424
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002425- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002426 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002428- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002429 Enable overwrite of previous console environment settings.
2430
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002431- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002432 Begin and End addresses of the area used by the
2433 simple memory test.
2434
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002435- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002436 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002437
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002438- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002439 Scratch address used by the alternate memory test
2440 You only need to set this if address zero isn't writeable
2441
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002442- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2443 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002444 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002445 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002446 fixing up gd->ram_size the Linux kernel should gets passed
2447 the now "corrected" memory size and won't touch it either.
2448 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002449 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002450 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002451 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002452
2453 This option can be used as a workaround for the 440EPx/GRx
2454 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2455 be touched.
2456
2457 WARNING: Please make sure that this value is a multiple of
2458 the Linux page size (normally 4k). If this is not the case,
2459 then the end address of the Linux memory will be located at a
2460 non page size aligned address and this could cause major
2461 problems.
2462
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002463- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002464 Default load address for network file downloads
2465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002466- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002467 Enable temporary baudrate change while serial download
2468
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002469- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002470 Physical start address of SDRAM. _Must_ be 0 here.
2471
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002472- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002473 Physical start address of Motherboard I/O (if using a
2474 Cogent motherboard)
2475
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002476- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002477 Physical start address of Flash memory.
2478
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002479- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002480 Physical start address of boot monitor code (set by
2481 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002482 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002483 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002484
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002485- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002486 Size of memory reserved for monitor code, used to
2487 determine _at_compile_time_ (!) if the environment is
2488 embedded within the U-Boot image, or in a separate
2489 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002491- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002492 Size of DRAM reserved for malloc() use.
2493
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002494- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002495 Normally compressed uImages are limited to an
2496 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002497 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002498 to adjust this setting to your needs.
2499
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002500- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002501 Maximum size of memory mapped by the startup code of
2502 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002503 the Linux kernel (bd_info, boot arguments, FDT blob if
2504 used) must be put below this limit, unless "bootm_low"
2505 enviroment variable is defined and non-zero. In such case
2506 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002507 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2508 variable "bootm_mapsize" will override the value of
2509 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2510 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002511
John Rigbyfca43cc2010-10-13 13:57:35 -06002512- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2513 Enable initrd_high functionality. If defined then the
2514 initrd_high feature is enabled and the bootm ramdisk subcommand
2515 is enabled.
2516
2517- CONFIG_SYS_BOOT_GET_CMDLINE:
2518 Enables allocating and saving kernel cmdline in space between
2519 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2520
2521- CONFIG_SYS_BOOT_GET_KBD:
2522 Enables allocating and saving a kernel copy of the bd_info in
2523 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2524
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002525- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002526 Max number of Flash memory banks
2527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002528- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002529 Max number of sectors on a Flash chip
2530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002531- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002532 Timeout for Flash erase operations (in ms)
2533
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002534- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002535 Timeout for Flash write operations (in ms)
2536
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002537- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002538 Timeout for Flash set sector lock bit operation (in ms)
2539
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002540- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002541 Timeout for Flash clear lock bits operation (in ms)
2542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002543- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002544 If defined, hardware flash sectors protection is used
2545 instead of U-Boot software protection.
2546
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002547- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002548
2549 Enable TFTP transfers directly to flash memory;
2550 without this option such a download has to be
2551 performed in two steps: (1) download to RAM, and (2)
2552 copy from RAM to flash.
2553
2554 The two-step approach is usually more reliable, since
2555 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002556 the flash, but in some situations (when system RAM is
2557 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002558 downloaded image) this option may be very useful.
2559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002560- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002561 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002562 common flash structure for storing flash geometry.
2563
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002564- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002565 This option also enables the building of the cfi_flash driver
2566 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002567
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002568- CONFIG_FLASH_CFI_MTD
2569 This option enables the building of the cfi_mtd driver
2570 in the drivers directory. The driver exports CFI flash
2571 to the MTD layer.
2572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002573- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002574 Use buffered writes to flash.
2575
2576- CONFIG_FLASH_SPANSION_S29WS_N
2577 s29ws-n MirrorBit flash has non-standard addresses for buffered
2578 write commands.
2579
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002580- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002581 If this option is defined, the common CFI flash doesn't
2582 print it's warning upon not recognized FLASH banks. This
2583 is useful, if some of the configured banks are only
2584 optionally available.
2585
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002586- CONFIG_FLASH_SHOW_PROGRESS
2587 If defined (must be an integer), print out countdown
2588 digits and dots. Recommended value: 45 (9..1) for 80
2589 column displays, 15 (3..1) for 40 column displays.
2590
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002591- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002592 Defines the number of Ethernet receive buffers. On some
2593 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002594 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2595 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002596 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002597 Defaults to 4 if not defined.
2598
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002599- CONFIG_ENV_MAX_ENTRIES
2600
Wolfgang Denk071bc922010-10-27 22:48:30 +02002601 Maximum number of entries in the hash table that is used
2602 internally to store the environment settings. The default
2603 setting is supposed to be generous and should work in most
2604 cases. This setting can be used to tune behaviour; see
2605 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002606
wdenkc6097192002-11-03 00:24:07 +00002607The following definitions that deal with the placement and management
2608of environment data (variable area); in general, we support the
2609following configurations:
2610
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002611- CONFIG_BUILD_ENVCRC:
2612
2613 Builds up envcrc with the target environment so that external utils
2614 may easily extract it and embed it in final U-Boot images.
2615
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002616- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002617
2618 Define this if the environment is in flash memory.
2619
2620 a) The environment occupies one whole flash sector, which is
2621 "embedded" in the text segment with the U-Boot code. This
2622 happens usually with "bottom boot sector" or "top boot
2623 sector" type flash chips, which have several smaller
2624 sectors at the start or the end. For instance, such a
2625 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2626 such a case you would place the environment in one of the
2627 4 kB sectors - with U-Boot code before and after it. With
2628 "top boot sector" type flash chips, you would put the
2629 environment in one of the last sectors, leaving a gap
2630 between U-Boot and the environment.
2631
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002632 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002633
2634 Offset of environment data (variable area) to the
2635 beginning of flash memory; for instance, with bottom boot
2636 type flash chips the second sector can be used: the offset
2637 for this sector is given here.
2638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002639 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002640
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002641 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002642
2643 This is just another way to specify the start address of
2644 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002645 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002646
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002647 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002648
2649 Size of the sector containing the environment.
2650
2651
2652 b) Sometimes flash chips have few, equal sized, BIG sectors.
2653 In such a case you don't want to spend a whole sector for
2654 the environment.
2655
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002656 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002657
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002658 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002659 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002660 of this flash sector for the environment. This saves
2661 memory for the RAM copy of the environment.
2662
2663 It may also save flash memory if you decide to use this
2664 when your environment is "embedded" within U-Boot code,
2665 since then the remainder of the flash sector could be used
2666 for U-Boot code. It should be pointed out that this is
2667 STRONGLY DISCOURAGED from a robustness point of view:
2668 updating the environment in flash makes it always
2669 necessary to erase the WHOLE sector. If something goes
2670 wrong before the contents has been restored from a copy in
2671 RAM, your target system will be dead.
2672
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002673 - CONFIG_ENV_ADDR_REDUND
2674 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002675
wdenk43d96162003-03-06 00:02:04 +00002676 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002677 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002678 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002679 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002680
2681BE CAREFUL! Any changes to the flash layout, and some changes to the
2682source code will make it necessary to adapt <board>/u-boot.lds*
2683accordingly!
2684
2685
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002686- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002687
2688 Define this if you have some non-volatile memory device
2689 (NVRAM, battery buffered SRAM) which you want to use for the
2690 environment.
2691
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002692 - CONFIG_ENV_ADDR:
2693 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002694
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002695 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002696 want to use for environment. It is assumed that this memory
2697 can just be read and written to, without any special
2698 provision.
2699
2700BE CAREFUL! The first access to the environment happens quite early
2701in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002702console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002703U-Boot will hang.
2704
2705Please note that even with NVRAM we still use a copy of the
2706environment in RAM: we could work on NVRAM directly, but we want to
2707keep settings there always unmodified except somebody uses "saveenv"
2708to save the current settings.
2709
2710
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002711- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002712
2713 Use this if you have an EEPROM or similar serial access
2714 device and a driver for it.
2715
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002716 - CONFIG_ENV_OFFSET:
2717 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002718
2719 These two #defines specify the offset and size of the
2720 environment area within the total memory of your EEPROM.
2721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002722 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002723 If defined, specified the chip address of the EEPROM device.
2724 The default address is zero.
2725
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002726 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002727 If defined, the number of bits used to address bytes in a
2728 single page in the EEPROM device. A 64 byte page, for example
2729 would require six bits.
2730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002731 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002732 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002733 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002735 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002736 The length in bytes of the EEPROM memory array address. Note
2737 that this is NOT the chip address length!
2738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002739 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002740 EEPROM chips that implement "address overflow" are ones
2741 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2742 address and the extra bits end up in the "chip address" bit
2743 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2744 byte chips.
2745
2746 Note that we consider the length of the address field to
2747 still be one byte because the extra address bits are hidden
2748 in the chip address.
2749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002750 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002751 The size in bytes of the EEPROM device.
2752
Heiko Schocher548738b2010-01-07 08:55:40 +01002753 - CONFIG_ENV_EEPROM_IS_ON_I2C
2754 define this, if you have I2C and SPI activated, and your
2755 EEPROM, which holds the environment, is on the I2C bus.
2756
2757 - CONFIG_I2C_ENV_EEPROM_BUS
2758 if you have an Environment on an EEPROM reached over
2759 I2C muxes, you can define here, how to reach this
2760 EEPROM. For example:
2761
Wolfgang Denka9046b92010-06-13 17:48:15 +02002762 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002763
2764 EEPROM which holds the environment, is reached over
2765 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002766
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002767- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002768
wdenkd4ca31c2004-01-02 14:00:00 +00002769 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002770 want to use for the environment.
2771
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002772 - CONFIG_ENV_OFFSET:
2773 - CONFIG_ENV_ADDR:
2774 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002775
2776 These three #defines specify the offset and size of the
2777 environment area within the total memory of your DataFlash placed
2778 at the specified address.
2779
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002780- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002781
2782 Define this if you have a NAND device which you want to use
2783 for the environment.
2784
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002785 - CONFIG_ENV_OFFSET:
2786 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002787
2788 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002789 area within the first NAND device. CONFIG_ENV_OFFSET must be
2790 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002791
Scott Woodfdd813d2010-09-17 14:38:37 -05002792 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002793
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002794 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002795 size used to hold a redundant copy of the environment data, so
2796 that there is a valid backup copy in case there is a power failure
2797 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2798 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002799
Scott Woodfdd813d2010-09-17 14:38:37 -05002800 - CONFIG_ENV_RANGE (optional):
2801
2802 Specifies the length of the region in which the environment
2803 can be written. This should be a multiple of the NAND device's
2804 block size. Specifying a range with more erase blocks than
2805 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2806 the range to be avoided.
2807
2808 - CONFIG_ENV_OFFSET_OOB (optional):
2809
2810 Enables support for dynamically retrieving the offset of the
2811 environment from block zero's out-of-band data. The
2812 "nand env.oob" command can be used to record this offset.
2813 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2814 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002815
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002816- CONFIG_NAND_ENV_DST
2817
2818 Defines address in RAM to which the nand_spl code should copy the
2819 environment. If redundant environment is used, it will be copied to
2820 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002822- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002823
2824 Defines offset to the initial SPI buffer area in DPRAM. The
2825 area is used at an early stage (ROM part) if the environment
2826 is configured to reside in the SPI EEPROM: We need a 520 byte
2827 scratch DPRAM area. It is used between the two initialization
2828 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2829 to be a good choice since it makes it far enough from the
2830 start of the data area as well as from the stack pointer.
2831
Bruce Adlere881cb52007-11-02 13:15:42 -07002832Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002833has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002834created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002835until then to read environment variables.
2836
wdenk85ec0bc2003-03-31 16:34:49 +00002837The environment is protected by a CRC32 checksum. Before the monitor
2838is relocated into RAM, as a result of a bad CRC you will be working
2839with the compiled-in default environment - *silently*!!! [This is
2840necessary, because the first environment variable we need is the
2841"baudrate" setting for the console - if we have a bad CRC, we don't
2842have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002843
2844Note: once the monitor has been relocated, then it will complain if
2845the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002846use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002847
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002848- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002849 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002850
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002851 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002852 also needs to be defined.
2853
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002854- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002855 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002856
Ron Madridf5675aa2009-02-18 14:30:44 -08002857- CONFIG_NS16550_MIN_FUNCTIONS:
2858 Define this if you desire to only have use of the NS16550_init
2859 and NS16550_putc functions for the serial driver located at
2860 drivers/serial/ns16550.c. This option is useful for saving
2861 space for already greatly restricted images, including but not
2862 limited to NAND_SPL configurations.
2863
wdenkc6097192002-11-03 00:24:07 +00002864Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002865---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002866
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002867- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002868 Cache Line Size of the CPU.
2869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002870- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002871 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002872
wdenk42d1f032003-10-15 23:53:47 +00002873 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2874 and RPXsuper) to be able to adjust the position of
2875 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002876
Timur Tabie46fedf2011-08-04 18:03:41 -05002877- CONFIG_SYS_CCSRBAR_DEFAULT:
2878 Default (power-on reset) physical address of CCSR on Freescale
2879 PowerPC SOCs.
2880
2881- CONFIG_SYS_CCSRBAR:
2882 Virtual address of CCSR. On a 32-bit build, this is typically
2883 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2884
2885 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2886 for cross-platform code that uses that macro instead.
2887
2888- CONFIG_SYS_CCSRBAR_PHYS:
2889 Physical address of CCSR. CCSR can be relocated to a new
2890 physical address, if desired. In this case, this macro should
2891 be set to that address. Otherwise, it should be set to the
2892 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2893 is typically relocated on 36-bit builds. It is recommended
2894 that this macro be defined via the _HIGH and _LOW macros:
2895
2896 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2897 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2898
2899- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002900 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2901 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05002902 used in assembly code, so it must not contain typecasts or
2903 integer size suffixes (e.g. "ULL").
2904
2905- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2906 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2907 used in assembly code, so it must not contain typecasts or
2908 integer size suffixes (e.g. "ULL").
2909
2910- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2911 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2912 forced to a value that ensures that CCSR is not relocated.
2913
wdenk7f6c2cb2002-11-10 22:06:23 +00002914- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002915 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002916
2917 the default drive number (default value 0)
2918
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002919 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002920
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002921 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002922 (default value 1)
2923
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002924 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002925
wdenk43d96162003-03-06 00:02:04 +00002926 defines the offset of register from address. It
2927 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002928 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002929
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002930 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2931 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002932 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002933
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002934 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002935 fdc_hw_init() is called at the beginning of the FDC
2936 setup. fdc_hw_init() must be provided by the board
2937 source code. It is used to make hardware dependant
2938 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002939
Macpaul Lin0abddf82011-04-11 20:45:32 +00002940- CONFIG_IDE_AHB:
2941 Most IDE controllers were designed to be connected with PCI
2942 interface. Only few of them were designed for AHB interface.
2943 When software is doing ATA command and data transfer to
2944 IDE devices through IDE-AHB controller, some additional
2945 registers accessing to these kind of IDE-AHB controller
2946 is requierd.
2947
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002948- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002949 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002950 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002951
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002952- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002953
wdenk7152b1d2003-09-05 23:19:14 +00002954 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002955 initial data and stack; please note that this must be
2956 writable memory that is working WITHOUT special
2957 initialization, i. e. you CANNOT use normal RAM which
2958 will become available only after programming the
2959 memory controller and running certain initialization
2960 sequences.
2961
2962 U-Boot uses the following memory types:
2963 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2964 - MPC824X: data cache
2965 - PPC4xx: data cache
2966
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002967- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002968
2969 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002970 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2971 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002972 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002973 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002974 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2975 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2976 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002977
2978 Note:
2979 On the MPC824X (or other systems that use the data
2980 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002981 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002982 point to an otherwise UNUSED address space between
2983 the top of RAM and the start of the PCI space.
2984
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002985- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002986
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002987- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002989- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002991- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002993- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002995- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002997- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002998 SDRAM timing
2999
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003000- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003001 periodic timer for refresh
3002
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003003- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003004
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003005- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3006 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3007 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3008 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003009 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3010
3011- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003012 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3013 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003014 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3015
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003016- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3017 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003018 Machine Mode Register and Memory Periodic Timer
3019 Prescaler definitions (SDRAM timing)
3020
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003021- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003022 enable I2C microcode relocation patch (MPC8xx);
3023 define relocation offset in DPRAM [DSP2]
3024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003025- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003026 enable SMC microcode relocation patch (MPC8xx);
3027 define relocation offset in DPRAM [SMC1]
3028
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003029- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003030 enable SPI microcode relocation patch (MPC8xx);
3031 define relocation offset in DPRAM [SCC4]
3032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003033- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003034 Use OSCM clock mode on MBX8xx board. Be careful,
3035 wrong setting might damage your board. Read
3036 doc/README.MBX before setting this variable!
3037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003038- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003039 Offset of the bootmode word in DPRAM used by post
3040 (Power On Self Tests). This definition overrides
3041 #define'd default value in commproc.h resp.
3042 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003043
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003044- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3045 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3046 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3047 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3048 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3049 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3050 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3051 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003052 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003053
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003054- CONFIG_PCI_DISABLE_PCIE:
3055 Disable PCI-Express on systems where it is supported but not
3056 required.
3057
Kumar Galaa09b9b62010-12-30 12:09:53 -06003058- CONFIG_SYS_SRIO:
3059 Chip has SRIO or not
3060
3061- CONFIG_SRIO1:
3062 Board has SRIO 1 port available
3063
3064- CONFIG_SRIO2:
3065 Board has SRIO 2 port available
3066
3067- CONFIG_SYS_SRIOn_MEM_VIRT:
3068 Virtual Address of SRIO port 'n' memory region
3069
3070- CONFIG_SYS_SRIOn_MEM_PHYS:
3071 Physical Address of SRIO port 'n' memory region
3072
3073- CONFIG_SYS_SRIOn_MEM_SIZE:
3074 Size of SRIO port 'n' memory region
3075
Alex Watermaneced4622011-05-19 15:08:36 -04003076- CONFIG_SYS_NDFC_16
3077 Defined to tell the NDFC that the NAND chip is using a
3078 16 bit bus.
3079
3080- CONFIG_SYS_NDFC_EBC0_CFG
3081 Sets the EBC0_CFG register for the NDFC. If not defined
3082 a default value will be used.
3083
Ben Warrenbb99ad62006-09-07 16:50:54 -04003084- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003085 Get DDR timing information from an I2C EEPROM. Common
3086 with pluggable memory modules such as SODIMMs
3087
Ben Warrenbb99ad62006-09-07 16:50:54 -04003088 SPD_EEPROM_ADDRESS
3089 I2C address of the SPD EEPROM
3090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003091- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003092 If SPD EEPROM is on an I2C bus other than the first
3093 one, specify here. Note that the value must resolve
3094 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003095
York Sun1b3e3c42011-06-07 09:42:16 +08003096- CONFIG_SYS_DDR_RAW_TIMING
3097 Get DDR timing information from other than SPD. Common with
3098 soldered DDR chips onboard without SPD. DDR raw timing
3099 parameters are extracted from datasheet and hard-coded into
3100 header files or board specific files.
3101
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003102- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003103 Only for 83xx systems. If specified, then DDR should
3104 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003105
wdenkc26e4542004-04-18 10:13:26 +00003106- CONFIG_ETHER_ON_FEC[12]
3107 Define to enable FEC[12] on a 8xx series processor.
3108
3109- CONFIG_FEC[12]_PHY
3110 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003111 to the given FEC; i. e.
3112 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003113 means that the PHY with address 4 is connected to FEC1
3114
3115 When set to -1, means to probe for first available.
3116
3117- CONFIG_FEC[12]_PHY_NORXERR
3118 The PHY does not have a RXERR line (RMII only).
3119 (so program the FEC to ignore it).
3120
3121- CONFIG_RMII
3122 Enable RMII mode for all FECs.
3123 Note that this is a global option, we can't
3124 have one FEC in standard MII mode and another in RMII mode.
3125
wdenk5cf91d62004-04-23 20:32:05 +00003126- CONFIG_CRC32_VERIFY
3127 Add a verify option to the crc32 command.
3128 The syntax is:
3129
3130 => crc32 -v <address> <count> <crc32>
3131
3132 Where address/count indicate a memory area
3133 and crc32 is the correct crc32 which the
3134 area should have.
3135
wdenk56523f12004-07-11 17:40:54 +00003136- CONFIG_LOOPW
3137 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003138 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003139
stroese7b466642004-12-16 18:46:55 +00003140- CONFIG_MX_CYCLIC
3141 Add the "mdc" and "mwc" memory commands. These are cyclic
3142 "md/mw" commands.
3143 Examples:
3144
wdenkefe2a4d2004-12-16 21:44:03 +00003145 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003146 This command will print 4 bytes (10,11,12,13) each 500 ms.
3147
wdenkefe2a4d2004-12-16 21:44:03 +00003148 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003149 This command will write 12345678 to address 100 all 10 ms.
3150
wdenkefe2a4d2004-12-16 21:44:03 +00003151 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003152 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003153
wdenk8aa1a2d2005-04-04 12:44:11 +00003154- CONFIG_SKIP_LOWLEVEL_INIT
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +02003155 [ARM, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003156 low level initializations (like setting up the memory
3157 controller) are omitted and/or U-Boot does not
3158 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003159
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003160 Normally this variable MUST NOT be defined. The only
3161 exception is when U-Boot is loaded (to RAM) by some
3162 other boot loader or by a debugger which performs
3163 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003164
Aneesh V401bb302011-07-13 05:11:07 +00003165- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003166 Modifies the behaviour of start.S when compiling a loader
3167 that is executed before the actual U-Boot. E.g. when
3168 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003169
Matthias Weisserd8834a12011-03-10 21:36:32 +00003170- CONFIG_USE_ARCH_MEMCPY
3171 CONFIG_USE_ARCH_MEMSET
3172 If these options are used a optimized version of memcpy/memset will
3173 be used if available. These functions may be faster under some
3174 conditions but may increase the binary size.
3175
wdenkc6097192002-11-03 00:24:07 +00003176Building the Software:
3177======================
3178
Wolfgang Denk218ca722008-03-26 10:40:12 +01003179Building U-Boot has been tested in several native build environments
3180and in many different cross environments. Of course we cannot support
3181all possibly existing versions of cross development tools in all
3182(potentially obsolete) versions. In case of tool chain problems we
3183recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3184which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003185
Wolfgang Denk218ca722008-03-26 10:40:12 +01003186If you are not using a native environment, it is assumed that you
3187have GNU cross compiling tools available in your path. In this case,
3188you must set the environment variable CROSS_COMPILE in your shell.
3189Note that no changes to the Makefile or any other source files are
3190necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003191
Wolfgang Denk218ca722008-03-26 10:40:12 +01003192 $ CROSS_COMPILE=ppc_4xx-
3193 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003194
Peter Tyser2f8d3962009-03-13 18:54:51 -05003195Note: If you wish to generate Windows versions of the utilities in
3196 the tools directory you can use the MinGW toolchain
3197 (http://www.mingw.org). Set your HOST tools to the MinGW
3198 toolchain and execute 'make tools'. For example:
3199
3200 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3201
3202 Binaries such as tools/mkimage.exe will be created which can
3203 be executed on computers running Windows.
3204
Wolfgang Denk218ca722008-03-26 10:40:12 +01003205U-Boot is intended to be simple to build. After installing the
3206sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003207is done by typing:
3208
3209 make NAME_config
3210
Wolfgang Denk218ca722008-03-26 10:40:12 +01003211where "NAME_config" is the name of one of the existing configu-
3212rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003213
wdenk2729af92004-05-03 20:45:30 +00003214Note: for some board special configuration names may exist; check if
3215 additional information is available from the board vendor; for
3216 instance, the TQM823L systems are available without (standard)
3217 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003218 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003219
wdenk2729af92004-05-03 20:45:30 +00003220 make TQM823L_config
3221 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003222
wdenk2729af92004-05-03 20:45:30 +00003223 make TQM823L_LCD_config
3224 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003225
wdenk2729af92004-05-03 20:45:30 +00003226 etc.
wdenkc6097192002-11-03 00:24:07 +00003227
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk2729af92004-05-03 20:45:30 +00003229Finally, type "make all", and you should get some working U-Boot
3230images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003231
wdenk2729af92004-05-03 20:45:30 +00003232- "u-boot.bin" is a raw binary image
3233- "u-boot" is an image in ELF binary format
3234- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003235
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003236By default the build is performed locally and the objects are saved
3237in the source directory. One of the two methods can be used to change
3238this behavior and build U-Boot to some external directory:
3239
32401. Add O= to the make command line invocations:
3241
3242 make O=/tmp/build distclean
3243 make O=/tmp/build NAME_config
3244 make O=/tmp/build all
3245
32462. Set environment variable BUILD_DIR to point to the desired location:
3247
3248 export BUILD_DIR=/tmp/build
3249 make distclean
3250 make NAME_config
3251 make all
3252
3253Note that the command line "O=" setting overrides the BUILD_DIR environment
3254variable.
3255
wdenkc6097192002-11-03 00:24:07 +00003256
wdenk2729af92004-05-03 20:45:30 +00003257Please be aware that the Makefiles assume you are using GNU make, so
3258for instance on NetBSD you might need to use "gmake" instead of
3259native "make".
wdenkc6097192002-11-03 00:24:07 +00003260
wdenkc6097192002-11-03 00:24:07 +00003261
wdenk2729af92004-05-03 20:45:30 +00003262If the system board that you have is not listed, then you will need
3263to port U-Boot to your hardware platform. To do this, follow these
3264steps:
wdenkc6097192002-11-03 00:24:07 +00003265
wdenk2729af92004-05-03 20:45:30 +000032661. Add a new configuration option for your board to the toplevel
3267 "Makefile" and to the "MAKEALL" script, using the existing
3268 entries as examples. Note that here and at many other places
3269 boards and other names are listed in alphabetical sort order. Please
3270 keep this order.
32712. Create a new directory to hold your board specific code. Add any
3272 files you need. In your board directory, you will need at least
3273 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
32743. Create a new configuration file "include/configs/<board>.h" for
3275 your board
32763. If you're porting U-Boot to a new CPU, then also create a new
3277 directory to hold your CPU specific code. Add any files you need.
32784. Run "make <board>_config" with your new name.
32795. Type "make", and you should get a working "u-boot.srec" file
3280 to be installed on your target system.
32816. Debug and solve any problems that might arise.
3282 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003283
wdenkc6097192002-11-03 00:24:07 +00003284
wdenk2729af92004-05-03 20:45:30 +00003285Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3286==============================================================
wdenkc6097192002-11-03 00:24:07 +00003287
Wolfgang Denk218ca722008-03-26 10:40:12 +01003288If you have modified U-Boot sources (for instance added a new board
3289or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003290provide feedback to the other developers. The feedback normally takes
3291the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003292official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003293
Wolfgang Denk218ca722008-03-26 10:40:12 +01003294But before you submit such a patch, please verify that your modifi-
3295cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003296the supported boards compile WITHOUT ANY compiler warnings. To do so,
3297just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003298for ALL supported system. Be warned, this will take a while. You can
3299select which (cross) compiler to use by passing a `CROSS_COMPILE'
3300environment variable to the script, i. e. to use the ELDK cross tools
3301you can type
wdenkc6097192002-11-03 00:24:07 +00003302
wdenk2729af92004-05-03 20:45:30 +00003303 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003304
wdenk2729af92004-05-03 20:45:30 +00003305or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003308
Wolfgang Denk218ca722008-03-26 10:40:12 +01003309When using the MAKEALL script, the default behaviour is to build
3310U-Boot in the source directory. This location can be changed by
3311setting the BUILD_DIR environment variable. Also, for each target
3312built, the MAKEALL script saves two log files (<target>.ERR and
3313<target>.MAKEALL) in the <source dir>/LOG directory. This default
3314location can be changed by setting the MAKEALL_LOGDIR environment
3315variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003316
3317 export BUILD_DIR=/tmp/build
3318 export MAKEALL_LOGDIR=/tmp/log
3319 CROSS_COMPILE=ppc_8xx- MAKEALL
3320
Wolfgang Denk218ca722008-03-26 10:40:12 +01003321With the above settings build objects are saved in the /tmp/build,
3322log files are saved in the /tmp/log and the source tree remains clean
3323during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003324
3325
wdenk2729af92004-05-03 20:45:30 +00003326See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003327
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329Monitor Commands - Overview:
3330============================
wdenkc6097192002-11-03 00:24:07 +00003331
wdenk2729af92004-05-03 20:45:30 +00003332go - start application at address 'addr'
3333run - run commands in an environment variable
3334bootm - boot application image from memory
3335bootp - boot image via network using BootP/TFTP protocol
3336tftpboot- boot image via network using TFTP protocol
3337 and env variables "ipaddr" and "serverip"
3338 (and eventually "gatewayip")
3339rarpboot- boot image via network using RARP/TFTP protocol
3340diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3341loads - load S-Record file over serial line
3342loadb - load binary file over serial line (kermit mode)
3343md - memory display
3344mm - memory modify (auto-incrementing)
3345nm - memory modify (constant address)
3346mw - memory write (fill)
3347cp - memory copy
3348cmp - memory compare
3349crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003350i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003351sspi - SPI utility commands
3352base - print or set address offset
3353printenv- print environment variables
3354setenv - set environment variables
3355saveenv - save environment variables to persistent storage
3356protect - enable or disable FLASH write protection
3357erase - erase FLASH memory
3358flinfo - print FLASH memory information
3359bdinfo - print Board Info structure
3360iminfo - print header information for application image
3361coninfo - print console devices and informations
3362ide - IDE sub-system
3363loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003364loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003365mtest - simple RAM test
3366icache - enable or disable instruction cache
3367dcache - enable or disable data cache
3368reset - Perform RESET of the CPU
3369echo - echo args to console
3370version - print monitor version
3371help - print online help
3372? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003373
wdenkc6097192002-11-03 00:24:07 +00003374
wdenk2729af92004-05-03 20:45:30 +00003375Monitor Commands - Detailed Description:
3376========================================
wdenkc6097192002-11-03 00:24:07 +00003377
wdenk2729af92004-05-03 20:45:30 +00003378TODO.
wdenkc6097192002-11-03 00:24:07 +00003379
wdenk2729af92004-05-03 20:45:30 +00003380For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003381
3382
wdenk2729af92004-05-03 20:45:30 +00003383Environment Variables:
3384======================
wdenkc6097192002-11-03 00:24:07 +00003385
wdenk2729af92004-05-03 20:45:30 +00003386U-Boot supports user configuration using Environment Variables which
3387can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003388
wdenk2729af92004-05-03 20:45:30 +00003389Environment Variables are set using "setenv", printed using
3390"printenv", and saved to Flash using "saveenv". Using "setenv"
3391without a value can be used to delete a variable from the
3392environment. As long as you don't save the environment you are
3393working with an in-memory copy. In case the Flash area containing the
3394environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003395
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003396Some configuration options can be set using Environment Variables.
3397
3398List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003399
wdenk2729af92004-05-03 20:45:30 +00003400 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003401
wdenk2729af92004-05-03 20:45:30 +00003402 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003403
wdenk2729af92004-05-03 20:45:30 +00003404 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk2729af92004-05-03 20:45:30 +00003408 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003409
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003410 bootm_low - Memory range available for image processing in the bootm
3411 command can be restricted. This variable is given as
3412 a hexadecimal number and defines lowest address allowed
3413 for use by the bootm command. See also "bootm_size"
3414 environment variable. Address defined by "bootm_low" is
3415 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003416 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3417 bootm_mapsize.
3418
3419 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3420 This variable is given as a hexadecimal number and it
3421 defines the size of the memory region starting at base
3422 address bootm_low that is accessible by the Linux kernel
3423 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3424 as the default value if it is defined, and bootm_size is
3425 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003426
3427 bootm_size - Memory range available for image processing in the bootm
3428 command can be restricted. This variable is given as
3429 a hexadecimal number and defines the size of the region
3430 allowed for use by the bootm command. See also "bootm_low"
3431 environment variable.
3432
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003433 updatefile - Location of the software update file on a TFTP server, used
3434 by the automatic software update feature. Please refer to
3435 documentation in doc/README.update for more details.
3436
wdenk2729af92004-05-03 20:45:30 +00003437 autoload - if set to "no" (any string beginning with 'n'),
3438 "bootp" will just load perform a lookup of the
3439 configuration from the BOOTP server, but not try to
3440 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003441
wdenk2729af92004-05-03 20:45:30 +00003442 autostart - if set to "yes", an image loaded using the "bootp",
3443 "rarpboot", "tftpboot" or "diskboot" commands will
3444 be automatically started (by internally calling
3445 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003446
wdenk2729af92004-05-03 20:45:30 +00003447 If set to "no", a standalone image passed to the
3448 "bootm" command will be copied to the load address
3449 (and eventually uncompressed), but NOT be started.
3450 This can be used to load and uncompress arbitrary
3451 data.
wdenkc6097192002-11-03 00:24:07 +00003452
David A. Longa28afca2011-07-09 16:40:19 -04003453 fdt_high - if set this restricts the maximum address that the
3454 flattened device tree will be copied into upon boot.
3455 If this is set to the special value 0xFFFFFFFF then
3456 the fdt will not be copied at all on boot. For this
3457 to work it must reside in writable memory, have
3458 sufficient padding on the end of it for u-boot to
3459 add the information it needs into it, and the memory
3460 must be accessible by the kernel.
3461
wdenk17ea1172004-06-06 21:51:03 +00003462 i2cfast - (PPC405GP|PPC405EP only)
3463 if set to 'y' configures Linux I2C driver for fast
3464 mode (400kHZ). This environment variable is used in
3465 initialization code. So, for changes to be effective
3466 it must be saved and board must be reset.
3467
wdenk2729af92004-05-03 20:45:30 +00003468 initrd_high - restrict positioning of initrd images:
3469 If this variable is not set, initrd images will be
3470 copied to the highest possible address in RAM; this
3471 is usually what you want since it allows for
3472 maximum initrd size. If for some reason you want to
3473 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003474 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003475 variable to a value of "no" or "off" or "0".
3476 Alternatively, you can set it to a maximum upper
3477 address to use (U-Boot will still check that it
3478 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk2729af92004-05-03 20:45:30 +00003480 For instance, when you have a system with 16 MB
3481 RAM, and want to reserve 4 MB from use by Linux,
3482 you can do this by adding "mem=12M" to the value of
3483 the "bootargs" variable. However, now you must make
3484 sure that the initrd image is placed in the first
3485 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003486
wdenk2729af92004-05-03 20:45:30 +00003487 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003488
wdenk2729af92004-05-03 20:45:30 +00003489 If you set initrd_high to 0xFFFFFFFF, this is an
3490 indication to U-Boot that all addresses are legal
3491 for the Linux kernel, including addresses in flash
3492 memory. In this case U-Boot will NOT COPY the
3493 ramdisk at all. This may be useful to reduce the
3494 boot time on your system, but requires that this
3495 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003496
wdenk2729af92004-05-03 20:45:30 +00003497 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003498
wdenk2729af92004-05-03 20:45:30 +00003499 loadaddr - Default load address for commands like "bootp",
3500 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003501
wdenk2729af92004-05-03 20:45:30 +00003502 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003505
wdenk2729af92004-05-03 20:45:30 +00003506 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003507
wdenk2729af92004-05-03 20:45:30 +00003508 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003511
Mike Frysingere2a53452011-10-02 10:01:27 +00003512 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003513
Mike Frysingere2a53452011-10-02 10:01:27 +00003514 ethact - controls which interface is currently active.
3515 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003516
Heiko Schocher48690d82010-07-20 17:45:02 +02003517 => setenv ethact FEC
3518 => ping 192.168.0.1 # traffic sent on FEC
3519 => setenv ethact SCC
3520 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003521
Matthias Fuchse1692572008-01-17 07:45:05 +01003522 ethrotate - When set to "no" U-Boot does not go through all
3523 available network interfaces.
3524 It just stays at the currently selected interface.
3525
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003526 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003527 either succeed or fail without retrying.
3528 When set to "once" the network operation will
3529 fail when all the available network interfaces
3530 are tried once without success.
3531 Useful on scripts which control the retry operation
3532 themselves.
wdenkc6097192002-11-03 00:24:07 +00003533
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003534 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003535
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003536 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003537 UDP source port.
3538
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003539 tftpdstport - If this is set, the value is used for TFTP's UDP
3540 destination port instead of the Well Know Port 69.
3541
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003542 tftpblocksize - Block size to use for TFTP transfers; if not set,
3543 we use the TFTP server's default block size
3544
3545 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3546 seconds, minimum value is 1000 = 1 second). Defines
3547 when a packet is considered to be lost so it has to
3548 be retransmitted. The default is 5000 = 5 seconds.
3549 Lowering this value may make downloads succeed
3550 faster in networks with high packet loss rates or
3551 with unreliable TFTP servers.
3552
3553 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003554 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003555 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003556
wdenk2729af92004-05-03 20:45:30 +00003557The following environment variables may be used and automatically
3558updated by the network boot commands ("bootp" and "rarpboot"),
3559depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003560
wdenk2729af92004-05-03 20:45:30 +00003561 bootfile - see above
3562 dnsip - IP address of your Domain Name Server
3563 dnsip2 - IP address of your secondary Domain Name Server
3564 gatewayip - IP address of the Gateway (Router) to use
3565 hostname - Target hostname
3566 ipaddr - see above
3567 netmask - Subnet Mask
3568 rootpath - Pathname of the root filesystem on the NFS server
3569 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003570
wdenka3d991b2004-04-15 21:48:45 +00003571
wdenk2729af92004-05-03 20:45:30 +00003572There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003573
wdenk2729af92004-05-03 20:45:30 +00003574 serial# - contains hardware identification information such
3575 as type string and/or serial number
3576 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003577
wdenk2729af92004-05-03 20:45:30 +00003578These variables can be set only once (usually during manufacturing of
3579the board). U-Boot refuses to delete or overwrite these variables
3580once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003581
3582
wdenk2729af92004-05-03 20:45:30 +00003583Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003584
wdenk2729af92004-05-03 20:45:30 +00003585 ver - Contains the U-Boot version string as printed
3586 with the "version" command. This variable is
3587 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003588
wdenkc6097192002-11-03 00:24:07 +00003589
wdenk2729af92004-05-03 20:45:30 +00003590Please note that changes to some configuration parameters may take
3591only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003592
stroesec1551ea2003-04-04 15:53:41 +00003593
wdenk2729af92004-05-03 20:45:30 +00003594Command Line Parsing:
3595=====================
stroesec1551ea2003-04-04 15:53:41 +00003596
wdenk2729af92004-05-03 20:45:30 +00003597There are two different command line parsers available with U-Boot:
3598the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003599
wdenk2729af92004-05-03 20:45:30 +00003600Old, simple command line parser:
3601--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003602
wdenk2729af92004-05-03 20:45:30 +00003603- supports environment variables (through setenv / saveenv commands)
3604- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003605- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003606- special characters ('$', ';') can be escaped by prefixing with '\',
3607 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003608 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003609- You can also escape text by enclosing in single apostrophes, for example:
3610 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003611
wdenk2729af92004-05-03 20:45:30 +00003612Hush shell:
3613-----------
wdenkf07771c2003-05-28 08:06:31 +00003614
wdenk2729af92004-05-03 20:45:30 +00003615- similar to Bourne shell, with control structures like
3616 if...then...else...fi, for...do...done; while...do...done,
3617 until...do...done, ...
3618- supports environment ("global") variables (through setenv / saveenv
3619 commands) and local shell variables (through standard shell syntax
3620 "name=value"); only environment variables can be used with "run"
3621 command
wdenkf07771c2003-05-28 08:06:31 +00003622
wdenk2729af92004-05-03 20:45:30 +00003623General rules:
3624--------------
wdenkf07771c2003-05-28 08:06:31 +00003625
wdenk2729af92004-05-03 20:45:30 +00003626(1) If a command line (or an environment variable executed by a "run"
3627 command) contains several commands separated by semicolon, and
3628 one of these commands fails, then the remaining commands will be
3629 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003630
wdenk2729af92004-05-03 20:45:30 +00003631(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003632 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003633 command will cause "run" to terminate, i. e. the remaining
3634 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003635
wdenk2729af92004-05-03 20:45:30 +00003636Note for Redundant Ethernet Interfaces:
3637=======================================
wdenkf07771c2003-05-28 08:06:31 +00003638
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003639Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003640such configurations and is capable of automatic selection of a
3641"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003642
wdenk2729af92004-05-03 20:45:30 +00003643Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3644MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3645"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003646
wdenk2729af92004-05-03 20:45:30 +00003647If the network interface stores some valid MAC address (for instance
3648in SROM), this is used as default address if there is NO correspon-
3649ding setting in the environment; if the corresponding environment
3650variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003651
wdenk2729af92004-05-03 20:45:30 +00003652o If the SROM has a valid MAC address, and there is no address in the
3653 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003654
wdenk2729af92004-05-03 20:45:30 +00003655o If there is no valid address in the SROM, and a definition in the
3656 environment exists, then the value from the environment variable is
3657 used.
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659o If both the SROM and the environment contain a MAC address, and
3660 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662o If both the SROM and the environment contain a MAC address, and the
3663 addresses differ, the value from the environment is used and a
3664 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003665
wdenk2729af92004-05-03 20:45:30 +00003666o If neither SROM nor the environment contain a MAC address, an error
3667 is raised.
wdenkc6097192002-11-03 00:24:07 +00003668
Ben Warrenecee9322010-04-26 11:11:46 -07003669If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3670will be programmed into hardware as part of the initialization process. This
3671may be skipped by setting the appropriate 'ethmacskip' environment variable.
3672The naming convention is as follows:
3673"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003674
wdenk2729af92004-05-03 20:45:30 +00003675Image Formats:
3676==============
wdenkc6097192002-11-03 00:24:07 +00003677
Marian Balakowicz3310c542008-03-12 12:13:13 +01003678U-Boot is capable of booting (and performing other auxiliary operations on)
3679images in two formats:
3680
3681New uImage format (FIT)
3682-----------------------
3683
3684Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3685to Flattened Device Tree). It allows the use of images with multiple
3686components (several kernels, ramdisks, etc.), with contents protected by
3687SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3688
3689
3690Old uImage format
3691-----------------
3692
3693Old image format is based on binary files which can be basically anything,
3694preceded by a special header; see the definitions in include/image.h for
3695details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3698 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003699 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3700 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3701 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003702* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003703 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3704 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003705* Compression Type (uncompressed, gzip, bzip2)
3706* Load Address
3707* Entry Point
3708* Image Name
3709* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003710
wdenk2729af92004-05-03 20:45:30 +00003711The header is marked by a special Magic Number, and both the header
3712and the data portions of the image are secured against corruption by
3713CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003714
wdenkc6097192002-11-03 00:24:07 +00003715
wdenk2729af92004-05-03 20:45:30 +00003716Linux Support:
3717==============
wdenkc6097192002-11-03 00:24:07 +00003718
wdenk2729af92004-05-03 20:45:30 +00003719Although U-Boot should support any OS or standalone application
3720easily, the main focus has always been on Linux during the design of
3721U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003722
wdenk2729af92004-05-03 20:45:30 +00003723U-Boot includes many features that so far have been part of some
3724special "boot loader" code within the Linux kernel. Also, any
3725"initrd" images to be used are no longer part of one big Linux image;
3726instead, kernel and "initrd" are separate images. This implementation
3727serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003728
wdenk2729af92004-05-03 20:45:30 +00003729- the same features can be used for other OS or standalone
3730 applications (for instance: using compressed images to reduce the
3731 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003732
wdenk2729af92004-05-03 20:45:30 +00003733- it becomes much easier to port new Linux kernel versions because
3734 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk2729af92004-05-03 20:45:30 +00003736- the same Linux kernel image can now be used with different "initrd"
3737 images; of course this also means that different kernel images can
3738 be run with the same "initrd". This makes testing easier (you don't
3739 have to build a new "zImage.initrd" Linux image when you just
3740 change a file in your "initrd"). Also, a field-upgrade of the
3741 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003742
wdenkc6097192002-11-03 00:24:07 +00003743
wdenk2729af92004-05-03 20:45:30 +00003744Linux HOWTO:
3745============
wdenkc6097192002-11-03 00:24:07 +00003746
wdenk2729af92004-05-03 20:45:30 +00003747Porting Linux to U-Boot based systems:
3748---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003749
wdenk2729af92004-05-03 20:45:30 +00003750U-Boot cannot save you from doing all the necessary modifications to
3751configure the Linux device drivers for use with your target hardware
3752(no, we don't intend to provide a full virtual machine interface to
3753Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003754
Stefan Roesea47a12b2010-04-15 16:07:28 +02003755But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003756
wdenk2729af92004-05-03 20:45:30 +00003757Just make sure your machine specific header file (for instance
3758include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003759Information structure as we define in include/asm-<arch>/u-boot.h,
3760and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003761as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003762
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk2729af92004-05-03 20:45:30 +00003764Configuring the Linux kernel:
3765-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003766
wdenk2729af92004-05-03 20:45:30 +00003767No specific requirements for U-Boot. Make sure you have some root
3768device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003769
wdenkc6097192002-11-03 00:24:07 +00003770
wdenk2729af92004-05-03 20:45:30 +00003771Building a Linux Image:
3772-----------------------
wdenkc6097192002-11-03 00:24:07 +00003773
wdenk2729af92004-05-03 20:45:30 +00003774With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3775not used. If you use recent kernel source, a new build target
3776"uImage" will exist which automatically builds an image usable by
3777U-Boot. Most older kernels also have support for a "pImage" target,
3778which was introduced for our predecessor project PPCBoot and uses a
3779100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003780
wdenk2729af92004-05-03 20:45:30 +00003781Example:
wdenkc6097192002-11-03 00:24:07 +00003782
wdenk2729af92004-05-03 20:45:30 +00003783 make TQM850L_config
3784 make oldconfig
3785 make dep
3786 make uImage
wdenkc6097192002-11-03 00:24:07 +00003787
wdenk2729af92004-05-03 20:45:30 +00003788The "uImage" build target uses a special tool (in 'tools/mkimage') to
3789encapsulate a compressed Linux kernel image with header information,
3790CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003791
wdenk2729af92004-05-03 20:45:30 +00003792* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003793
wdenk2729af92004-05-03 20:45:30 +00003794* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003795
wdenk2729af92004-05-03 20:45:30 +00003796 ${CROSS_COMPILE}-objcopy -O binary \
3797 -R .note -R .comment \
3798 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003799
wdenk2729af92004-05-03 20:45:30 +00003800* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003801
wdenk2729af92004-05-03 20:45:30 +00003802 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003805
wdenk2729af92004-05-03 20:45:30 +00003806 mkimage -A ppc -O linux -T kernel -C gzip \
3807 -a 0 -e 0 -n "Linux Kernel Image" \
3808 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003809
wdenk24ee89b2002-11-03 17:56:27 +00003810
wdenk2729af92004-05-03 20:45:30 +00003811The "mkimage" tool can also be used to create ramdisk images for use
3812with U-Boot, either separated from the Linux kernel image, or
3813combined into one file. "mkimage" encapsulates the images with a 64
3814byte header containing information about target architecture,
3815operating system, image type, compression method, entry points, time
3816stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003817
wdenk2729af92004-05-03 20:45:30 +00003818"mkimage" can be called in two ways: to verify existing images and
3819print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003820
wdenk2729af92004-05-03 20:45:30 +00003821In the first form (with "-l" option) mkimage lists the information
3822contained in the header of an existing U-Boot image; this includes
3823checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003824
wdenk2729af92004-05-03 20:45:30 +00003825 tools/mkimage -l image
3826 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828The second form (with "-d" option) is used to build a U-Boot image
3829from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003830
wdenk2729af92004-05-03 20:45:30 +00003831 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3832 -n name -d data_file image
3833 -A ==> set architecture to 'arch'
3834 -O ==> set operating system to 'os'
3835 -T ==> set image type to 'type'
3836 -C ==> set compression type 'comp'
3837 -a ==> set load address to 'addr' (hex)
3838 -e ==> set entry point to 'ep' (hex)
3839 -n ==> set image name to 'name'
3840 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003841
wdenk69459792004-05-29 16:53:29 +00003842Right now, all Linux kernels for PowerPC systems use the same load
3843address (0x00000000), but the entry point address depends on the
3844kernel version:
wdenkc6097192002-11-03 00:24:07 +00003845
wdenk2729af92004-05-03 20:45:30 +00003846- 2.2.x kernels have the entry point at 0x0000000C,
3847- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk2729af92004-05-03 20:45:30 +00003849So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3852 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003853 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003854 > examples/uImage.TQM850L
3855 Image Name: 2.4.4 kernel for TQM850L
3856 Created: Wed Jul 19 02:34:59 2000
3857 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3858 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3859 Load Address: 0x00000000
3860 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003861
wdenk2729af92004-05-03 20:45:30 +00003862To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864 -> tools/mkimage -l examples/uImage.TQM850L
3865 Image Name: 2.4.4 kernel for TQM850L
3866 Created: Wed Jul 19 02:34:59 2000
3867 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3868 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3869 Load Address: 0x00000000
3870 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk2729af92004-05-03 20:45:30 +00003872NOTE: for embedded systems where boot time is critical you can trade
3873speed for memory and install an UNCOMPRESSED image instead: this
3874needs more space in Flash, but boots much faster since it does not
3875need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003876
Stefan Roesea47a12b2010-04-15 16:07:28 +02003877 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003878 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3879 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003880 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003881 > examples/uImage.TQM850L-uncompressed
3882 Image Name: 2.4.4 kernel for TQM850L
3883 Created: Wed Jul 19 02:34:59 2000
3884 Image Type: PowerPC Linux Kernel Image (uncompressed)
3885 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3886 Load Address: 0x00000000
3887 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003888
wdenkc6097192002-11-03 00:24:07 +00003889
wdenk2729af92004-05-03 20:45:30 +00003890Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3891when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003892
wdenk2729af92004-05-03 20:45:30 +00003893 -> tools/mkimage -n 'Simple Ramdisk Image' \
3894 > -A ppc -O linux -T ramdisk -C gzip \
3895 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3896 Image Name: Simple Ramdisk Image
3897 Created: Wed Jan 12 14:01:50 2000
3898 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3899 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3900 Load Address: 0x00000000
3901 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003902
wdenkdb01a2e2004-04-15 23:14:49 +00003903
wdenk2729af92004-05-03 20:45:30 +00003904Installing a Linux Image:
3905-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003906
wdenk2729af92004-05-03 20:45:30 +00003907To downloading a U-Boot image over the serial (console) interface,
3908you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003909
wdenk2729af92004-05-03 20:45:30 +00003910 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003911
wdenk2729af92004-05-03 20:45:30 +00003912The 'objcopy' does not understand the information in the U-Boot
3913image header, so the resulting S-Record file will be relative to
3914address 0x00000000. To load it to a given address, you need to
3915specify the target address as 'offset' parameter with the 'loads'
3916command.
wdenkc6097192002-11-03 00:24:07 +00003917
wdenk2729af92004-05-03 20:45:30 +00003918Example: install the image to address 0x40100000 (which on the
3919TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003920
wdenk2729af92004-05-03 20:45:30 +00003921 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003922
wdenk2729af92004-05-03 20:45:30 +00003923 .......... done
3924 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003925
wdenk2729af92004-05-03 20:45:30 +00003926 => loads 40100000
3927 ## Ready for S-Record download ...
3928 ~>examples/image.srec
3929 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3930 ...
3931 15989 15990 15991 15992
3932 [file transfer complete]
3933 [connected]
3934 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003935
3936
wdenk2729af92004-05-03 20:45:30 +00003937You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003938this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003939corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003940
wdenk2729af92004-05-03 20:45:30 +00003941 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003942
wdenk2729af92004-05-03 20:45:30 +00003943 ## Checking Image at 40100000 ...
3944 Image Name: 2.2.13 for initrd on TQM850L
3945 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3946 Data Size: 335725 Bytes = 327 kB = 0 MB
3947 Load Address: 00000000
3948 Entry Point: 0000000c
3949 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003950
3951
wdenk2729af92004-05-03 20:45:30 +00003952Boot Linux:
3953-----------
wdenkc6097192002-11-03 00:24:07 +00003954
wdenk2729af92004-05-03 20:45:30 +00003955The "bootm" command is used to boot an application that is stored in
3956memory (RAM or Flash). In case of a Linux kernel image, the contents
3957of the "bootargs" environment variable is passed to the kernel as
3958parameters. You can check and modify this variable using the
3959"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003960
3961
wdenk2729af92004-05-03 20:45:30 +00003962 => printenv bootargs
3963 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk2729af92004-05-03 20:45:30 +00003965 => 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 +00003966
wdenk2729af92004-05-03 20:45:30 +00003967 => printenv bootargs
3968 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 +00003969
wdenk2729af92004-05-03 20:45:30 +00003970 => bootm 40020000
3971 ## Booting Linux kernel at 40020000 ...
3972 Image Name: 2.2.13 for NFS on TQM850L
3973 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3974 Data Size: 381681 Bytes = 372 kB = 0 MB
3975 Load Address: 00000000
3976 Entry Point: 0000000c
3977 Verifying Checksum ... OK
3978 Uncompressing Kernel Image ... OK
3979 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
3980 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3981 time_init: decrementer frequency = 187500000/60
3982 Calibrating delay loop... 49.77 BogoMIPS
3983 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3984 ...
wdenkc6097192002-11-03 00:24:07 +00003985
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003986If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003987the memory addresses of both the kernel and the initrd image (PPBCOOT
3988format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003989
wdenk2729af92004-05-03 20:45:30 +00003990 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992 ## Checking Image at 40100000 ...
3993 Image Name: 2.2.13 for initrd on TQM850L
3994 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3995 Data Size: 335725 Bytes = 327 kB = 0 MB
3996 Load Address: 00000000
3997 Entry Point: 0000000c
3998 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003999
wdenk2729af92004-05-03 20:45:30 +00004000 ## Checking Image at 40200000 ...
4001 Image Name: Simple Ramdisk Image
4002 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4003 Data Size: 566530 Bytes = 553 kB = 0 MB
4004 Load Address: 00000000
4005 Entry Point: 00000000
4006 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004007
wdenk2729af92004-05-03 20:45:30 +00004008 => bootm 40100000 40200000
4009 ## Booting Linux kernel at 40100000 ...
4010 Image Name: 2.2.13 for initrd on TQM850L
4011 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4012 Data Size: 335725 Bytes = 327 kB = 0 MB
4013 Load Address: 00000000
4014 Entry Point: 0000000c
4015 Verifying Checksum ... OK
4016 Uncompressing Kernel Image ... OK
4017 ## Loading RAMDisk Image at 40200000 ...
4018 Image Name: Simple Ramdisk Image
4019 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4020 Data Size: 566530 Bytes = 553 kB = 0 MB
4021 Load Address: 00000000
4022 Entry Point: 00000000
4023 Verifying Checksum ... OK
4024 Loading Ramdisk ... OK
4025 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
4026 Boot arguments: root=/dev/ram
4027 time_init: decrementer frequency = 187500000/60
4028 Calibrating delay loop... 49.77 BogoMIPS
4029 ...
4030 RAMDISK: Compressed image found at block 0
4031 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004032
wdenk2729af92004-05-03 20:45:30 +00004033 bash#
wdenkc6097192002-11-03 00:24:07 +00004034
Matthew McClintock02677682006-06-28 10:41:37 -05004035Boot Linux and pass a flat device tree:
4036-----------
4037
4038First, U-Boot must be compiled with the appropriate defines. See the section
4039titled "Linux Kernel Interface" above for a more in depth explanation. The
4040following is an example of how to start a kernel and pass an updated
4041flat device tree:
4042
4043=> print oftaddr
4044oftaddr=0x300000
4045=> print oft
4046oft=oftrees/mpc8540ads.dtb
4047=> tftp $oftaddr $oft
4048Speed: 1000, full duplex
4049Using TSEC0 device
4050TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4051Filename 'oftrees/mpc8540ads.dtb'.
4052Load address: 0x300000
4053Loading: #
4054done
4055Bytes transferred = 4106 (100a hex)
4056=> tftp $loadaddr $bootfile
4057Speed: 1000, full duplex
4058Using TSEC0 device
4059TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4060Filename 'uImage'.
4061Load address: 0x200000
4062Loading:############
4063done
4064Bytes transferred = 1029407 (fb51f hex)
4065=> print loadaddr
4066loadaddr=200000
4067=> print oftaddr
4068oftaddr=0x300000
4069=> bootm $loadaddr - $oftaddr
4070## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004071 Image Name: Linux-2.6.17-dirty
4072 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4073 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004074 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004075 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004076 Verifying Checksum ... OK
4077 Uncompressing Kernel Image ... OK
4078Booting using flat device tree at 0x300000
4079Using MPC85xx ADS machine description
4080Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4081[snip]
4082
4083
wdenk2729af92004-05-03 20:45:30 +00004084More About U-Boot Image Types:
4085------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004088
wdenk2729af92004-05-03 20:45:30 +00004089 "Standalone Programs" are directly runnable in the environment
4090 provided by U-Boot; it is expected that (if they behave
4091 well) you can continue to work in U-Boot after return from
4092 the Standalone Program.
4093 "OS Kernel Images" are usually images of some Embedded OS which
4094 will take over control completely. Usually these programs
4095 will install their own set of exception handlers, device
4096 drivers, set up the MMU, etc. - this means, that you cannot
4097 expect to re-enter U-Boot except by resetting the CPU.
4098 "RAMDisk Images" are more or less just data blocks, and their
4099 parameters (address, size) are passed to an OS kernel that is
4100 being started.
4101 "Multi-File Images" contain several images, typically an OS
4102 (Linux) kernel image and one or more data images like
4103 RAMDisks. This construct is useful for instance when you want
4104 to boot over the network using BOOTP etc., where the boot
4105 server provides just a single image file, but you want to get
4106 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108 "Multi-File Images" start with a list of image sizes, each
4109 image size (in bytes) specified by an "uint32_t" in network
4110 byte order. This list is terminated by an "(uint32_t)0".
4111 Immediately after the terminating 0 follow the images, one by
4112 one, all aligned on "uint32_t" boundaries (size rounded up to
4113 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004114
wdenk2729af92004-05-03 20:45:30 +00004115 "Firmware Images" are binary images containing firmware (like
4116 U-Boot or FPGA images) which usually will be programmed to
4117 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004118
wdenk2729af92004-05-03 20:45:30 +00004119 "Script files" are command sequences that will be executed by
4120 U-Boot's command interpreter; this feature is especially
4121 useful when you configure U-Boot to use a real shell (hush)
4122 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004123
wdenkc6097192002-11-03 00:24:07 +00004124
wdenk2729af92004-05-03 20:45:30 +00004125Standalone HOWTO:
4126=================
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128One of the features of U-Boot is that you can dynamically load and
4129run "standalone" applications, which can use some resources of
4130U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004131
wdenk2729af92004-05-03 20:45:30 +00004132Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134"Hello World" Demo:
4135-------------------
wdenkc6097192002-11-03 00:24:07 +00004136
wdenk2729af92004-05-03 20:45:30 +00004137'examples/hello_world.c' contains a small "Hello World" Demo
4138application; it is automatically compiled when you build U-Boot.
4139It's configured to run at address 0x00040004, so you can play with it
4140like that:
wdenkc6097192002-11-03 00:24:07 +00004141
wdenk2729af92004-05-03 20:45:30 +00004142 => loads
4143 ## Ready for S-Record download ...
4144 ~>examples/hello_world.srec
4145 1 2 3 4 5 6 7 8 9 10 11 ...
4146 [file transfer complete]
4147 [connected]
4148 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004149
wdenk2729af92004-05-03 20:45:30 +00004150 => go 40004 Hello World! This is a test.
4151 ## Starting application at 0x00040004 ...
4152 Hello World
4153 argc = 7
4154 argv[0] = "40004"
4155 argv[1] = "Hello"
4156 argv[2] = "World!"
4157 argv[3] = "This"
4158 argv[4] = "is"
4159 argv[5] = "a"
4160 argv[6] = "test."
4161 argv[7] = "<NULL>"
4162 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004163
wdenk2729af92004-05-03 20:45:30 +00004164 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166Another example, which demonstrates how to register a CPM interrupt
4167handler with the U-Boot code, can be found in 'examples/timer.c'.
4168Here, a CPM timer is set up to generate an interrupt every second.
4169The interrupt service routine is trivial, just printing a '.'
4170character, but this is just a demo program. The application can be
4171controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004172
wdenk2729af92004-05-03 20:45:30 +00004173 ? - print current values og the CPM Timer registers
4174 b - enable interrupts and start timer
4175 e - stop timer and disable interrupts
4176 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004177
wdenk2729af92004-05-03 20:45:30 +00004178 => loads
4179 ## Ready for S-Record download ...
4180 ~>examples/timer.srec
4181 1 2 3 4 5 6 7 8 9 10 11 ...
4182 [file transfer complete]
4183 [connected]
4184 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004185
wdenk2729af92004-05-03 20:45:30 +00004186 => go 40004
4187 ## Starting application at 0x00040004 ...
4188 TIMERS=0xfff00980
4189 Using timer 1
4190 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004191
wdenk2729af92004-05-03 20:45:30 +00004192Hit 'b':
4193 [q, b, e, ?] Set interval 1000000 us
4194 Enabling timer
4195Hit '?':
4196 [q, b, e, ?] ........
4197 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4198Hit '?':
4199 [q, b, e, ?] .
4200 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4201Hit '?':
4202 [q, b, e, ?] .
4203 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4204Hit '?':
4205 [q, b, e, ?] .
4206 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4207Hit 'e':
4208 [q, b, e, ?] ...Stopping timer
4209Hit 'q':
4210 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004211
4212
wdenk2729af92004-05-03 20:45:30 +00004213Minicom warning:
4214================
wdenk85ec0bc2003-03-31 16:34:49 +00004215
wdenk2729af92004-05-03 20:45:30 +00004216Over time, many people have reported problems when trying to use the
4217"minicom" terminal emulation program for serial download. I (wd)
4218consider minicom to be broken, and recommend not to use it. Under
4219Unix, I recommend to use C-Kermit for general purpose use (and
4220especially for kermit binary protocol download ("loadb" command), and
4221use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004222
wdenk2729af92004-05-03 20:45:30 +00004223Nevertheless, if you absolutely want to use it try adding this
4224configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004225
wdenk2729af92004-05-03 20:45:30 +00004226 Name Program Name U/D FullScr IO-Red. Multi
4227 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4228 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004229
4230
wdenk2729af92004-05-03 20:45:30 +00004231NetBSD Notes:
4232=============
wdenkc6097192002-11-03 00:24:07 +00004233
wdenk2729af92004-05-03 20:45:30 +00004234Starting at version 0.9.2, U-Boot supports NetBSD both as host
4235(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004236
wdenk2729af92004-05-03 20:45:30 +00004237Building requires a cross environment; it is known to work on
4238NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4239need gmake since the Makefiles are not compatible with BSD make).
4240Note that the cross-powerpc package does not install include files;
4241attempting to build U-Boot will fail because <machine/ansi.h> is
4242missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004243
wdenk2729af92004-05-03 20:45:30 +00004244 # cd /usr/pkg/cross/powerpc-netbsd/include
4245 # mkdir powerpc
4246 # ln -s powerpc machine
4247 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4248 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk2729af92004-05-03 20:45:30 +00004250Native builds *don't* work due to incompatibilities between native
4251and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253Booting assumes that (the first part of) the image booted is a
4254stage-2 loader which in turn loads and then invokes the kernel
4255proper. Loader sources will eventually appear in the NetBSD source
4256tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004257meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004258
4259
wdenk2729af92004-05-03 20:45:30 +00004260Implementation Internals:
4261=========================
wdenkc6097192002-11-03 00:24:07 +00004262
wdenk2729af92004-05-03 20:45:30 +00004263The following is not intended to be a complete description of every
4264implementation detail. However, it should help to understand the
4265inner workings of U-Boot and make it easier to port it to custom
4266hardware.
wdenkc6097192002-11-03 00:24:07 +00004267
4268
wdenk2729af92004-05-03 20:45:30 +00004269Initial Stack, Global Data:
4270---------------------------
wdenkc6097192002-11-03 00:24:07 +00004271
wdenk2729af92004-05-03 20:45:30 +00004272The implementation of U-Boot is complicated by the fact that U-Boot
4273starts running out of ROM (flash memory), usually without access to
4274system RAM (because the memory controller is not initialized yet).
4275This means that we don't have writable Data or BSS segments, and BSS
4276is not initialized as zero. To be able to get a C environment working
4277at all, we have to allocate at least a minimal stack. Implementation
4278options for this are defined and restricted by the CPU used: Some CPU
4279models provide on-chip memory (like the IMMR area on MPC8xx and
4280MPC826x processors), on others (parts of) the data cache can be
4281locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004282
Wolfgang Denk218ca722008-03-26 10:40:12 +01004283 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004284 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004285
wdenk2729af92004-05-03 20:45:30 +00004286 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4287 From: "Chris Hallinan" <clh@net1plus.com>
4288 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4289 ...
wdenk43d96162003-03-06 00:02:04 +00004290
wdenk2729af92004-05-03 20:45:30 +00004291 Correct me if I'm wrong, folks, but the way I understand it
4292 is this: Using DCACHE as initial RAM for Stack, etc, does not
4293 require any physical RAM backing up the cache. The cleverness
4294 is that the cache is being used as a temporary supply of
4295 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004296 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004297 can see how this works by studying the cache architecture and
4298 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004299
wdenk2729af92004-05-03 20:45:30 +00004300 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4301 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004302 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004303 option should work for you. Using CS 4 should be fine if your
4304 board designers haven't used it for something that would
4305 cause you grief during the initial boot! It is frequently not
4306 used.
wdenk43d96162003-03-06 00:02:04 +00004307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004308 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004309 with your processor/board/system design. The default value
4310 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004311 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004312 than your SDRAM module. If you have a 64MB SDRAM module, set
4313 it above 400_0000. Just make sure your board has no resources
4314 that are supposed to respond to that address! That code in
4315 start.S has been around a while and should work as is when
4316 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004317
wdenk2729af92004-05-03 20:45:30 +00004318 -Chris Hallinan
4319 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004320
wdenk2729af92004-05-03 20:45:30 +00004321It is essential to remember this, since it has some impact on the C
4322code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004323
wdenk2729af92004-05-03 20:45:30 +00004324* Initialized global data (data segment) is read-only. Do not attempt
4325 to write it.
wdenkc6097192002-11-03 00:24:07 +00004326
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004327* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004328 as zero data - BSS segment) at all - this is undefined, initiali-
4329 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004330
wdenk2729af92004-05-03 20:45:30 +00004331* Stack space is very limited. Avoid big data buffers or things like
4332 that.
wdenkc6097192002-11-03 00:24:07 +00004333
wdenk2729af92004-05-03 20:45:30 +00004334Having only the stack as writable memory limits means we cannot use
4335normal global data to share information beween the code. But it
4336turned out that the implementation of U-Boot can be greatly
4337simplified by making a global data structure (gd_t) available to all
4338functions. We could pass a pointer to this data as argument to _all_
4339functions, but this would bloat the code. Instead we use a feature of
4340the GCC compiler (Global Register Variables) to share the data: we
4341place a pointer (gd) to the global data into a register which we
4342reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004343
wdenk2729af92004-05-03 20:45:30 +00004344When choosing a register for such a purpose we are restricted by the
4345relevant (E)ABI specifications for the current architecture, and by
4346GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004347
wdenk2729af92004-05-03 20:45:30 +00004348For PowerPC, the following registers have specific use:
4349 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004350 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004351 R3-R4: parameter passing and return values
4352 R5-R10: parameter passing
4353 R13: small data area pointer
4354 R30: GOT pointer
4355 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004356
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004357 (U-Boot also uses R12 as internal GOT pointer. r12
4358 is a volatile register so r12 needs to be reset when
4359 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004360
Wolfgang Denke7670f62008-02-14 22:43:22 +01004361 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004362
wdenk2729af92004-05-03 20:45:30 +00004363 Note: on PPC, we could use a static initializer (since the
4364 address of the global data structure is known at compile time),
4365 but it turned out that reserving a register results in somewhat
4366 smaller code - although the code savings are not that big (on
4367 average for all boards 752 bytes for the whole U-Boot image,
4368 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004369
Robin Getzc4db3352009-08-17 15:23:02 +00004370On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004371 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4372
Robin Getzc4db3352009-08-17 15:23:02 +00004373 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004374
wdenk2729af92004-05-03 20:45:30 +00004375On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004376
wdenk2729af92004-05-03 20:45:30 +00004377 R0: function argument word/integer result
4378 R1-R3: function argument word
4379 R9: GOT pointer
4380 R10: stack limit (used only if stack checking if enabled)
4381 R11: argument (frame) pointer
4382 R12: temporary workspace
4383 R13: stack pointer
4384 R14: link register
4385 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004386
wdenk2729af92004-05-03 20:45:30 +00004387 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004388
Thomas Chou0df01fd2010-05-21 11:08:03 +08004389On Nios II, the ABI is documented here:
4390 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4391
4392 ==> U-Boot will use gp to hold a pointer to the global data
4393
4394 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4395 to access small data sections, so gp is free.
4396
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004397NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4398or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004399
wdenk2729af92004-05-03 20:45:30 +00004400Memory Management:
4401------------------
wdenkc6097192002-11-03 00:24:07 +00004402
wdenk2729af92004-05-03 20:45:30 +00004403U-Boot runs in system state and uses physical addresses, i.e. the
4404MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406The available memory is mapped to fixed addresses using the memory
4407controller. In this process, a contiguous block is formed for each
4408memory type (Flash, SDRAM, SRAM), even when it consists of several
4409physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004410
wdenk2729af92004-05-03 20:45:30 +00004411U-Boot is installed in the first 128 kB of the first Flash bank (on
4412TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4413booting and sizing and initializing DRAM, the code relocates itself
4414to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004415memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004416configuration setting]. Below that, a structure with global Board
4417Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419Additionally, some exception handler code is copied to the low 8 kB
4420of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004421
wdenk2729af92004-05-03 20:45:30 +00004422So a typical memory configuration with 16 MB of DRAM could look like
4423this:
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk2729af92004-05-03 20:45:30 +00004425 0x0000 0000 Exception Vector code
4426 :
4427 0x0000 1FFF
4428 0x0000 2000 Free for Application Use
4429 :
4430 :
wdenkc6097192002-11-03 00:24:07 +00004431
wdenk2729af92004-05-03 20:45:30 +00004432 :
4433 :
4434 0x00FB FF20 Monitor Stack (Growing downward)
4435 0x00FB FFAC Board Info Data and permanent copy of global data
4436 0x00FC 0000 Malloc Arena
4437 :
4438 0x00FD FFFF
4439 0x00FE 0000 RAM Copy of Monitor Code
4440 ... eventually: LCD or video framebuffer
4441 ... eventually: pRAM (Protected RAM - unchanged by reset)
4442 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004443
4444
wdenk2729af92004-05-03 20:45:30 +00004445System Initialization:
4446----------------------
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk2729af92004-05-03 20:45:30 +00004448In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004449(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004450configuration for CS0# this is a mirror of the onboard Flash memory.
4451To be able to re-map memory U-Boot then jumps to its link address.
4452To be able to implement the initialization code in C, a (small!)
4453initial stack is set up in the internal Dual Ported RAM (in case CPUs
4454which provide such a feature like MPC8xx or MPC8260), or in a locked
4455part of the data cache. After that, U-Boot initializes the CPU core,
4456the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004457
wdenk2729af92004-05-03 20:45:30 +00004458Next, all (potentially) available memory banks are mapped using a
4459preliminary mapping. For example, we put them on 512 MB boundaries
4460(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4461on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4462programmed for SDRAM access. Using the temporary configuration, a
4463simple memory test is run that determines the size of the SDRAM
4464banks.
wdenkc6097192002-11-03 00:24:07 +00004465
wdenk2729af92004-05-03 20:45:30 +00004466When there is more than one SDRAM bank, and the banks are of
4467different size, the largest is mapped first. For equal size, the first
4468bank (CS2#) is mapped first. The first mapping is always for address
44690x00000000, with any additional banks following immediately to create
4470contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004471
wdenk2729af92004-05-03 20:45:30 +00004472Then, the monitor installs itself at the upper end of the SDRAM area
4473and allocates memory for use by malloc() and for the global Board
4474Info data; also, the exception vector code is copied to the low RAM
4475pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004476
wdenk2729af92004-05-03 20:45:30 +00004477Only after this relocation will you have a "normal" C environment;
4478until that you are restricted in several ways, mostly because you are
4479running from ROM, and because the code will have to be relocated to a
4480new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004481
4482
wdenk2729af92004-05-03 20:45:30 +00004483U-Boot Porting Guide:
4484----------------------
wdenkc6097192002-11-03 00:24:07 +00004485
wdenk2729af92004-05-03 20:45:30 +00004486[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4487list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004488
4489
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004490int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004491{
4492 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004493
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004494 signal(SIGALRM, no_more_time);
4495 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004496
wdenk2729af92004-05-03 20:45:30 +00004497 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004498 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004499 return 0;
4500 }
4501
wdenk2729af92004-05-03 20:45:30 +00004502 Download latest U-Boot source;
4503
Wolfgang Denk06682362008-12-30 22:56:11 +01004504 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004505
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004506 if (clueless)
4507 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk2729af92004-05-03 20:45:30 +00004509 while (learning) {
4510 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004511 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4512 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004513 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004514 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004515 }
wdenkc6097192002-11-03 00:24:07 +00004516
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004517 if (available_money > toLocalCurrency ($2500))
4518 Buy a BDI3000;
4519 else
wdenk2729af92004-05-03 20:45:30 +00004520 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004521
4522 if (a similar board exists) { /* hopefully... */
4523 cp -a board/<similar> board/<myboard>
4524 cp include/configs/<similar>.h include/configs/<myboard>.h
4525 } else {
4526 Create your own board support subdirectory;
4527 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004528 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004529 Edit new board/<myboard> files
4530 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004531
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004532 while (!accepted) {
4533 while (!running) {
4534 do {
4535 Add / modify source code;
4536 } until (compiles);
4537 Debug;
4538 if (clueless)
4539 email("Hi, I am having problems...");
4540 }
4541 Send patch file to the U-Boot email list;
4542 if (reasonable critiques)
4543 Incorporate improvements from email list code review;
4544 else
4545 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004546 }
wdenkc6097192002-11-03 00:24:07 +00004547
wdenk2729af92004-05-03 20:45:30 +00004548 return 0;
4549}
4550
4551void no_more_time (int sig)
4552{
4553 hire_a_guru();
4554}
wdenkc6097192002-11-03 00:24:07 +00004555
4556
wdenk2729af92004-05-03 20:45:30 +00004557Coding Standards:
4558-----------------
wdenkc6097192002-11-03 00:24:07 +00004559
wdenk2729af92004-05-03 20:45:30 +00004560All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004561coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004562"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004563
Detlev Zundel2c051652006-09-01 15:39:02 +02004564Source files originating from a different project (for example the
4565MTD subsystem) are generally exempt from these guidelines and are not
4566reformated to ease subsequent migration to newer versions of those
4567sources.
4568
4569Please note that U-Boot is implemented in C (and to some small parts in
4570Assembler); no C++ is used, so please do not use C++ style comments (//)
4571in your code.
wdenk2729af92004-05-03 20:45:30 +00004572
4573Please also stick to the following formatting rules:
4574- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004575- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004576- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004577- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004578- do not add trailing empty lines to source files
4579
4580Submissions which do not conform to the standards may be returned
4581with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004582
4583
wdenk2729af92004-05-03 20:45:30 +00004584Submitting Patches:
4585-------------------
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk2729af92004-05-03 20:45:30 +00004587Since the number of patches for U-Boot is growing, we need to
4588establish some rules. Submissions which do not conform to these rules
4589may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004590
Magnus Lilja0d28f342008-08-06 19:32:33 +02004591Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004592
Wolfgang Denk06682362008-12-30 22:56:11 +01004593Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4594see http://lists.denx.de/mailman/listinfo/u-boot
4595
wdenk2729af92004-05-03 20:45:30 +00004596When you send a patch, please include the following information with
4597it:
wdenkc6097192002-11-03 00:24:07 +00004598
wdenk2729af92004-05-03 20:45:30 +00004599* For bug fixes: a description of the bug and how your patch fixes
4600 this bug. Please try to include a way of demonstrating that the
4601 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004602
wdenk2729af92004-05-03 20:45:30 +00004603* For new features: a description of the feature and your
4604 implementation.
wdenkc6097192002-11-03 00:24:07 +00004605
wdenk2729af92004-05-03 20:45:30 +00004606* A CHANGELOG entry as plaintext (separate from the patch)
4607
4608* For major contributions, your entry to the CREDITS file
4609
4610* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004611 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004612
4613* If your patch adds new configuration options, don't forget to
4614 document these in the README file.
4615
Wolfgang Denk218ca722008-03-26 10:40:12 +01004616* The patch itself. If you are using git (which is *strongly*
4617 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004618 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004619 the U-Boot mailing list, you will avoid most of the common problems
4620 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004621
Wolfgang Denk218ca722008-03-26 10:40:12 +01004622 If you cannot use git, use "diff -purN OLD NEW". If your version of
4623 diff does not support these options, then get the latest version of
4624 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004625
Wolfgang Denk218ca722008-03-26 10:40:12 +01004626 The current directory when running this command shall be the parent
4627 directory of the U-Boot source tree (i. e. please make sure that
4628 your patch includes sufficient directory information for the
4629 affected files).
4630
4631 We prefer patches as plain text. MIME attachments are discouraged,
4632 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004633
4634* If one logical set of modifications affects or creates several
4635 files, all these changes shall be submitted in a SINGLE patch file.
4636
4637* Changesets that contain different, unrelated modifications shall be
4638 submitted as SEPARATE patches, one patch per changeset.
4639
4640
4641Notes:
4642
4643* Before sending the patch, run the MAKEALL script on your patched
4644 source tree and make sure that no errors or warnings are reported
4645 for any of the boards.
4646
4647* Keep your modifications to the necessary minimum: A patch
4648 containing several unrelated changes or arbitrary reformats will be
4649 returned with a request to re-formatting / split it.
4650
4651* If you modify existing code, make sure that your new code does not
4652 add to the memory footprint of the code ;-) Small is beautiful!
4653 When adding new features, these should compile conditionally only
4654 (using #ifdef), and the resulting code with the new feature
4655 disabled must not need more memory than the old code without your
4656 modification.
wdenk90dc6702005-05-03 14:12:25 +00004657
Wolfgang Denk06682362008-12-30 22:56:11 +01004658* Remember that there is a size limit of 100 kB per message on the
4659 u-boot mailing list. Bigger patches will be moderated. If they are
4660 reasonable and not too big, they will be acknowledged. But patches
4661 bigger than the size limit should be avoided.