blob: e0a4d53ed9250f03e34f52b9360140c76bc85c73 [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
630 bytes are output before the console is initialised, the
631 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
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500786 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500787 CONFIG_CMD_CDP * Cisco Discover Protocol support
788 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000789
wdenkc6097192002-11-03 00:24:07 +0000790
791 EXAMPLE: If you want all functions except of network
792 support you can write:
793
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500794 #include "config_cmd_all.h"
795 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000796
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400797 Other Commands:
798 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000799
800 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500801 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000802 what you (and your U-Boot users) are doing. Data
803 cache cannot be enabled on systems like the 8xx or
804 8260 (where accesses to the IMMR region must be
805 uncached), and it cannot be disabled on all other
806 systems where we (mis-) use the data cache to hold an
807 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000808
809
810 XXX - this list needs to get updated!
811
812- Watchdog:
813 CONFIG_WATCHDOG
814 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000815 support for the SoC. There must be support in the SoC
816 specific code for a watchdog. For the 8xx and 8260
817 CPUs, the SIU Watchdog feature is enabled in the SYPCR
818 register. When supported for a specific SoC is
819 available, then no further board specific code should
820 be needed to use it.
821
822 CONFIG_HW_WATCHDOG
823 When using a watchdog circuitry external to the used
824 SoC, then define this variable and provide board
825 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000826
stroesec1551ea2003-04-04 15:53:41 +0000827- U-Boot Version:
828 CONFIG_VERSION_VARIABLE
829 If this variable is defined, an environment variable
830 named "ver" is created by U-Boot showing the U-Boot
831 version as printed by the "version" command.
832 This variable is readonly.
833
wdenkc6097192002-11-03 00:24:07 +0000834- Real-Time Clock:
835
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500836 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000837 has to be selected, too. Define exactly one of the
838 following options:
839
840 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
841 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200842 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000843 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000844 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000845 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000846 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000847 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100848 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000849 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200850 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200851 CONFIG_SYS_RV3029_TCR - enable trickle charger on
852 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000853
wdenkb37c7e52003-06-30 16:24:52 +0000854 Note that if the RTC uses I2C, then the I2C interface
855 must also be configured. See I2C Support, below.
856
Peter Tysere92739d2008-12-17 16:36:21 -0600857- GPIO Support:
858 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
859 CONFIG_PCA953X_INFO - enable pca953x info command
860
Chris Packham5dec49c2010-12-19 10:12:13 +0000861 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
862 chip-ngpio pairs that tell the PCA953X driver the number of
863 pins supported by a particular chip.
864
Peter Tysere92739d2008-12-17 16:36:21 -0600865 Note that if the GPIO device uses I2C, then the I2C interface
866 must also be configured. See I2C Support, below.
867
wdenkc6097192002-11-03 00:24:07 +0000868- Timestamp Support:
869
wdenk43d96162003-03-06 00:02:04 +0000870 When CONFIG_TIMESTAMP is selected, the timestamp
871 (date and time) of an image is printed by image
872 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500873 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000874
875- Partition Support:
876 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400877 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000878
Wolfgang Denk218ca722008-03-26 10:40:12 +0100879 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
880 CONFIG_CMD_SCSI) you must configure support for at
881 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000882
883- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000884 CONFIG_IDE_RESET_ROUTINE - this is defined in several
885 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000886
wdenk4d13cba2004-03-14 14:09:05 +0000887 CONFIG_IDE_RESET - is this is defined, IDE Reset will
888 be performed by calling the function
889 ide_set_reset(int reset)
890 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000891
892- ATAPI Support:
893 CONFIG_ATAPI
894
895 Set this to enable ATAPI support.
896
wdenkc40b2952004-03-13 23:29:43 +0000897- LBA48 Support
898 CONFIG_LBA48
899
900 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100901 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000902 Whithout these , LBA48 support uses 32bit variables and will 'only'
903 support disks up to 2.1TB.
904
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200905 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000906 When enabled, makes the IDE subsystem use 64bit sector addresses.
907 Default is 32bit.
908
wdenkc6097192002-11-03 00:24:07 +0000909- SCSI Support:
910 At the moment only there is only support for the
911 SYM53C8XX SCSI controller; define
912 CONFIG_SCSI_SYM53C8XX to enable it.
913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200914 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
915 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
916 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000917 maximum numbers of LUNs, SCSI ID's and target
918 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200919 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000920
921- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000922 CONFIG_E1000
923 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000924
Andre Schwarzac3315c2008-03-06 16:45:44 +0100925 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200926 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100927
wdenkc6097192002-11-03 00:24:07 +0000928 CONFIG_EEPRO100
929 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200930 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000931 write routine for first time initialisation.
932
933 CONFIG_TULIP
934 Support for Digital 2114x chips.
935 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
936 modem chip initialisation (KS8761/QS6611).
937
938 CONFIG_NATSEMI
939 Support for National dp83815 chips.
940
941 CONFIG_NS8382X
942 Support for National dp8382[01] gigabit chips.
943
wdenk45219c42003-05-12 21:50:16 +0000944- NETWORK Support (other):
945
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100946 CONFIG_DRIVER_AT91EMAC
947 Support for AT91RM9200 EMAC.
948
949 CONFIG_RMII
950 Define this to use reduced MII inteface
951
952 CONFIG_DRIVER_AT91EMAC_QUIET
953 If this defined, the driver is quiet.
954 The driver doen't show link status messages.
955
wdenk45219c42003-05-12 21:50:16 +0000956 CONFIG_DRIVER_LAN91C96
957 Support for SMSC's LAN91C96 chips.
958
959 CONFIG_LAN91C96_BASE
960 Define this to hold the physical address
961 of the LAN91C96's I/O space
962
963 CONFIG_LAN91C96_USE_32_BIT
964 Define this to enable 32 bit addressing
965
wdenkf39748a2004-06-09 13:37:52 +0000966 CONFIG_DRIVER_SMC91111
967 Support for SMSC's LAN91C111 chip
968
969 CONFIG_SMC91111_BASE
970 Define this to hold the physical address
971 of the device (I/O space)
972
973 CONFIG_SMC_USE_32_BIT
974 Define this if data bus is 32 bits
975
976 CONFIG_SMC_USE_IOFUNCS
977 Define this to use i/o functions instead of macros
978 (some hardware wont work with macros)
979
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800980 CONFIG_FTGMAC100
981 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
982
983 CONFIG_FTGMAC100_EGIGA
984 Define this to use GE link update with gigabit PHY.
985 Define this if FTGMAC100 is connected to gigabit PHY.
986 If your system has 10/100 PHY only, it might not occur
987 wrong behavior. Because PHY usually return timeout or
988 useless data when polling gigabit status and gigabit
989 control registers. This behavior won't affect the
990 correctnessof 10/100 link speed update.
991
Mike Rapoportc2fff332009-11-11 10:03:03 +0200992 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200993 Support for SMSC's LAN911x and LAN921x chips
994
Mike Rapoportc2fff332009-11-11 10:03:03 +0200995 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200996 Define this to hold the physical address
997 of the device (I/O space)
998
Mike Rapoportc2fff332009-11-11 10:03:03 +0200999 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001000 Define this if data bus is 32 bits
1001
Mike Rapoportc2fff332009-11-11 10:03:03 +02001002 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001003 Define this if data bus is 16 bits. If your processor
1004 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001005 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001006
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001007 CONFIG_SH_ETHER
1008 Support for Renesas on-chip Ethernet controller
1009
1010 CONFIG_SH_ETHER_USE_PORT
1011 Define the number of ports to be used
1012
1013 CONFIG_SH_ETHER_PHY_ADDR
1014 Define the ETH PHY's address
1015
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001016 CONFIG_SH_ETHER_CACHE_WRITEBACK
1017 If this option is set, the driver enables cache flush.
1018
wdenkc6097192002-11-03 00:24:07 +00001019- USB Support:
1020 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001021 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001022 CONFIG_USB_UHCI to enable it.
1023 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001024 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001025 storage devices.
1026 Note:
1027 Supported are USB Keyboards and USB Floppy drives
1028 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001029 MPC5200 USB requires additional defines:
1030 CONFIG_USB_CLOCK
1031 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001032 CONFIG_PSC3_USB
1033 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001034 CONFIG_USB_CONFIG
1035 for differential drivers: 0x00001000
1036 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001037 for differential drivers on PSC3: 0x00000100
1038 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001039 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001040 May be defined to allow interrupt polling
1041 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001042
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001043- USB Device:
1044 Define the below if you wish to use the USB console.
1045 Once firmware is rebuilt from a serial console issue the
1046 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001047 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001048 it has found a new device. The environment variable usbtty
1049 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001050 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001051 Common Device Class Abstract Control Model serial device.
1052 If you select usbtty = gserial you should be able to enumerate
1053 a Linux host by
1054 # modprobe usbserial vendor=0xVendorID product=0xProductID
1055 else if using cdc_acm, simply setting the environment
1056 variable usbtty to be cdc_acm should suffice. The following
1057 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001058
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001059 CONFIG_USB_DEVICE
1060 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001061
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001062 CONFIG_USB_TTY
1063 Define this to have a tty type of device available to
1064 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001066 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001067 Define this if you want stdin, stdout &/or stderr to
1068 be set to usbtty.
1069
1070 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001071 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001072 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001073 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001074
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001075 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001076 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001077 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001078
Wolfgang Denk386eda02006-06-14 18:14:56 +02001079 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001080 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001081 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001082 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1083 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1084 should pretend to be a Linux device to it's target host.
1085
1086 CONFIG_USBD_MANUFACTURER
1087 Define this string as the name of your company for
1088 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001089
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001090 CONFIG_USBD_PRODUCT_NAME
1091 Define this string as the name of your product
1092 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1093
1094 CONFIG_USBD_VENDORID
1095 Define this as your assigned Vendor ID from the USB
1096 Implementors Forum. This *must* be a genuine Vendor ID
1097 to avoid polluting the USB namespace.
1098 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001099
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001100 CONFIG_USBD_PRODUCTID
1101 Define this as the unique Product ID
1102 for your device
1103 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001104
1105
1106- MMC Support:
1107 The MMC controller on the Intel PXA is supported. To
1108 enable this define CONFIG_MMC. The MMC can be
1109 accessed from the boot prompt by mapping the device
1110 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001111 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1112 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001113
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001114 CONFIG_SH_MMCIF
1115 Support for Renesas on-chip MMCIF controller
1116
1117 CONFIG_SH_MMCIF_ADDR
1118 Define the base address of MMCIF registers
1119
1120 CONFIG_SH_MMCIF_CLK
1121 Define the clock frequency for MMCIF
1122
wdenk6705d812004-08-02 23:22:59 +00001123- Journaling Flash filesystem support:
1124 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1125 CONFIG_JFFS2_NAND_DEV
1126 Define these for a default partition on a NAND device
1127
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001128 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1129 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001130 Define these for a default partition on a NOR device
1131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001132 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001133 Define this to create an own partition. You have to provide a
1134 function struct part_info* jffs2_part_info(int part_num)
1135
1136 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001137 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001138 to disable the command chpart. This is the default when you
1139 have not defined a custom partition
1140
wdenkc6097192002-11-03 00:24:07 +00001141- Keyboard Support:
1142 CONFIG_ISA_KEYBOARD
1143
1144 Define this to enable standard (PC-Style) keyboard
1145 support
1146
1147 CONFIG_I8042_KBD
1148 Standard PC keyboard driver with US (is default) and
1149 GERMAN key layout (switch via environment 'keymap=de') support.
1150 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1151 for cfb_console. Supports cursor blinking.
1152
1153- Video support:
1154 CONFIG_VIDEO
1155
1156 Define this to enable video support (for output to
1157 video).
1158
1159 CONFIG_VIDEO_CT69000
1160
1161 Enable Chips & Technologies 69000 Video chip
1162
1163 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001164 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001165 video output is selected via environment 'videoout'
1166 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1167 assumed.
wdenkc6097192002-11-03 00:24:07 +00001168
wdenkb79a11c2004-03-25 15:14:43 +00001169 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001170 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001171 are possible:
1172 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001173 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001174
1175 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1176 -------------+---------------------------------------------
1177 8 bits | 0x301* 0x303 0x305 0x161 0x307
1178 15 bits | 0x310 0x313 0x316 0x162 0x319
1179 16 bits | 0x311 0x314 0x317 0x163 0x31A
1180 24 bits | 0x312 0x315 0x318 ? 0x31B
1181 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001182 (i.e. setenv videomode 317; saveenv; reset;)
1183
wdenkb79a11c2004-03-25 15:14:43 +00001184 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001185 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001186
1187
stroesec1551ea2003-04-04 15:53:41 +00001188 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001189 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001190 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1191 or CONFIG_VIDEO_SED13806_16BPP
1192
Timur Tabi7d3053f2011-02-15 17:09:19 -06001193 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001194 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001195 SOCs that have a DIU should define this macro to enable DIU
1196 support, and should also define these other macros:
1197
1198 CONFIG_SYS_DIU_ADDR
1199 CONFIG_VIDEO
1200 CONFIG_CMD_BMP
1201 CONFIG_CFB_CONSOLE
1202 CONFIG_VIDEO_SW_CURSOR
1203 CONFIG_VGA_AS_SINGLE_DEVICE
1204 CONFIG_VIDEO_LOGO
1205 CONFIG_VIDEO_BMP_LOGO
1206
Timur Tabiba8e76b2011-04-11 14:18:22 -05001207 The DIU driver will look for the 'video-mode' environment
1208 variable, and if defined, enable the DIU as a console during
1209 boot. See the documentation file README.video for a
1210 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001211
wdenk682011f2003-06-03 23:54:09 +00001212- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001213 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001214
wdenk8bde7f72003-06-27 21:31:46 +00001215 Define this to enable a custom keyboard support.
1216 This simply calls drv_keyboard_init() which must be
1217 defined in your board-specific files.
1218 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001219
wdenkc6097192002-11-03 00:24:07 +00001220- LCD Support: CONFIG_LCD
1221
1222 Define this to enable LCD support (for output to LCD
1223 display); also select one of the supported displays
1224 by defining one of these:
1225
Stelian Pop39cf4802008-05-09 21:57:18 +02001226 CONFIG_ATMEL_LCD:
1227
1228 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1229
wdenkfd3103b2003-11-25 16:55:19 +00001230 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001231
wdenkfd3103b2003-11-25 16:55:19 +00001232 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001233
wdenkfd3103b2003-11-25 16:55:19 +00001234 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001235
wdenkfd3103b2003-11-25 16:55:19 +00001236 NEC NL6448BC20-08. 6.5", 640x480.
1237 Active, color, single scan.
1238
1239 CONFIG_NEC_NL6448BC33_54
1240
1241 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001242 Active, color, single scan.
1243
1244 CONFIG_SHARP_16x9
1245
1246 Sharp 320x240. Active, color, single scan.
1247 It isn't 16x9, and I am not sure what it is.
1248
1249 CONFIG_SHARP_LQ64D341
1250
1251 Sharp LQ64D341 display, 640x480.
1252 Active, color, single scan.
1253
1254 CONFIG_HLD1045
1255
1256 HLD1045 display, 640x480.
1257 Active, color, single scan.
1258
1259 CONFIG_OPTREX_BW
1260
1261 Optrex CBL50840-2 NF-FW 99 22 M5
1262 or
1263 Hitachi LMG6912RPFC-00T
1264 or
1265 Hitachi SP14Q002
1266
1267 320x240. Black & white.
1268
1269 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001270 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001271
wdenk7152b1d2003-09-05 23:19:14 +00001272- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001273
wdenk8bde7f72003-06-27 21:31:46 +00001274 If this option is set, the environment is checked for
1275 a variable "splashimage". If found, the usual display
1276 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001277 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001278 specified in "splashimage" is loaded instead. The
1279 console is redirected to the "nulldev", too. This
1280 allows for a "silent" boot where a splash screen is
1281 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001282
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001283 CONFIG_SPLASH_SCREEN_ALIGN
1284
1285 If this option is set the splash image can be freely positioned
1286 on the screen. Environment variable "splashpos" specifies the
1287 position as "x,y". If a positive number is given it is used as
1288 number of pixel from left/top. If a negative number is given it
1289 is used as number of pixel from right/bottom. You can also
1290 specify 'm' for centering the image.
1291
1292 Example:
1293 setenv splashpos m,m
1294 => image at center of screen
1295
1296 setenv splashpos 30,20
1297 => image at x = 30 and y = 20
1298
1299 setenv splashpos -10,m
1300 => vertically centered image
1301 at x = dspWidth - bmpWidth - 9
1302
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001303- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1304
1305 If this option is set, additionally to standard BMP
1306 images, gzipped BMP images can be displayed via the
1307 splashscreen support or the bmp command.
1308
Anatolij Gustschind5011762010-03-15 14:50:25 +01001309- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1310
1311 If this option is set, 8-bit RLE compressed BMP images
1312 can be displayed via the splashscreen support or the
1313 bmp command.
1314
wdenkc29fdfc2003-08-29 20:57:53 +00001315- Compression support:
1316 CONFIG_BZIP2
1317
1318 If this option is set, support for bzip2 compressed
1319 images is included. If not, only uncompressed and gzip
1320 compressed images are supported.
1321
wdenk42d1f032003-10-15 23:53:47 +00001322 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001323 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001324 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001325
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001326 CONFIG_LZMA
1327
1328 If this option is set, support for lzma compressed
1329 images is included.
1330
1331 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1332 requires an amount of dynamic memory that is given by the
1333 formula:
1334
1335 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1336
1337 Where lc and lp stand for, respectively, Literal context bits
1338 and Literal pos bits.
1339
1340 This value is upper-bounded by 14MB in the worst case. Anyway,
1341 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1342 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1343 a very small buffer.
1344
1345 Use the lzmainfo tool to determinate the lc and lp values and
1346 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001347 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001348
wdenk17ea1172004-06-06 21:51:03 +00001349- MII/PHY support:
1350 CONFIG_PHY_ADDR
1351
1352 The address of PHY on MII bus.
1353
1354 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1355
1356 The clock frequency of the MII bus
1357
1358 CONFIG_PHY_GIGE
1359
1360 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001361 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001362
1363 CONFIG_PHY_RESET_DELAY
1364
1365 Some PHY like Intel LXT971A need extra delay after
1366 reset before any MII register access is possible.
1367 For such PHY, set this option to the usec delay
1368 required. (minimum 300usec for LXT971A)
1369
1370 CONFIG_PHY_CMD_DELAY (ppc4xx)
1371
1372 Some PHY like Intel LXT971A need extra delay after
1373 command issued before MII status register can be read
1374
wdenkc6097192002-11-03 00:24:07 +00001375- Ethernet address:
1376 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001377 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001378 CONFIG_ETH2ADDR
1379 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001380 CONFIG_ETH4ADDR
1381 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001382
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001383 Define a default value for Ethernet address to use
1384 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001385 is not determined automatically.
1386
1387- IP address:
1388 CONFIG_IPADDR
1389
1390 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001391 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001392 determined through e.g. bootp.
1393
1394- Server IP address:
1395 CONFIG_SERVERIP
1396
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001397 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001398 server to contact when using the "tftboot" command.
1399
Robin Getz97cfe862009-07-21 12:15:28 -04001400 CONFIG_KEEP_SERVERADDR
1401
1402 Keeps the server's MAC address, in the env 'serveraddr'
1403 for passing to bootargs (like Linux's netconsole option)
1404
David Updegraff53a5c422007-06-11 10:41:07 -05001405- Multicast TFTP Mode:
1406 CONFIG_MCAST_TFTP
1407
1408 Defines whether you want to support multicast TFTP as per
1409 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001410 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001411 driver in use must provide a function: mcast() to join/leave a
1412 multicast group.
1413
wdenkc6097192002-11-03 00:24:07 +00001414- BOOTP Recovery Mode:
1415 CONFIG_BOOTP_RANDOM_DELAY
1416
1417 If you have many targets in a network that try to
1418 boot using BOOTP, you may want to avoid that all
1419 systems send out BOOTP requests at precisely the same
1420 moment (which would happen for instance at recovery
1421 from a power failure, when all systems will try to
1422 boot, thus flooding the BOOTP server. Defining
1423 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1424 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001425 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001426
1427 1st BOOTP request: delay 0 ... 1 sec
1428 2nd BOOTP request: delay 0 ... 2 sec
1429 3rd BOOTP request: delay 0 ... 4 sec
1430 4th and following
1431 BOOTP requests: delay 0 ... 8 sec
1432
stroesefe389a82003-08-28 14:17:32 +00001433- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001434 You can fine tune the DHCP functionality by defining
1435 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001436
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001437 CONFIG_BOOTP_SUBNETMASK
1438 CONFIG_BOOTP_GATEWAY
1439 CONFIG_BOOTP_HOSTNAME
1440 CONFIG_BOOTP_NISDOMAIN
1441 CONFIG_BOOTP_BOOTPATH
1442 CONFIG_BOOTP_BOOTFILESIZE
1443 CONFIG_BOOTP_DNS
1444 CONFIG_BOOTP_DNS2
1445 CONFIG_BOOTP_SEND_HOSTNAME
1446 CONFIG_BOOTP_NTPSERVER
1447 CONFIG_BOOTP_TIMEOFFSET
1448 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001449
Wilson Callan5d110f02007-07-28 10:56:13 -04001450 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1451 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001452
1453 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1454 serverip from a DHCP server, it is possible that more
1455 than one DNS serverip is offered to the client.
1456 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1457 serverip will be stored in the additional environment
1458 variable "dnsip2". The first DNS serverip is always
1459 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001460 is defined.
stroesefe389a82003-08-28 14:17:32 +00001461
1462 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1463 to do a dynamic update of a DNS server. To do this, they
1464 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001465 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001466 of the "hostname" environment variable is passed as
1467 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001468
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001469 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1470
1471 A 32bit value in microseconds for a delay between
1472 receiving a "DHCP Offer" and sending the "DHCP Request".
1473 This fixes a problem with certain DHCP servers that don't
1474 respond 100% of the time to a "DHCP request". E.g. On an
1475 AT91RM9200 processor running at 180MHz, this delay needed
1476 to be *at least* 15,000 usec before a Windows Server 2003
1477 DHCP server would reply 100% of the time. I recommend at
1478 least 50,000 usec to be safe. The alternative is to hope
1479 that one of the retries will be successful but note that
1480 the DHCP timeout and retry process takes a longer than
1481 this delay.
1482
wdenka3d991b2004-04-15 21:48:45 +00001483 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001484 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001485
1486 The device id used in CDP trigger frames.
1487
1488 CONFIG_CDP_DEVICE_ID_PREFIX
1489
1490 A two character string which is prefixed to the MAC address
1491 of the device.
1492
1493 CONFIG_CDP_PORT_ID
1494
1495 A printf format string which contains the ascii name of
1496 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001497 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001498
1499 CONFIG_CDP_CAPABILITIES
1500
1501 A 32bit integer which indicates the device capabilities;
1502 0x00000010 for a normal host which does not forwards.
1503
1504 CONFIG_CDP_VERSION
1505
1506 An ascii string containing the version of the software.
1507
1508 CONFIG_CDP_PLATFORM
1509
1510 An ascii string containing the name of the platform.
1511
1512 CONFIG_CDP_TRIGGER
1513
1514 A 32bit integer sent on the trigger.
1515
1516 CONFIG_CDP_POWER_CONSUMPTION
1517
1518 A 16bit integer containing the power consumption of the
1519 device in .1 of milliwatts.
1520
1521 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1522
1523 A byte containing the id of the VLAN.
1524
wdenkc6097192002-11-03 00:24:07 +00001525- Status LED: CONFIG_STATUS_LED
1526
1527 Several configurations allow to display the current
1528 status using a LED. For instance, the LED will blink
1529 fast while running U-Boot code, stop blinking as
1530 soon as a reply to a BOOTP request was received, and
1531 start blinking slow once the Linux kernel is running
1532 (supported by a status LED driver in the Linux
1533 kernel). Defining CONFIG_STATUS_LED enables this
1534 feature in U-Boot.
1535
1536- CAN Support: CONFIG_CAN_DRIVER
1537
1538 Defining CONFIG_CAN_DRIVER enables CAN driver support
1539 on those systems that support this (optional)
1540 feature, like the TQM8xxL modules.
1541
1542- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1543
wdenkb37c7e52003-06-30 16:24:52 +00001544 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001545 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001546 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001547
wdenk945af8d2003-07-16 21:53:01 +00001548 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001549 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001550 CONFIG_COMMANDS) and communicate with i2c based realtime
1551 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001552 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001553
Ben Warrenbb99ad62006-09-07 16:50:54 -04001554 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001555
wdenk945af8d2003-07-16 21:53:01 +00001556 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001557 bit-banging) driver instead of CPM or similar hardware
1558 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001559
wdenk945af8d2003-07-16 21:53:01 +00001560 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001561 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001562
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001563 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001564 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001565 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001566 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001567
Peter Tyser8d321b82010-04-12 22:28:21 -05001568 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001569 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001570 and so its address should therefore be cleared to 0 (See,
1571 eg, MPC823e User's Manual p.16-473). So, set
1572 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001573
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001574 CONFIG_SYS_I2C_INIT_MPC5XXX
1575
1576 When a board is reset during an i2c bus transfer
1577 chips might think that the current transfer is still
1578 in progress. Reset the slave devices by sending start
1579 commands until the slave device responds.
1580
wdenk945af8d2003-07-16 21:53:01 +00001581 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001582
1583 If you use the software i2c interface (CONFIG_SOFT_I2C)
1584 then the following macros need to be defined (examples are
1585 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001586
1587 I2C_INIT
1588
wdenkb37c7e52003-06-30 16:24:52 +00001589 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001590 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001591
wdenkba56f622004-02-06 23:19:44 +00001592 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001593
wdenkc6097192002-11-03 00:24:07 +00001594 I2C_PORT
1595
wdenk43d96162003-03-06 00:02:04 +00001596 (Only for MPC8260 CPU). The I/O port to use (the code
1597 assumes both bits are on the same port). Valid values
1598 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001599
1600 I2C_ACTIVE
1601
1602 The code necessary to make the I2C data line active
1603 (driven). If the data line is open collector, this
1604 define can be null.
1605
wdenkb37c7e52003-06-30 16:24:52 +00001606 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1607
wdenkc6097192002-11-03 00:24:07 +00001608 I2C_TRISTATE
1609
1610 The code necessary to make the I2C data line tri-stated
1611 (inactive). If the data line is open collector, this
1612 define can be null.
1613
wdenkb37c7e52003-06-30 16:24:52 +00001614 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1615
wdenkc6097192002-11-03 00:24:07 +00001616 I2C_READ
1617
1618 Code that returns TRUE if the I2C data line is high,
1619 FALSE if it is low.
1620
wdenkb37c7e52003-06-30 16:24:52 +00001621 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1622
wdenkc6097192002-11-03 00:24:07 +00001623 I2C_SDA(bit)
1624
1625 If <bit> is TRUE, sets the I2C data line high. If it
1626 is FALSE, it clears it (low).
1627
wdenkb37c7e52003-06-30 16:24:52 +00001628 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001629 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001630 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001631
wdenkc6097192002-11-03 00:24:07 +00001632 I2C_SCL(bit)
1633
1634 If <bit> is TRUE, sets the I2C clock line high. If it
1635 is FALSE, it clears it (low).
1636
wdenkb37c7e52003-06-30 16:24:52 +00001637 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001638 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001639 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001640
wdenkc6097192002-11-03 00:24:07 +00001641 I2C_DELAY
1642
1643 This delay is invoked four times per clock cycle so this
1644 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001645 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001646 like:
1647
wdenkb37c7e52003-06-30 16:24:52 +00001648 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001649
Mike Frysinger793b5722010-07-21 13:38:02 -04001650 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1651
1652 If your arch supports the generic GPIO framework (asm/gpio.h),
1653 then you may alternatively define the two GPIOs that are to be
1654 used as SCL / SDA. Any of the previous I2C_xxx macros will
1655 have GPIO-based defaults assigned to them as appropriate.
1656
1657 You should define these to the GPIO value as given directly to
1658 the generic GPIO functions.
1659
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001660 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001661
wdenk8bde7f72003-06-27 21:31:46 +00001662 When a board is reset during an i2c bus transfer
1663 chips might think that the current transfer is still
1664 in progress. On some boards it is possible to access
1665 the i2c SCLK line directly, either by using the
1666 processor pin as a GPIO or by having a second pin
1667 connected to the bus. If this option is defined a
1668 custom i2c_init_board() routine in boards/xxx/board.c
1669 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001670
Richard Retanubun26a33502010-04-12 15:08:17 -04001671 CONFIG_SYS_I2C_BOARD_LATE_INIT
1672
1673 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1674 defined a custom i2c_board_late_init() routine in
1675 boards/xxx/board.c is run AFTER the operations in i2c_init()
1676 is completed. This callpoint can be used to unreset i2c bus
1677 using CPU i2c controller register accesses for CPUs whose i2c
1678 controller provide such a method. It is called at the end of
1679 i2c_init() to allow i2c_init operations to setup the i2c bus
1680 controller on the CPU (e.g. setting bus speed & slave address).
1681
wdenk17ea1172004-06-06 21:51:03 +00001682 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1683
1684 This option enables configuration of bi_iic_fast[] flags
1685 in u-boot bd_info structure based on u-boot environment
1686 variable "i2cfast". (see also i2cfast)
1687
Ben Warrenbb99ad62006-09-07 16:50:54 -04001688 CONFIG_I2C_MULTI_BUS
1689
1690 This option allows the use of multiple I2C buses, each of which
1691 must have a controller. At any point in time, only one bus is
1692 active. To switch to a different bus, use the 'i2c dev' command.
1693 Note that bus numbering is zero-based.
1694
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001695 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001696
1697 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001698 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1699 is set, specify a list of bus-device pairs. Otherwise, specify
1700 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001701
1702 e.g.
1703 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001704 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001705
1706 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1707
1708 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001709 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001710
1711 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001713 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001714
1715 If defined, then this indicates the I2C bus number for DDR SPD.
1716 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001718 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001719
1720 If defined, then this indicates the I2C bus number for the RTC.
1721 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1722
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001723 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001724
1725 If defined, then this indicates the I2C bus number for the DTT.
1726 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001728 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001729
1730 If defined, specifies the I2C address of the DTT device.
1731 If not defined, then U-Boot uses predefined value for
1732 specified DTT device.
1733
Timur Tabibe5e6182006-11-03 19:15:00 -06001734 CONFIG_FSL_I2C
1735
1736 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001737 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001738
Heiko Schocher67b23a32008-10-15 09:39:47 +02001739 CONFIG_I2C_MUX
1740
1741 Define this option if you have I2C devices reached over 1 .. n
1742 I2C Muxes like the pca9544a. This option addes a new I2C
1743 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1744 new I2C Bus to the existing I2C Busses. If you select the
1745 new Bus with "i2c dev", u-bbot sends first the commandos for
1746 the muxes to activate this new "bus".
1747
1748 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1749 feature!
1750
1751 Example:
1752 Adding a new I2C Bus reached over 2 pca9544a muxes
1753 The First mux with address 70 and channel 6
1754 The Second mux with address 71 and channel 4
1755
1756 => i2c bus pca9544a:70:6:pca9544a:71:4
1757
1758 Use the "i2c bus" command without parameter, to get a list
1759 of I2C Busses with muxes:
1760
1761 => i2c bus
1762 Busses reached over muxes:
1763 Bus ID: 2
1764 reached over Mux(es):
1765 pca9544a@70 ch: 4
1766 Bus ID: 3
1767 reached over Mux(es):
1768 pca9544a@70 ch: 6
1769 pca9544a@71 ch: 4
1770 =>
1771
1772 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001773 u-boot first sends the command to the mux@70 to enable
1774 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001775 the channel 4.
1776
1777 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001778 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001779 the 2 muxes.
1780
1781 This option is actually implemented for the bitbanging
1782 algorithm in common/soft_i2c.c and for the Hardware I2C
1783 Bus on the MPC8260. But it should be not so difficult
1784 to add this option to other architectures.
1785
Andrew Dyer2ac69852008-12-29 17:36:01 -06001786 CONFIG_SOFT_I2C_READ_REPEATED_START
1787
1788 defining this will force the i2c_read() function in
1789 the soft_i2c driver to perform an I2C repeated start
1790 between writing the address pointer and reading the
1791 data. If this define is omitted the default behaviour
1792 of doing a stop-start sequence will be used. Most I2C
1793 devices can use either method, but some require one or
1794 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001795
wdenkc6097192002-11-03 00:24:07 +00001796- SPI Support: CONFIG_SPI
1797
1798 Enables SPI driver (so far only tested with
1799 SPI EEPROM, also an instance works with Crystal A/D and
1800 D/As on the SACSng board)
1801
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001802 CONFIG_SH_SPI
1803
1804 Enables the driver for SPI controller on SuperH. Currently
1805 only SH7757 is supported.
1806
wdenkc6097192002-11-03 00:24:07 +00001807 CONFIG_SPI_X
1808
1809 Enables extended (16-bit) SPI EEPROM addressing.
1810 (symmetrical to CONFIG_I2C_X)
1811
1812 CONFIG_SOFT_SPI
1813
wdenk43d96162003-03-06 00:02:04 +00001814 Enables a software (bit-bang) SPI driver rather than
1815 using hardware support. This is a general purpose
1816 driver that only requires three general I/O port pins
1817 (two outputs, one input) to function. If this is
1818 defined, the board configuration must define several
1819 SPI configuration items (port pins to use, etc). For
1820 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001821
Ben Warren04a9e112008-01-16 22:37:35 -05001822 CONFIG_HARD_SPI
1823
1824 Enables a hardware SPI driver for general-purpose reads
1825 and writes. As with CONFIG_SOFT_SPI, the board configuration
1826 must define a list of chip-select function pointers.
1827 Currently supported on some MPC8xxx processors. For an
1828 example, see include/configs/mpc8349emds.h.
1829
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001830 CONFIG_MXC_SPI
1831
1832 Enables the driver for the SPI controllers on i.MX and MXC
1833 SoCs. Currently only i.MX31 is supported.
1834
Matthias Fuchs01335022007-12-27 17:12:34 +01001835- FPGA Support: CONFIG_FPGA
1836
1837 Enables FPGA subsystem.
1838
1839 CONFIG_FPGA_<vendor>
1840
1841 Enables support for specific chip vendors.
1842 (ALTERA, XILINX)
1843
1844 CONFIG_FPGA_<family>
1845
1846 Enables support for FPGA family.
1847 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1848
1849 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001850
wdenk43d96162003-03-06 00:02:04 +00001851 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001852
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001853 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001854
wdenk8bde7f72003-06-27 21:31:46 +00001855 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001857 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001858
wdenk43d96162003-03-06 00:02:04 +00001859 Enable checks on FPGA configuration interface busy
1860 status by the configuration function. This option
1861 will require a board or device specific function to
1862 be written.
wdenkc6097192002-11-03 00:24:07 +00001863
1864 CONFIG_FPGA_DELAY
1865
1866 If defined, a function that provides delays in the FPGA
1867 configuration driver.
1868
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001869 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001870 Allow Control-C to interrupt FPGA configuration
1871
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001872 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001873
wdenk43d96162003-03-06 00:02:04 +00001874 Check for configuration errors during FPGA bitfile
1875 loading. For example, abort during Virtex II
1876 configuration if the INIT_B line goes low (which
1877 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001878
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001879 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001880
wdenk43d96162003-03-06 00:02:04 +00001881 Maximum time to wait for the INIT_B line to deassert
1882 after PROB_B has been deasserted during a Virtex II
1883 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001884 ms.
wdenkc6097192002-11-03 00:24:07 +00001885
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001886 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001887
wdenk43d96162003-03-06 00:02:04 +00001888 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001889 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001890
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001891 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001892
wdenk43d96162003-03-06 00:02:04 +00001893 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001894 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001895
1896- Configuration Management:
1897 CONFIG_IDENT_STRING
1898
wdenk43d96162003-03-06 00:02:04 +00001899 If defined, this string will be added to the U-Boot
1900 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001901
1902- Vendor Parameter Protection:
1903
wdenk43d96162003-03-06 00:02:04 +00001904 U-Boot considers the values of the environment
1905 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001906 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001907 are set once by the board vendor / manufacturer, and
1908 protects these variables from casual modification by
1909 the user. Once set, these variables are read-only,
1910 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001911 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001912
1913 If CONFIG_ENV_OVERWRITE is #defined in your config
1914 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001915 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001916 these parameters.
1917
1918 Alternatively, if you #define _both_ CONFIG_ETHADDR
1919 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001920 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001921 which can be changed exactly ONCE by the user. [The
1922 serial# is unaffected by this, i. e. it remains
1923 read-only.]
1924
1925- Protected RAM:
1926 CONFIG_PRAM
1927
1928 Define this variable to enable the reservation of
1929 "protected RAM", i. e. RAM which is not overwritten
1930 by U-Boot. Define CONFIG_PRAM to hold the number of
1931 kB you want to reserve for pRAM. You can overwrite
1932 this default value by defining an environment
1933 variable "pram" to the number of kB you want to
1934 reserve. Note that the board info structure will
1935 still show the full amount of RAM. If pRAM is
1936 reserved, a new environment variable "mem" will
1937 automatically be defined to hold the amount of
1938 remaining RAM in a form that can be passed as boot
1939 argument to Linux, for instance like that:
1940
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001941 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001942 saveenv
1943
1944 This way you can tell Linux not to use this memory,
1945 either, which results in a memory region that will
1946 not be affected by reboots.
1947
1948 *WARNING* If your board configuration uses automatic
1949 detection of the RAM size, you must make sure that
1950 this memory test is non-destructive. So far, the
1951 following board configurations are known to be
1952 "pRAM-clean":
1953
1954 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1955 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02001956 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00001957
1958- Error Recovery:
1959 CONFIG_PANIC_HANG
1960
1961 Define this variable to stop the system in case of a
1962 fatal error, so that you have to reset it manually.
1963 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001964 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001965 automatically as fast as possible, but it may be
1966 useful during development since you can try to debug
1967 the conditions that lead to the situation.
1968
1969 CONFIG_NET_RETRY_COUNT
1970
wdenk43d96162003-03-06 00:02:04 +00001971 This variable defines the number of retries for
1972 network operations like ARP, RARP, TFTP, or BOOTP
1973 before giving up the operation. If not defined, a
1974 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001975
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001976 CONFIG_ARP_TIMEOUT
1977
1978 Timeout waiting for an ARP reply in milliseconds.
1979
wdenkc6097192002-11-03 00:24:07 +00001980- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001981 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001982
1983 Enable auto completion of commands using TAB.
1984
Wolfgang Denka9398e02006-11-27 15:32:42 +01001985 Note that this feature has NOT been implemented yet
1986 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001987
1988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001989 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001990
1991 Define this variable to enable the "hush" shell (from
1992 Busybox) as command line interpreter, thus enabling
1993 powerful command line syntax like
1994 if...then...else...fi conditionals or `&&' and '||'
1995 constructs ("shell scripts").
1996
1997 If undefined, you get the old, much simpler behaviour
1998 with a somewhat smaller memory footprint.
1999
2000
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002001 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002002
2003 This defines the secondary prompt string, which is
2004 printed when the command interpreter needs more input
2005 to complete a command. Usually "> ".
2006
2007 Note:
2008
wdenk8bde7f72003-06-27 21:31:46 +00002009 In the current implementation, the local variables
2010 space and global environment variables space are
2011 separated. Local variables are those you define by
2012 simply typing `name=value'. To access a local
2013 variable later on, you have write `$name' or
2014 `${name}'; to execute the contents of a variable
2015 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002016
wdenk43d96162003-03-06 00:02:04 +00002017 Global environment variables are those you use
2018 setenv/printenv to work with. To run a command stored
2019 in such a variable, you need to use the run command,
2020 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002021
2022 To store commands and special characters in a
2023 variable, please use double quotation marks
2024 surrounding the whole text of the variable, instead
2025 of the backslashes before semicolons and special
2026 symbols.
2027
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002028- Commandline Editing and History:
2029 CONFIG_CMDLINE_EDITING
2030
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002031 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002032 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002033
wdenka8c7c702003-12-06 19:49:23 +00002034- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002035 CONFIG_EXTRA_ENV_SETTINGS
2036
wdenk43d96162003-03-06 00:02:04 +00002037 Define this to contain any number of null terminated
2038 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002039 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002040
wdenk43d96162003-03-06 00:02:04 +00002041 For example, place something like this in your
2042 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002043
2044 #define CONFIG_EXTRA_ENV_SETTINGS \
2045 "myvar1=value1\0" \
2046 "myvar2=value2\0"
2047
wdenk43d96162003-03-06 00:02:04 +00002048 Warning: This method is based on knowledge about the
2049 internal format how the environment is stored by the
2050 U-Boot code. This is NOT an official, exported
2051 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002052 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002053 You better know what you are doing here.
2054
wdenk43d96162003-03-06 00:02:04 +00002055 Note: overly (ab)use of the default environment is
2056 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002057 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002058 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002059
wdenka8c7c702003-12-06 19:49:23 +00002060- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002061 CONFIG_HAS_DATAFLASH
2062
wdenk8bde7f72003-06-27 21:31:46 +00002063 Defining this option enables DataFlash features and
2064 allows to read/write in Dataflash via the standard
2065 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002066
wdenk3f85ce22004-02-23 16:11:30 +00002067- SystemACE Support:
2068 CONFIG_SYSTEMACE
2069
2070 Adding this option adds support for Xilinx SystemACE
2071 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002072 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002073 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002074
2075 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002076 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002077
2078 When SystemACE support is added, the "ace" device type
2079 becomes available to the fat commands, i.e. fatls.
2080
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002081- TFTP Fixed UDP Port:
2082 CONFIG_TFTP_PORT
2083
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002084 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002085 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002086 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002087 number generator is used.
2088
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002089 Also, the environment variable tftpdstp is used to supply
2090 the TFTP UDP destination port value. If tftpdstp isn't
2091 defined, the normal port 69 is used.
2092
2093 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002094 blindly start the TFTP transfer using the pre-configured
2095 target IP address and UDP port. This has the effect of
2096 "punching through" the (Windows XP) firewall, allowing
2097 the remainder of the TFTP transfer to proceed normally.
2098 A better solution is to properly configure the firewall,
2099 but sometimes that is not allowed.
2100
wdenka8c7c702003-12-06 19:49:23 +00002101- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002102 CONFIG_SHOW_BOOT_PROGRESS
2103
wdenk43d96162003-03-06 00:02:04 +00002104 Defining this option allows to add some board-
2105 specific code (calling a user-provided function
2106 "show_boot_progress(int)") that enables you to show
2107 the system's boot progress on some display (for
2108 example, some LED's) on your board. At the moment,
2109 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002110
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002111Legacy uImage format:
2112
wdenkc6097192002-11-03 00:24:07 +00002113 Arg Where When
2114 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002115 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002116 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002117 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002118 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002119 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002120 4 common/cmd_bootm.c Image data has correct checksum
2121 -4 common/cmd_bootm.c Image is for unsupported architecture
2122 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002123 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002124 6 common/cmd_bootm.c Image Type check OK
2125 -6 common/cmd_bootm.c gunzip uncompression error
2126 -7 common/cmd_bootm.c Unimplemented compression type
2127 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002128 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002129 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002130
2131 9 common/image.c Start initial ramdisk verification
2132 -10 common/image.c Ramdisk header has bad magic number
2133 -11 common/image.c Ramdisk header has bad checksum
2134 10 common/image.c Ramdisk header is OK
2135 -12 common/image.c Ramdisk data has bad checksum
2136 11 common/image.c Ramdisk data has correct checksum
2137 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002138 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002139 13 common/image.c Start multifile image verification
2140 14 common/image.c No initial ramdisk, no multifile, continue.
2141
Peter Tyserea0364f2010-04-12 22:28:04 -05002142 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002143
Stefan Roesea47a12b2010-04-15 16:07:28 +02002144 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002145 -31 post/post.c POST test failed, detected by post_output_backlog()
2146 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002147
Heiko Schocher566a4942007-06-22 19:11:54 +02002148 34 common/cmd_doc.c before loading a Image from a DOC device
2149 -35 common/cmd_doc.c Bad usage of "doc" command
2150 35 common/cmd_doc.c correct usage of "doc" command
2151 -36 common/cmd_doc.c No boot device
2152 36 common/cmd_doc.c correct boot device
2153 -37 common/cmd_doc.c Unknown Chip ID on boot device
2154 37 common/cmd_doc.c correct chip ID found, device available
2155 -38 common/cmd_doc.c Read Error on boot device
2156 38 common/cmd_doc.c reading Image header from DOC device OK
2157 -39 common/cmd_doc.c Image header has bad magic number
2158 39 common/cmd_doc.c Image header has correct magic number
2159 -40 common/cmd_doc.c Error reading Image from DOC device
2160 40 common/cmd_doc.c Image header has correct magic number
2161 41 common/cmd_ide.c before loading a Image from a IDE device
2162 -42 common/cmd_ide.c Bad usage of "ide" command
2163 42 common/cmd_ide.c correct usage of "ide" command
2164 -43 common/cmd_ide.c No boot device
2165 43 common/cmd_ide.c boot device found
2166 -44 common/cmd_ide.c Device not available
2167 44 common/cmd_ide.c Device available
2168 -45 common/cmd_ide.c wrong partition selected
2169 45 common/cmd_ide.c partition selected
2170 -46 common/cmd_ide.c Unknown partition table
2171 46 common/cmd_ide.c valid partition table found
2172 -47 common/cmd_ide.c Invalid partition type
2173 47 common/cmd_ide.c correct partition type
2174 -48 common/cmd_ide.c Error reading Image Header on boot device
2175 48 common/cmd_ide.c reading Image Header from IDE device OK
2176 -49 common/cmd_ide.c Image header has bad magic number
2177 49 common/cmd_ide.c Image header has correct magic number
2178 -50 common/cmd_ide.c Image header has bad checksum
2179 50 common/cmd_ide.c Image header has correct checksum
2180 -51 common/cmd_ide.c Error reading Image from IDE device
2181 51 common/cmd_ide.c reading Image from IDE device OK
2182 52 common/cmd_nand.c before loading a Image from a NAND device
2183 -53 common/cmd_nand.c Bad usage of "nand" command
2184 53 common/cmd_nand.c correct usage of "nand" command
2185 -54 common/cmd_nand.c No boot device
2186 54 common/cmd_nand.c boot device found
2187 -55 common/cmd_nand.c Unknown Chip ID on boot device
2188 55 common/cmd_nand.c correct chip ID found, device available
2189 -56 common/cmd_nand.c Error reading Image Header on boot device
2190 56 common/cmd_nand.c reading Image Header from NAND device OK
2191 -57 common/cmd_nand.c Image header has bad magic number
2192 57 common/cmd_nand.c Image header has correct magic number
2193 -58 common/cmd_nand.c Error reading Image from NAND device
2194 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002195
Heiko Schocher566a4942007-06-22 19:11:54 +02002196 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002197
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002198 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002199 -64 net/eth.c no Ethernet found.
2200 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002201
Heiko Schocher566a4942007-06-22 19:11:54 +02002202 -80 common/cmd_net.c usage wrong
2203 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002204 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002205 81 common/cmd_net.c NetLoop() back without error
2206 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2207 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002208 83 common/cmd_net.c running "source" command
2209 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002210 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002211
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002212FIT uImage format:
2213
2214 Arg Where When
2215 100 common/cmd_bootm.c Kernel FIT Image has correct format
2216 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2217 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2218 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2219 102 common/cmd_bootm.c Kernel unit name specified
2220 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002221 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002222 104 common/cmd_bootm.c Got kernel subimage node offset
2223 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2224 105 common/cmd_bootm.c Kernel subimage hash verification OK
2225 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2226 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002227 -106 common/cmd_bootm.c Kernel subimage has wrong type
2228 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002229 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2230 108 common/cmd_bootm.c Got kernel subimage data/size
2231 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2232 -109 common/cmd_bootm.c Can't get kernel subimage type
2233 -110 common/cmd_bootm.c Can't get kernel subimage comp
2234 -111 common/cmd_bootm.c Can't get kernel subimage os
2235 -112 common/cmd_bootm.c Can't get kernel subimage load address
2236 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2237
2238 120 common/image.c Start initial ramdisk verification
2239 -120 common/image.c Ramdisk FIT image has incorrect format
2240 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002241 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002242 -122 common/image.c Can't get configuration for ramdisk subimage
2243 123 common/image.c Ramdisk unit name specified
2244 -124 common/image.c Can't get ramdisk subimage node offset
2245 125 common/image.c Got ramdisk subimage node offset
2246 -125 common/image.c Ramdisk subimage hash verification failed
2247 126 common/image.c Ramdisk subimage hash verification OK
2248 -126 common/image.c Ramdisk subimage for unsupported architecture
2249 127 common/image.c Architecture check OK
2250 -127 common/image.c Can't get ramdisk subimage data/size
2251 128 common/image.c Got ramdisk subimage data/size
2252 129 common/image.c Can't get ramdisk load address
2253 -129 common/image.c Got ramdisk load address
2254
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002255 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002256 131 common/cmd_doc.c FIT image format OK
2257
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002258 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002259 141 common/cmd_ide.c FIT image format OK
2260
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002261 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002262 151 common/cmd_nand.c FIT image format OK
2263
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002264- Standalone program support:
2265 CONFIG_STANDALONE_LOAD_ADDR
2266
2267 This option allows to define board specific values
2268 for the address where standalone program gets loaded,
2269 thus overwriting the architecutre dependent default
2270 settings.
2271
2272- Frame Buffer Address:
2273 CONFIG_FB_ADDR
2274
2275 Define CONFIG_FB_ADDR if you want to use specific
2276 address for frame buffer.
2277 Then system will reserve the frame buffer address to
2278 defined address instead of lcd_setmem (this function
2279 grab the memory for frame buffer by panel's size).
2280
2281 Please see board_init_f function.
2282
2283 If you want this config option then,
2284 please define it at your board config file
2285
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002286- Automatic software updates via TFTP server
2287 CONFIG_UPDATE_TFTP
2288 CONFIG_UPDATE_TFTP_CNT_MAX
2289 CONFIG_UPDATE_TFTP_MSEC_MAX
2290
2291 These options enable and control the auto-update feature;
2292 for a more detailed description refer to doc/README.update.
2293
2294- MTD Support (mtdparts command, UBI support)
2295 CONFIG_MTD_DEVICE
2296
2297 Adds the MTD device infrastructure from the Linux kernel.
2298 Needed for mtdparts command support.
2299
2300 CONFIG_MTD_PARTITIONS
2301
2302 Adds the MTD partitioning infrastructure from the Linux
2303 kernel. Needed for UBI support.
2304
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002305- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002306 CONFIG_SPL
2307 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002308
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002309 CONFIG_SPL_TEXT_BASE
2310 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002311
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002312 CONFIG_SPL_LDSCRIPT
2313 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002314
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002315 CONFIG_SPL_LIBCOMMON_SUPPORT
2316 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002317
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002318 CONFIG_SPL_LIBDISK_SUPPORT
2319 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002320
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002321 CONFIG_SPL_I2C_SUPPORT
2322 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002323
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002324 CONFIG_SPL_GPIO_SUPPORT
2325 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002326
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002327 CONFIG_SPL_MMC_SUPPORT
2328 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002329
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002330 CONFIG_SPL_SERIAL_SUPPORT
2331 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002332
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002333 CONFIG_SPL_SPI_FLASH_SUPPORT
2334 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002335
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002336 CONFIG_SPL_SPI_SUPPORT
2337 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002338
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002339 CONFIG_SPL_FAT_SUPPORT
2340 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002341
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002342 CONFIG_SPL_LIBGENERIC_SUPPORT
2343 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002344
wdenkc6097192002-11-03 00:24:07 +00002345Modem Support:
2346--------------
2347
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002348[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002349
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002350- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002351 CONFIG_MODEM_SUPPORT
2352
2353- RTS/CTS Flow control enable:
2354 CONFIG_HWFLOW
2355
2356- Modem debug support:
2357 CONFIG_MODEM_SUPPORT_DEBUG
2358
wdenk43d96162003-03-06 00:02:04 +00002359 Enables debugging stuff (char screen[1024], dbg())
2360 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002361
wdenka8c7c702003-12-06 19:49:23 +00002362- Interrupt support (PPC):
2363
wdenkd4ca31c2004-01-02 14:00:00 +00002364 There are common interrupt_init() and timer_interrupt()
2365 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002366 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002367 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002368 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002369 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002370 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002371 specific handling. If board has watchdog / status_led
2372 / other_activity_monitor it works automatically from
2373 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002374
wdenkc6097192002-11-03 00:24:07 +00002375- General:
2376
wdenk43d96162003-03-06 00:02:04 +00002377 In the target system modem support is enabled when a
2378 specific key (key combination) is pressed during
2379 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002380 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002381 board_init(). Currently key_pressed() is a dummy
2382 function, returning 1 and thus enabling modem
2383 initialization.
wdenkc6097192002-11-03 00:24:07 +00002384
wdenk43d96162003-03-06 00:02:04 +00002385 If there are no modem init strings in the
2386 environment, U-Boot proceed to autoboot; the
2387 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002388 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002389
2390 See also: doc/README.Modem
2391
2392
wdenkc6097192002-11-03 00:24:07 +00002393Configuration Settings:
2394-----------------------
2395
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002396- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002397 undefine this when you're short of memory.
2398
Peter Tyser2fb26042009-01-27 18:03:12 -06002399- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2400 width of the commands listed in the 'help' command output.
2401
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002402- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002403 prompt for user input.
2404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002405- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002406
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002407- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002409- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002410
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002411- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002412 the application (usually a Linux kernel) when it is
2413 booted
2414
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002415- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002416 List of legal baudrate settings for this board.
2417
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002418- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002419 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002420
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002421- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002422 If the board specific function
2423 extern int overwrite_console (void);
2424 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002425 serial port, else the settings in the environment are used.
2426
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002427- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002428 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002429
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002430- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002431 Enable overwrite of previous console environment settings.
2432
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002433- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002434 Begin and End addresses of the area used by the
2435 simple memory test.
2436
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002437- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002438 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002439
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002440- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002441 Scratch address used by the alternate memory test
2442 You only need to set this if address zero isn't writeable
2443
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002444- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2445 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002446 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002447 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002448 fixing up gd->ram_size the Linux kernel should gets passed
2449 the now "corrected" memory size and won't touch it either.
2450 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002451 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002452 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002453 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002454
2455 This option can be used as a workaround for the 440EPx/GRx
2456 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2457 be touched.
2458
2459 WARNING: Please make sure that this value is a multiple of
2460 the Linux page size (normally 4k). If this is not the case,
2461 then the end address of the Linux memory will be located at a
2462 non page size aligned address and this could cause major
2463 problems.
2464
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002465- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002466 Default load address for network file downloads
2467
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002468- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002469 Enable temporary baudrate change while serial download
2470
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002471- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002472 Physical start address of SDRAM. _Must_ be 0 here.
2473
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002474- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002475 Physical start address of Motherboard I/O (if using a
2476 Cogent motherboard)
2477
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002478- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002479 Physical start address of Flash memory.
2480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002481- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002482 Physical start address of boot monitor code (set by
2483 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002484 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002485 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002487- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002488 Size of memory reserved for monitor code, used to
2489 determine _at_compile_time_ (!) if the environment is
2490 embedded within the U-Boot image, or in a separate
2491 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002493- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002494 Size of DRAM reserved for malloc() use.
2495
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002496- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002497 Normally compressed uImages are limited to an
2498 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002499 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002500 to adjust this setting to your needs.
2501
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002502- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002503 Maximum size of memory mapped by the startup code of
2504 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002505 the Linux kernel (bd_info, boot arguments, FDT blob if
2506 used) must be put below this limit, unless "bootm_low"
2507 enviroment variable is defined and non-zero. In such case
2508 all data for the Linux kernel must be between "bootm_low"
Grant Likelyc3624e62011-03-28 09:58:43 +00002509 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2510 variable "bootm_mapsize" will override the value of
2511 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2512 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002513
John Rigbyfca43cc2010-10-13 13:57:35 -06002514- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2515 Enable initrd_high functionality. If defined then the
2516 initrd_high feature is enabled and the bootm ramdisk subcommand
2517 is enabled.
2518
2519- CONFIG_SYS_BOOT_GET_CMDLINE:
2520 Enables allocating and saving kernel cmdline in space between
2521 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2522
2523- CONFIG_SYS_BOOT_GET_KBD:
2524 Enables allocating and saving a kernel copy of the bd_info in
2525 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002527- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002528 Max number of Flash memory banks
2529
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002530- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002531 Max number of sectors on a Flash chip
2532
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002533- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002534 Timeout for Flash erase operations (in ms)
2535
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002536- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002537 Timeout for Flash write operations (in ms)
2538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002539- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002540 Timeout for Flash set sector lock bit operation (in ms)
2541
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002542- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002543 Timeout for Flash clear lock bits operation (in ms)
2544
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002545- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002546 If defined, hardware flash sectors protection is used
2547 instead of U-Boot software protection.
2548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002549- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002550
2551 Enable TFTP transfers directly to flash memory;
2552 without this option such a download has to be
2553 performed in two steps: (1) download to RAM, and (2)
2554 copy from RAM to flash.
2555
2556 The two-step approach is usually more reliable, since
2557 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002558 the flash, but in some situations (when system RAM is
2559 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002560 downloaded image) this option may be very useful.
2561
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002562- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002563 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002564 common flash structure for storing flash geometry.
2565
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002566- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002567 This option also enables the building of the cfi_flash driver
2568 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002569
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002570- CONFIG_FLASH_CFI_MTD
2571 This option enables the building of the cfi_mtd driver
2572 in the drivers directory. The driver exports CFI flash
2573 to the MTD layer.
2574
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002575- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002576 Use buffered writes to flash.
2577
2578- CONFIG_FLASH_SPANSION_S29WS_N
2579 s29ws-n MirrorBit flash has non-standard addresses for buffered
2580 write commands.
2581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002582- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002583 If this option is defined, the common CFI flash doesn't
2584 print it's warning upon not recognized FLASH banks. This
2585 is useful, if some of the configured banks are only
2586 optionally available.
2587
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002588- CONFIG_FLASH_SHOW_PROGRESS
2589 If defined (must be an integer), print out countdown
2590 digits and dots. Recommended value: 45 (9..1) for 80
2591 column displays, 15 (3..1) for 40 column displays.
2592
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002593- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002594 Defines the number of Ethernet receive buffers. On some
2595 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002596 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2597 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002598 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002599 Defaults to 4 if not defined.
2600
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002601- CONFIG_ENV_MAX_ENTRIES
2602
Wolfgang Denk071bc922010-10-27 22:48:30 +02002603 Maximum number of entries in the hash table that is used
2604 internally to store the environment settings. The default
2605 setting is supposed to be generous and should work in most
2606 cases. This setting can be used to tune behaviour; see
2607 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002608
wdenkc6097192002-11-03 00:24:07 +00002609The following definitions that deal with the placement and management
2610of environment data (variable area); in general, we support the
2611following configurations:
2612
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002613- CONFIG_BUILD_ENVCRC:
2614
2615 Builds up envcrc with the target environment so that external utils
2616 may easily extract it and embed it in final U-Boot images.
2617
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002618- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002619
2620 Define this if the environment is in flash memory.
2621
2622 a) The environment occupies one whole flash sector, which is
2623 "embedded" in the text segment with the U-Boot code. This
2624 happens usually with "bottom boot sector" or "top boot
2625 sector" type flash chips, which have several smaller
2626 sectors at the start or the end. For instance, such a
2627 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2628 such a case you would place the environment in one of the
2629 4 kB sectors - with U-Boot code before and after it. With
2630 "top boot sector" type flash chips, you would put the
2631 environment in one of the last sectors, leaving a gap
2632 between U-Boot and the environment.
2633
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002634 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002635
2636 Offset of environment data (variable area) to the
2637 beginning of flash memory; for instance, with bottom boot
2638 type flash chips the second sector can be used: the offset
2639 for this sector is given here.
2640
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002641 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002642
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002643 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002644
2645 This is just another way to specify the start address of
2646 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002647 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002648
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002649 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002650
2651 Size of the sector containing the environment.
2652
2653
2654 b) Sometimes flash chips have few, equal sized, BIG sectors.
2655 In such a case you don't want to spend a whole sector for
2656 the environment.
2657
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002658 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002659
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002660 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002661 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002662 of this flash sector for the environment. This saves
2663 memory for the RAM copy of the environment.
2664
2665 It may also save flash memory if you decide to use this
2666 when your environment is "embedded" within U-Boot code,
2667 since then the remainder of the flash sector could be used
2668 for U-Boot code. It should be pointed out that this is
2669 STRONGLY DISCOURAGED from a robustness point of view:
2670 updating the environment in flash makes it always
2671 necessary to erase the WHOLE sector. If something goes
2672 wrong before the contents has been restored from a copy in
2673 RAM, your target system will be dead.
2674
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002675 - CONFIG_ENV_ADDR_REDUND
2676 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002677
wdenk43d96162003-03-06 00:02:04 +00002678 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002679 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002680 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002681 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002682
2683BE CAREFUL! Any changes to the flash layout, and some changes to the
2684source code will make it necessary to adapt <board>/u-boot.lds*
2685accordingly!
2686
2687
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002688- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002689
2690 Define this if you have some non-volatile memory device
2691 (NVRAM, battery buffered SRAM) which you want to use for the
2692 environment.
2693
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002694 - CONFIG_ENV_ADDR:
2695 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002696
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002697 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002698 want to use for environment. It is assumed that this memory
2699 can just be read and written to, without any special
2700 provision.
2701
2702BE CAREFUL! The first access to the environment happens quite early
2703in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002704console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002705U-Boot will hang.
2706
2707Please note that even with NVRAM we still use a copy of the
2708environment in RAM: we could work on NVRAM directly, but we want to
2709keep settings there always unmodified except somebody uses "saveenv"
2710to save the current settings.
2711
2712
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002713- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002714
2715 Use this if you have an EEPROM or similar serial access
2716 device and a driver for it.
2717
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002718 - CONFIG_ENV_OFFSET:
2719 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002720
2721 These two #defines specify the offset and size of the
2722 environment area within the total memory of your EEPROM.
2723
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002724 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002725 If defined, specified the chip address of the EEPROM device.
2726 The default address is zero.
2727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002728 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002729 If defined, the number of bits used to address bytes in a
2730 single page in the EEPROM device. A 64 byte page, for example
2731 would require six bits.
2732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002734 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002735 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002736
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002737 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002738 The length in bytes of the EEPROM memory array address. Note
2739 that this is NOT the chip address length!
2740
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002741 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002742 EEPROM chips that implement "address overflow" are ones
2743 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2744 address and the extra bits end up in the "chip address" bit
2745 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2746 byte chips.
2747
2748 Note that we consider the length of the address field to
2749 still be one byte because the extra address bits are hidden
2750 in the chip address.
2751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002752 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002753 The size in bytes of the EEPROM device.
2754
Heiko Schocher548738b2010-01-07 08:55:40 +01002755 - CONFIG_ENV_EEPROM_IS_ON_I2C
2756 define this, if you have I2C and SPI activated, and your
2757 EEPROM, which holds the environment, is on the I2C bus.
2758
2759 - CONFIG_I2C_ENV_EEPROM_BUS
2760 if you have an Environment on an EEPROM reached over
2761 I2C muxes, you can define here, how to reach this
2762 EEPROM. For example:
2763
Wolfgang Denka9046b92010-06-13 17:48:15 +02002764 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002765
2766 EEPROM which holds the environment, is reached over
2767 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002768
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002769- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002770
wdenkd4ca31c2004-01-02 14:00:00 +00002771 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002772 want to use for the environment.
2773
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002774 - CONFIG_ENV_OFFSET:
2775 - CONFIG_ENV_ADDR:
2776 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002777
2778 These three #defines specify the offset and size of the
2779 environment area within the total memory of your DataFlash placed
2780 at the specified address.
2781
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002782- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002783
2784 Define this if you have a NAND device which you want to use
2785 for the environment.
2786
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002787 - CONFIG_ENV_OFFSET:
2788 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002789
2790 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002791 area within the first NAND device. CONFIG_ENV_OFFSET must be
2792 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002793
Scott Woodfdd813d2010-09-17 14:38:37 -05002794 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002795
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002796 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002797 size used to hold a redundant copy of the environment data, so
2798 that there is a valid backup copy in case there is a power failure
2799 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
2800 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002801
Scott Woodfdd813d2010-09-17 14:38:37 -05002802 - CONFIG_ENV_RANGE (optional):
2803
2804 Specifies the length of the region in which the environment
2805 can be written. This should be a multiple of the NAND device's
2806 block size. Specifying a range with more erase blocks than
2807 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2808 the range to be avoided.
2809
2810 - CONFIG_ENV_OFFSET_OOB (optional):
2811
2812 Enables support for dynamically retrieving the offset of the
2813 environment from block zero's out-of-band data. The
2814 "nand env.oob" command can be used to record this offset.
2815 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2816 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002817
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002818- CONFIG_NAND_ENV_DST
2819
2820 Defines address in RAM to which the nand_spl code should copy the
2821 environment. If redundant environment is used, it will be copied to
2822 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002824- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002825
2826 Defines offset to the initial SPI buffer area in DPRAM. The
2827 area is used at an early stage (ROM part) if the environment
2828 is configured to reside in the SPI EEPROM: We need a 520 byte
2829 scratch DPRAM area. It is used between the two initialization
2830 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2831 to be a good choice since it makes it far enough from the
2832 start of the data area as well as from the stack pointer.
2833
Bruce Adlere881cb52007-11-02 13:15:42 -07002834Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002835has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002836created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002837until then to read environment variables.
2838
wdenk85ec0bc2003-03-31 16:34:49 +00002839The environment is protected by a CRC32 checksum. Before the monitor
2840is relocated into RAM, as a result of a bad CRC you will be working
2841with the compiled-in default environment - *silently*!!! [This is
2842necessary, because the first environment variable we need is the
2843"baudrate" setting for the console - if we have a bad CRC, we don't
2844have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002845
2846Note: once the monitor has been relocated, then it will complain if
2847the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002848use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002849
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002850- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002851 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002852
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002853 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002854 also needs to be defined.
2855
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002856- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002857 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002858
Ron Madridf5675aa2009-02-18 14:30:44 -08002859- CONFIG_NS16550_MIN_FUNCTIONS:
2860 Define this if you desire to only have use of the NS16550_init
2861 and NS16550_putc functions for the serial driver located at
2862 drivers/serial/ns16550.c. This option is useful for saving
2863 space for already greatly restricted images, including but not
2864 limited to NAND_SPL configurations.
2865
wdenkc6097192002-11-03 00:24:07 +00002866Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002867---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002868
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002869- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002870 Cache Line Size of the CPU.
2871
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002872- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002873 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002874
wdenk42d1f032003-10-15 23:53:47 +00002875 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2876 and RPXsuper) to be able to adjust the position of
2877 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002878
Timur Tabie46fedf2011-08-04 18:03:41 -05002879- CONFIG_SYS_CCSRBAR_DEFAULT:
2880 Default (power-on reset) physical address of CCSR on Freescale
2881 PowerPC SOCs.
2882
2883- CONFIG_SYS_CCSRBAR:
2884 Virtual address of CCSR. On a 32-bit build, this is typically
2885 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2886
2887 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2888 for cross-platform code that uses that macro instead.
2889
2890- CONFIG_SYS_CCSRBAR_PHYS:
2891 Physical address of CCSR. CCSR can be relocated to a new
2892 physical address, if desired. In this case, this macro should
2893 be set to that address. Otherwise, it should be set to the
2894 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2895 is typically relocated on 36-bit builds. It is recommended
2896 that this macro be defined via the _HIGH and _LOW macros:
2897
2898 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2899 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2900
2901- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002902 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2903 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05002904 used in assembly code, so it must not contain typecasts or
2905 integer size suffixes (e.g. "ULL").
2906
2907- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2908 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2909 used in assembly code, so it must not contain typecasts or
2910 integer size suffixes (e.g. "ULL").
2911
2912- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2913 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2914 forced to a value that ensures that CCSR is not relocated.
2915
wdenk7f6c2cb2002-11-10 22:06:23 +00002916- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002917 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002918
2919 the default drive number (default value 0)
2920
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002921 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002922
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002923 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002924 (default value 1)
2925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002926 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002927
wdenk43d96162003-03-06 00:02:04 +00002928 defines the offset of register from address. It
2929 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002930 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002931
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002932 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2933 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002934 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002936 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002937 fdc_hw_init() is called at the beginning of the FDC
2938 setup. fdc_hw_init() must be provided by the board
2939 source code. It is used to make hardware dependant
2940 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002941
Macpaul Lin0abddf82011-04-11 20:45:32 +00002942- CONFIG_IDE_AHB:
2943 Most IDE controllers were designed to be connected with PCI
2944 interface. Only few of them were designed for AHB interface.
2945 When software is doing ATA command and data transfer to
2946 IDE devices through IDE-AHB controller, some additional
2947 registers accessing to these kind of IDE-AHB controller
2948 is requierd.
2949
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002950- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002951 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002952 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002953
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002954- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002955
wdenk7152b1d2003-09-05 23:19:14 +00002956 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002957 initial data and stack; please note that this must be
2958 writable memory that is working WITHOUT special
2959 initialization, i. e. you CANNOT use normal RAM which
2960 will become available only after programming the
2961 memory controller and running certain initialization
2962 sequences.
2963
2964 U-Boot uses the following memory types:
2965 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2966 - MPC824X: data cache
2967 - PPC4xx: data cache
2968
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002969- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002970
2971 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002972 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2973 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002974 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02002975 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002976 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2977 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2978 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002979
2980 Note:
2981 On the MPC824X (or other systems that use the data
2982 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002983 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002984 point to an otherwise UNUSED address space between
2985 the top of RAM and the start of the PCI space.
2986
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002987- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002988
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002989- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002991- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002993- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002995- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002997- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002998
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002999- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003000 SDRAM timing
3001
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003002- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003003 periodic timer for refresh
3004
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003005- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003006
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003007- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3008 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3009 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3010 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003011 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3012
3013- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003014 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3015 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003016 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3017
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003018- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3019 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003020 Machine Mode Register and Memory Periodic Timer
3021 Prescaler definitions (SDRAM timing)
3022
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003023- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003024 enable I2C microcode relocation patch (MPC8xx);
3025 define relocation offset in DPRAM [DSP2]
3026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003027- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003028 enable SMC microcode relocation patch (MPC8xx);
3029 define relocation offset in DPRAM [SMC1]
3030
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003031- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003032 enable SPI microcode relocation patch (MPC8xx);
3033 define relocation offset in DPRAM [SCC4]
3034
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003035- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003036 Use OSCM clock mode on MBX8xx board. Be careful,
3037 wrong setting might damage your board. Read
3038 doc/README.MBX before setting this variable!
3039
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003040- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003041 Offset of the bootmode word in DPRAM used by post
3042 (Power On Self Tests). This definition overrides
3043 #define'd default value in commproc.h resp.
3044 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003045
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003046- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3047 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3048 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3049 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3050 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3051 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3052 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3053 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003054 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003055
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003056- CONFIG_PCI_DISABLE_PCIE:
3057 Disable PCI-Express on systems where it is supported but not
3058 required.
3059
Kumar Galaa09b9b62010-12-30 12:09:53 -06003060- CONFIG_SYS_SRIO:
3061 Chip has SRIO or not
3062
3063- CONFIG_SRIO1:
3064 Board has SRIO 1 port available
3065
3066- CONFIG_SRIO2:
3067 Board has SRIO 2 port available
3068
3069- CONFIG_SYS_SRIOn_MEM_VIRT:
3070 Virtual Address of SRIO port 'n' memory region
3071
3072- CONFIG_SYS_SRIOn_MEM_PHYS:
3073 Physical Address of SRIO port 'n' memory region
3074
3075- CONFIG_SYS_SRIOn_MEM_SIZE:
3076 Size of SRIO port 'n' memory region
3077
Alex Watermaneced4622011-05-19 15:08:36 -04003078- CONFIG_SYS_NDFC_16
3079 Defined to tell the NDFC that the NAND chip is using a
3080 16 bit bus.
3081
3082- CONFIG_SYS_NDFC_EBC0_CFG
3083 Sets the EBC0_CFG register for the NDFC. If not defined
3084 a default value will be used.
3085
Ben Warrenbb99ad62006-09-07 16:50:54 -04003086- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003087 Get DDR timing information from an I2C EEPROM. Common
3088 with pluggable memory modules such as SODIMMs
3089
Ben Warrenbb99ad62006-09-07 16:50:54 -04003090 SPD_EEPROM_ADDRESS
3091 I2C address of the SPD EEPROM
3092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003093- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003094 If SPD EEPROM is on an I2C bus other than the first
3095 one, specify here. Note that the value must resolve
3096 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003097
York Sun1b3e3c42011-06-07 09:42:16 +08003098- CONFIG_SYS_DDR_RAW_TIMING
3099 Get DDR timing information from other than SPD. Common with
3100 soldered DDR chips onboard without SPD. DDR raw timing
3101 parameters are extracted from datasheet and hard-coded into
3102 header files or board specific files.
3103
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003104- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003105 Only for 83xx systems. If specified, then DDR should
3106 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003107
wdenkc26e4542004-04-18 10:13:26 +00003108- CONFIG_ETHER_ON_FEC[12]
3109 Define to enable FEC[12] on a 8xx series processor.
3110
3111- CONFIG_FEC[12]_PHY
3112 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003113 to the given FEC; i. e.
3114 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003115 means that the PHY with address 4 is connected to FEC1
3116
3117 When set to -1, means to probe for first available.
3118
3119- CONFIG_FEC[12]_PHY_NORXERR
3120 The PHY does not have a RXERR line (RMII only).
3121 (so program the FEC to ignore it).
3122
3123- CONFIG_RMII
3124 Enable RMII mode for all FECs.
3125 Note that this is a global option, we can't
3126 have one FEC in standard MII mode and another in RMII mode.
3127
wdenk5cf91d62004-04-23 20:32:05 +00003128- CONFIG_CRC32_VERIFY
3129 Add a verify option to the crc32 command.
3130 The syntax is:
3131
3132 => crc32 -v <address> <count> <crc32>
3133
3134 Where address/count indicate a memory area
3135 and crc32 is the correct crc32 which the
3136 area should have.
3137
wdenk56523f12004-07-11 17:40:54 +00003138- CONFIG_LOOPW
3139 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003140 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003141
stroese7b466642004-12-16 18:46:55 +00003142- CONFIG_MX_CYCLIC
3143 Add the "mdc" and "mwc" memory commands. These are cyclic
3144 "md/mw" commands.
3145 Examples:
3146
wdenkefe2a4d2004-12-16 21:44:03 +00003147 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003148 This command will print 4 bytes (10,11,12,13) each 500 ms.
3149
wdenkefe2a4d2004-12-16 21:44:03 +00003150 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003151 This command will write 12345678 to address 100 all 10 ms.
3152
wdenkefe2a4d2004-12-16 21:44:03 +00003153 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003154 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003155
wdenk8aa1a2d2005-04-04 12:44:11 +00003156- CONFIG_SKIP_LOWLEVEL_INIT
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +02003157 [ARM, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003158 low level initializations (like setting up the memory
3159 controller) are omitted and/or U-Boot does not
3160 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003161
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003162 Normally this variable MUST NOT be defined. The only
3163 exception is when U-Boot is loaded (to RAM) by some
3164 other boot loader or by a debugger which performs
3165 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003166
Aneesh V401bb302011-07-13 05:11:07 +00003167- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003168 Modifies the behaviour of start.S when compiling a loader
3169 that is executed before the actual U-Boot. E.g. when
3170 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003171
Matthias Weisserd8834a12011-03-10 21:36:32 +00003172- CONFIG_USE_ARCH_MEMCPY
3173 CONFIG_USE_ARCH_MEMSET
3174 If these options are used a optimized version of memcpy/memset will
3175 be used if available. These functions may be faster under some
3176 conditions but may increase the binary size.
3177
wdenkc6097192002-11-03 00:24:07 +00003178Building the Software:
3179======================
3180
Wolfgang Denk218ca722008-03-26 10:40:12 +01003181Building U-Boot has been tested in several native build environments
3182and in many different cross environments. Of course we cannot support
3183all possibly existing versions of cross development tools in all
3184(potentially obsolete) versions. In case of tool chain problems we
3185recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3186which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003187
Wolfgang Denk218ca722008-03-26 10:40:12 +01003188If you are not using a native environment, it is assumed that you
3189have GNU cross compiling tools available in your path. In this case,
3190you must set the environment variable CROSS_COMPILE in your shell.
3191Note that no changes to the Makefile or any other source files are
3192necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003193
Wolfgang Denk218ca722008-03-26 10:40:12 +01003194 $ CROSS_COMPILE=ppc_4xx-
3195 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003196
Peter Tyser2f8d3962009-03-13 18:54:51 -05003197Note: If you wish to generate Windows versions of the utilities in
3198 the tools directory you can use the MinGW toolchain
3199 (http://www.mingw.org). Set your HOST tools to the MinGW
3200 toolchain and execute 'make tools'. For example:
3201
3202 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3203
3204 Binaries such as tools/mkimage.exe will be created which can
3205 be executed on computers running Windows.
3206
Wolfgang Denk218ca722008-03-26 10:40:12 +01003207U-Boot is intended to be simple to build. After installing the
3208sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003209is done by typing:
3210
3211 make NAME_config
3212
Wolfgang Denk218ca722008-03-26 10:40:12 +01003213where "NAME_config" is the name of one of the existing configu-
3214rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003215
wdenk2729af92004-05-03 20:45:30 +00003216Note: for some board special configuration names may exist; check if
3217 additional information is available from the board vendor; for
3218 instance, the TQM823L systems are available without (standard)
3219 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003220 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003221
wdenk2729af92004-05-03 20:45:30 +00003222 make TQM823L_config
3223 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003224
wdenk2729af92004-05-03 20:45:30 +00003225 make TQM823L_LCD_config
3226 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003227
wdenk2729af92004-05-03 20:45:30 +00003228 etc.
wdenkc6097192002-11-03 00:24:07 +00003229
wdenkc6097192002-11-03 00:24:07 +00003230
wdenk2729af92004-05-03 20:45:30 +00003231Finally, type "make all", and you should get some working U-Boot
3232images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003233
wdenk2729af92004-05-03 20:45:30 +00003234- "u-boot.bin" is a raw binary image
3235- "u-boot" is an image in ELF binary format
3236- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003237
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003238By default the build is performed locally and the objects are saved
3239in the source directory. One of the two methods can be used to change
3240this behavior and build U-Boot to some external directory:
3241
32421. Add O= to the make command line invocations:
3243
3244 make O=/tmp/build distclean
3245 make O=/tmp/build NAME_config
3246 make O=/tmp/build all
3247
32482. Set environment variable BUILD_DIR to point to the desired location:
3249
3250 export BUILD_DIR=/tmp/build
3251 make distclean
3252 make NAME_config
3253 make all
3254
3255Note that the command line "O=" setting overrides the BUILD_DIR environment
3256variable.
3257
wdenkc6097192002-11-03 00:24:07 +00003258
wdenk2729af92004-05-03 20:45:30 +00003259Please be aware that the Makefiles assume you are using GNU make, so
3260for instance on NetBSD you might need to use "gmake" instead of
3261native "make".
wdenkc6097192002-11-03 00:24:07 +00003262
wdenkc6097192002-11-03 00:24:07 +00003263
wdenk2729af92004-05-03 20:45:30 +00003264If the system board that you have is not listed, then you will need
3265to port U-Boot to your hardware platform. To do this, follow these
3266steps:
wdenkc6097192002-11-03 00:24:07 +00003267
wdenk2729af92004-05-03 20:45:30 +000032681. Add a new configuration option for your board to the toplevel
3269 "Makefile" and to the "MAKEALL" script, using the existing
3270 entries as examples. Note that here and at many other places
3271 boards and other names are listed in alphabetical sort order. Please
3272 keep this order.
32732. Create a new directory to hold your board specific code. Add any
3274 files you need. In your board directory, you will need at least
3275 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
32763. Create a new configuration file "include/configs/<board>.h" for
3277 your board
32783. If you're porting U-Boot to a new CPU, then also create a new
3279 directory to hold your CPU specific code. Add any files you need.
32804. Run "make <board>_config" with your new name.
32815. Type "make", and you should get a working "u-boot.srec" file
3282 to be installed on your target system.
32836. Debug and solve any problems that might arise.
3284 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003285
wdenkc6097192002-11-03 00:24:07 +00003286
wdenk2729af92004-05-03 20:45:30 +00003287Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3288==============================================================
wdenkc6097192002-11-03 00:24:07 +00003289
Wolfgang Denk218ca722008-03-26 10:40:12 +01003290If you have modified U-Boot sources (for instance added a new board
3291or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003292provide feedback to the other developers. The feedback normally takes
3293the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003294official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003295
Wolfgang Denk218ca722008-03-26 10:40:12 +01003296But before you submit such a patch, please verify that your modifi-
3297cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003298the supported boards compile WITHOUT ANY compiler warnings. To do so,
3299just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003300for ALL supported system. Be warned, this will take a while. You can
3301select which (cross) compiler to use by passing a `CROSS_COMPILE'
3302environment variable to the script, i. e. to use the ELDK cross tools
3303you can type
wdenkc6097192002-11-03 00:24:07 +00003304
wdenk2729af92004-05-03 20:45:30 +00003305 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003308
wdenk2729af92004-05-03 20:45:30 +00003309 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003310
Wolfgang Denk218ca722008-03-26 10:40:12 +01003311When using the MAKEALL script, the default behaviour is to build
3312U-Boot in the source directory. This location can be changed by
3313setting the BUILD_DIR environment variable. Also, for each target
3314built, the MAKEALL script saves two log files (<target>.ERR and
3315<target>.MAKEALL) in the <source dir>/LOG directory. This default
3316location can be changed by setting the MAKEALL_LOGDIR environment
3317variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003318
3319 export BUILD_DIR=/tmp/build
3320 export MAKEALL_LOGDIR=/tmp/log
3321 CROSS_COMPILE=ppc_8xx- MAKEALL
3322
Wolfgang Denk218ca722008-03-26 10:40:12 +01003323With the above settings build objects are saved in the /tmp/build,
3324log files are saved in the /tmp/log and the source tree remains clean
3325during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003326
3327
wdenk2729af92004-05-03 20:45:30 +00003328See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003329
wdenkc6097192002-11-03 00:24:07 +00003330
wdenk2729af92004-05-03 20:45:30 +00003331Monitor Commands - Overview:
3332============================
wdenkc6097192002-11-03 00:24:07 +00003333
wdenk2729af92004-05-03 20:45:30 +00003334go - start application at address 'addr'
3335run - run commands in an environment variable
3336bootm - boot application image from memory
3337bootp - boot image via network using BootP/TFTP protocol
3338tftpboot- boot image via network using TFTP protocol
3339 and env variables "ipaddr" and "serverip"
3340 (and eventually "gatewayip")
3341rarpboot- boot image via network using RARP/TFTP protocol
3342diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3343loads - load S-Record file over serial line
3344loadb - load binary file over serial line (kermit mode)
3345md - memory display
3346mm - memory modify (auto-incrementing)
3347nm - memory modify (constant address)
3348mw - memory write (fill)
3349cp - memory copy
3350cmp - memory compare
3351crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003352i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003353sspi - SPI utility commands
3354base - print or set address offset
3355printenv- print environment variables
3356setenv - set environment variables
3357saveenv - save environment variables to persistent storage
3358protect - enable or disable FLASH write protection
3359erase - erase FLASH memory
3360flinfo - print FLASH memory information
3361bdinfo - print Board Info structure
3362iminfo - print header information for application image
3363coninfo - print console devices and informations
3364ide - IDE sub-system
3365loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003366loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003367mtest - simple RAM test
3368icache - enable or disable instruction cache
3369dcache - enable or disable data cache
3370reset - Perform RESET of the CPU
3371echo - echo args to console
3372version - print monitor version
3373help - print online help
3374? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003375
wdenkc6097192002-11-03 00:24:07 +00003376
wdenk2729af92004-05-03 20:45:30 +00003377Monitor Commands - Detailed Description:
3378========================================
wdenkc6097192002-11-03 00:24:07 +00003379
wdenk2729af92004-05-03 20:45:30 +00003380TODO.
wdenkc6097192002-11-03 00:24:07 +00003381
wdenk2729af92004-05-03 20:45:30 +00003382For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003383
3384
wdenk2729af92004-05-03 20:45:30 +00003385Environment Variables:
3386======================
wdenkc6097192002-11-03 00:24:07 +00003387
wdenk2729af92004-05-03 20:45:30 +00003388U-Boot supports user configuration using Environment Variables which
3389can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003390
wdenk2729af92004-05-03 20:45:30 +00003391Environment Variables are set using "setenv", printed using
3392"printenv", and saved to Flash using "saveenv". Using "setenv"
3393without a value can be used to delete a variable from the
3394environment. As long as you don't save the environment you are
3395working with an in-memory copy. In case the Flash area containing the
3396environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003397
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003398Some configuration options can be set using Environment Variables.
3399
3400List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003401
wdenk2729af92004-05-03 20:45:30 +00003402 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003403
wdenk2729af92004-05-03 20:45:30 +00003404 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003407
wdenk2729af92004-05-03 20:45:30 +00003408 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003409
wdenk2729af92004-05-03 20:45:30 +00003410 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003411
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003412 bootm_low - Memory range available for image processing in the bootm
3413 command can be restricted. This variable is given as
3414 a hexadecimal number and defines lowest address allowed
3415 for use by the bootm command. See also "bootm_size"
3416 environment variable. Address defined by "bootm_low" is
3417 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003418 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3419 bootm_mapsize.
3420
3421 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3422 This variable is given as a hexadecimal number and it
3423 defines the size of the memory region starting at base
3424 address bootm_low that is accessible by the Linux kernel
3425 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3426 as the default value if it is defined, and bootm_size is
3427 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003428
3429 bootm_size - Memory range available for image processing in the bootm
3430 command can be restricted. This variable is given as
3431 a hexadecimal number and defines the size of the region
3432 allowed for use by the bootm command. See also "bootm_low"
3433 environment variable.
3434
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003435 updatefile - Location of the software update file on a TFTP server, used
3436 by the automatic software update feature. Please refer to
3437 documentation in doc/README.update for more details.
3438
wdenk2729af92004-05-03 20:45:30 +00003439 autoload - if set to "no" (any string beginning with 'n'),
3440 "bootp" will just load perform a lookup of the
3441 configuration from the BOOTP server, but not try to
3442 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003443
wdenk2729af92004-05-03 20:45:30 +00003444 autostart - if set to "yes", an image loaded using the "bootp",
3445 "rarpboot", "tftpboot" or "diskboot" commands will
3446 be automatically started (by internally calling
3447 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003448
wdenk2729af92004-05-03 20:45:30 +00003449 If set to "no", a standalone image passed to the
3450 "bootm" command will be copied to the load address
3451 (and eventually uncompressed), but NOT be started.
3452 This can be used to load and uncompress arbitrary
3453 data.
wdenkc6097192002-11-03 00:24:07 +00003454
David A. Longa28afca2011-07-09 16:40:19 -04003455 fdt_high - if set this restricts the maximum address that the
3456 flattened device tree will be copied into upon boot.
3457 If this is set to the special value 0xFFFFFFFF then
3458 the fdt will not be copied at all on boot. For this
3459 to work it must reside in writable memory, have
3460 sufficient padding on the end of it for u-boot to
3461 add the information it needs into it, and the memory
3462 must be accessible by the kernel.
3463
wdenk17ea1172004-06-06 21:51:03 +00003464 i2cfast - (PPC405GP|PPC405EP only)
3465 if set to 'y' configures Linux I2C driver for fast
3466 mode (400kHZ). This environment variable is used in
3467 initialization code. So, for changes to be effective
3468 it must be saved and board must be reset.
3469
wdenk2729af92004-05-03 20:45:30 +00003470 initrd_high - restrict positioning of initrd images:
3471 If this variable is not set, initrd images will be
3472 copied to the highest possible address in RAM; this
3473 is usually what you want since it allows for
3474 maximum initrd size. If for some reason you want to
3475 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003476 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003477 variable to a value of "no" or "off" or "0".
3478 Alternatively, you can set it to a maximum upper
3479 address to use (U-Boot will still check that it
3480 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk2729af92004-05-03 20:45:30 +00003482 For instance, when you have a system with 16 MB
3483 RAM, and want to reserve 4 MB from use by Linux,
3484 you can do this by adding "mem=12M" to the value of
3485 the "bootargs" variable. However, now you must make
3486 sure that the initrd image is placed in the first
3487 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003488
wdenk2729af92004-05-03 20:45:30 +00003489 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003490
wdenk2729af92004-05-03 20:45:30 +00003491 If you set initrd_high to 0xFFFFFFFF, this is an
3492 indication to U-Boot that all addresses are legal
3493 for the Linux kernel, including addresses in flash
3494 memory. In this case U-Boot will NOT COPY the
3495 ramdisk at all. This may be useful to reduce the
3496 boot time on your system, but requires that this
3497 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003498
wdenk2729af92004-05-03 20:45:30 +00003499 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003500
wdenk2729af92004-05-03 20:45:30 +00003501 loadaddr - Default load address for commands like "bootp",
3502 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003505
wdenk2729af92004-05-03 20:45:30 +00003506 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003507
wdenk2729af92004-05-03 20:45:30 +00003508 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003509
wdenk2729af92004-05-03 20:45:30 +00003510 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003511
wdenk2729af92004-05-03 20:45:30 +00003512 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003513
Mike Frysingere2a53452011-10-02 10:01:27 +00003514 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003515
Mike Frysingere2a53452011-10-02 10:01:27 +00003516 ethact - controls which interface is currently active.
3517 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003518
Heiko Schocher48690d82010-07-20 17:45:02 +02003519 => setenv ethact FEC
3520 => ping 192.168.0.1 # traffic sent on FEC
3521 => setenv ethact SCC
3522 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003523
Matthias Fuchse1692572008-01-17 07:45:05 +01003524 ethrotate - When set to "no" U-Boot does not go through all
3525 available network interfaces.
3526 It just stays at the currently selected interface.
3527
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003528 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003529 either succeed or fail without retrying.
3530 When set to "once" the network operation will
3531 fail when all the available network interfaces
3532 are tried once without success.
3533 Useful on scripts which control the retry operation
3534 themselves.
wdenkc6097192002-11-03 00:24:07 +00003535
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003536 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003537
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003538 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003539 UDP source port.
3540
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003541 tftpdstport - If this is set, the value is used for TFTP's UDP
3542 destination port instead of the Well Know Port 69.
3543
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003544 tftpblocksize - Block size to use for TFTP transfers; if not set,
3545 we use the TFTP server's default block size
3546
3547 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3548 seconds, minimum value is 1000 = 1 second). Defines
3549 when a packet is considered to be lost so it has to
3550 be retransmitted. The default is 5000 = 5 seconds.
3551 Lowering this value may make downloads succeed
3552 faster in networks with high packet loss rates or
3553 with unreliable TFTP servers.
3554
3555 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003556 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003557 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003558
wdenk2729af92004-05-03 20:45:30 +00003559The following environment variables may be used and automatically
3560updated by the network boot commands ("bootp" and "rarpboot"),
3561depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003562
wdenk2729af92004-05-03 20:45:30 +00003563 bootfile - see above
3564 dnsip - IP address of your Domain Name Server
3565 dnsip2 - IP address of your secondary Domain Name Server
3566 gatewayip - IP address of the Gateway (Router) to use
3567 hostname - Target hostname
3568 ipaddr - see above
3569 netmask - Subnet Mask
3570 rootpath - Pathname of the root filesystem on the NFS server
3571 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003572
wdenka3d991b2004-04-15 21:48:45 +00003573
wdenk2729af92004-05-03 20:45:30 +00003574There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003575
wdenk2729af92004-05-03 20:45:30 +00003576 serial# - contains hardware identification information such
3577 as type string and/or serial number
3578 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003579
wdenk2729af92004-05-03 20:45:30 +00003580These variables can be set only once (usually during manufacturing of
3581the board). U-Boot refuses to delete or overwrite these variables
3582once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003583
3584
wdenk2729af92004-05-03 20:45:30 +00003585Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk2729af92004-05-03 20:45:30 +00003587 ver - Contains the U-Boot version string as printed
3588 with the "version" command. This variable is
3589 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003590
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk2729af92004-05-03 20:45:30 +00003592Please note that changes to some configuration parameters may take
3593only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003594
stroesec1551ea2003-04-04 15:53:41 +00003595
wdenk2729af92004-05-03 20:45:30 +00003596Command Line Parsing:
3597=====================
stroesec1551ea2003-04-04 15:53:41 +00003598
wdenk2729af92004-05-03 20:45:30 +00003599There are two different command line parsers available with U-Boot:
3600the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003601
wdenk2729af92004-05-03 20:45:30 +00003602Old, simple command line parser:
3603--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003604
wdenk2729af92004-05-03 20:45:30 +00003605- supports environment variables (through setenv / saveenv commands)
3606- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003607- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003608- special characters ('$', ';') can be escaped by prefixing with '\',
3609 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003610 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003611- You can also escape text by enclosing in single apostrophes, for example:
3612 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003613
wdenk2729af92004-05-03 20:45:30 +00003614Hush shell:
3615-----------
wdenkf07771c2003-05-28 08:06:31 +00003616
wdenk2729af92004-05-03 20:45:30 +00003617- similar to Bourne shell, with control structures like
3618 if...then...else...fi, for...do...done; while...do...done,
3619 until...do...done, ...
3620- supports environment ("global") variables (through setenv / saveenv
3621 commands) and local shell variables (through standard shell syntax
3622 "name=value"); only environment variables can be used with "run"
3623 command
wdenkf07771c2003-05-28 08:06:31 +00003624
wdenk2729af92004-05-03 20:45:30 +00003625General rules:
3626--------------
wdenkf07771c2003-05-28 08:06:31 +00003627
wdenk2729af92004-05-03 20:45:30 +00003628(1) If a command line (or an environment variable executed by a "run"
3629 command) contains several commands separated by semicolon, and
3630 one of these commands fails, then the remaining commands will be
3631 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003632
wdenk2729af92004-05-03 20:45:30 +00003633(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003634 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003635 command will cause "run" to terminate, i. e. the remaining
3636 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003637
wdenk2729af92004-05-03 20:45:30 +00003638Note for Redundant Ethernet Interfaces:
3639=======================================
wdenkf07771c2003-05-28 08:06:31 +00003640
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003641Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003642such configurations and is capable of automatic selection of a
3643"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003644
wdenk2729af92004-05-03 20:45:30 +00003645Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3646MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3647"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003648
wdenk2729af92004-05-03 20:45:30 +00003649If the network interface stores some valid MAC address (for instance
3650in SROM), this is used as default address if there is NO correspon-
3651ding setting in the environment; if the corresponding environment
3652variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003653
wdenk2729af92004-05-03 20:45:30 +00003654o If the SROM has a valid MAC address, and there is no address in the
3655 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003656
wdenk2729af92004-05-03 20:45:30 +00003657o If there is no valid address in the SROM, and a definition in the
3658 environment exists, then the value from the environment variable is
3659 used.
wdenkc6097192002-11-03 00:24:07 +00003660
wdenk2729af92004-05-03 20:45:30 +00003661o If both the SROM and the environment contain a MAC address, and
3662 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk2729af92004-05-03 20:45:30 +00003664o If both the SROM and the environment contain a MAC address, and the
3665 addresses differ, the value from the environment is used and a
3666 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003667
wdenk2729af92004-05-03 20:45:30 +00003668o If neither SROM nor the environment contain a MAC address, an error
3669 is raised.
wdenkc6097192002-11-03 00:24:07 +00003670
Ben Warrenecee9322010-04-26 11:11:46 -07003671If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3672will be programmed into hardware as part of the initialization process. This
3673may be skipped by setting the appropriate 'ethmacskip' environment variable.
3674The naming convention is as follows:
3675"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003676
wdenk2729af92004-05-03 20:45:30 +00003677Image Formats:
3678==============
wdenkc6097192002-11-03 00:24:07 +00003679
Marian Balakowicz3310c542008-03-12 12:13:13 +01003680U-Boot is capable of booting (and performing other auxiliary operations on)
3681images in two formats:
3682
3683New uImage format (FIT)
3684-----------------------
3685
3686Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3687to Flattened Device Tree). It allows the use of images with multiple
3688components (several kernels, ramdisks, etc.), with contents protected by
3689SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3690
3691
3692Old uImage format
3693-----------------
3694
3695Old image format is based on binary files which can be basically anything,
3696preceded by a special header; see the definitions in include/image.h for
3697details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003698
wdenk2729af92004-05-03 20:45:30 +00003699* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3700 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003701 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3702 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3703 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003704* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Thomas Chou1117cbf2010-05-28 10:56:50 +08003705 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3706 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003707* Compression Type (uncompressed, gzip, bzip2)
3708* Load Address
3709* Entry Point
3710* Image Name
3711* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003712
wdenk2729af92004-05-03 20:45:30 +00003713The header is marked by a special Magic Number, and both the header
3714and the data portions of the image are secured against corruption by
3715CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003716
wdenkc6097192002-11-03 00:24:07 +00003717
wdenk2729af92004-05-03 20:45:30 +00003718Linux Support:
3719==============
wdenkc6097192002-11-03 00:24:07 +00003720
wdenk2729af92004-05-03 20:45:30 +00003721Although U-Boot should support any OS or standalone application
3722easily, the main focus has always been on Linux during the design of
3723U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003724
wdenk2729af92004-05-03 20:45:30 +00003725U-Boot includes many features that so far have been part of some
3726special "boot loader" code within the Linux kernel. Also, any
3727"initrd" images to be used are no longer part of one big Linux image;
3728instead, kernel and "initrd" are separate images. This implementation
3729serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003730
wdenk2729af92004-05-03 20:45:30 +00003731- the same features can be used for other OS or standalone
3732 applications (for instance: using compressed images to reduce the
3733 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003734
wdenk2729af92004-05-03 20:45:30 +00003735- it becomes much easier to port new Linux kernel versions because
3736 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003737
wdenk2729af92004-05-03 20:45:30 +00003738- the same Linux kernel image can now be used with different "initrd"
3739 images; of course this also means that different kernel images can
3740 be run with the same "initrd". This makes testing easier (you don't
3741 have to build a new "zImage.initrd" Linux image when you just
3742 change a file in your "initrd"). Also, a field-upgrade of the
3743 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003744
wdenkc6097192002-11-03 00:24:07 +00003745
wdenk2729af92004-05-03 20:45:30 +00003746Linux HOWTO:
3747============
wdenkc6097192002-11-03 00:24:07 +00003748
wdenk2729af92004-05-03 20:45:30 +00003749Porting Linux to U-Boot based systems:
3750---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003751
wdenk2729af92004-05-03 20:45:30 +00003752U-Boot cannot save you from doing all the necessary modifications to
3753configure the Linux device drivers for use with your target hardware
3754(no, we don't intend to provide a full virtual machine interface to
3755Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003756
Stefan Roesea47a12b2010-04-15 16:07:28 +02003757But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003758
wdenk2729af92004-05-03 20:45:30 +00003759Just make sure your machine specific header file (for instance
3760include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003761Information structure as we define in include/asm-<arch>/u-boot.h,
3762and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003763as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003764
wdenkc6097192002-11-03 00:24:07 +00003765
wdenk2729af92004-05-03 20:45:30 +00003766Configuring the Linux kernel:
3767-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003768
wdenk2729af92004-05-03 20:45:30 +00003769No specific requirements for U-Boot. Make sure you have some root
3770device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003771
wdenkc6097192002-11-03 00:24:07 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773Building a Linux Image:
3774-----------------------
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3777not used. If you use recent kernel source, a new build target
3778"uImage" will exist which automatically builds an image usable by
3779U-Boot. Most older kernels also have support for a "pImage" target,
3780which was introduced for our predecessor project PPCBoot and uses a
3781100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003782
wdenk2729af92004-05-03 20:45:30 +00003783Example:
wdenkc6097192002-11-03 00:24:07 +00003784
wdenk2729af92004-05-03 20:45:30 +00003785 make TQM850L_config
3786 make oldconfig
3787 make dep
3788 make uImage
wdenkc6097192002-11-03 00:24:07 +00003789
wdenk2729af92004-05-03 20:45:30 +00003790The "uImage" build target uses a special tool (in 'tools/mkimage') to
3791encapsulate a compressed Linux kernel image with header information,
3792CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003793
wdenk2729af92004-05-03 20:45:30 +00003794* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003795
wdenk2729af92004-05-03 20:45:30 +00003796* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003797
wdenk2729af92004-05-03 20:45:30 +00003798 ${CROSS_COMPILE}-objcopy -O binary \
3799 -R .note -R .comment \
3800 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003801
wdenk2729af92004-05-03 20:45:30 +00003802* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003805
wdenk2729af92004-05-03 20:45:30 +00003806* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003807
wdenk2729af92004-05-03 20:45:30 +00003808 mkimage -A ppc -O linux -T kernel -C gzip \
3809 -a 0 -e 0 -n "Linux Kernel Image" \
3810 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003811
wdenk24ee89b2002-11-03 17:56:27 +00003812
wdenk2729af92004-05-03 20:45:30 +00003813The "mkimage" tool can also be used to create ramdisk images for use
3814with U-Boot, either separated from the Linux kernel image, or
3815combined into one file. "mkimage" encapsulates the images with a 64
3816byte header containing information about target architecture,
3817operating system, image type, compression method, entry points, time
3818stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003819
wdenk2729af92004-05-03 20:45:30 +00003820"mkimage" can be called in two ways: to verify existing images and
3821print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003822
wdenk2729af92004-05-03 20:45:30 +00003823In the first form (with "-l" option) mkimage lists the information
3824contained in the header of an existing U-Boot image; this includes
3825checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003826
wdenk2729af92004-05-03 20:45:30 +00003827 tools/mkimage -l image
3828 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003829
wdenk2729af92004-05-03 20:45:30 +00003830The second form (with "-d" option) is used to build a U-Boot image
3831from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003832
wdenk2729af92004-05-03 20:45:30 +00003833 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3834 -n name -d data_file image
3835 -A ==> set architecture to 'arch'
3836 -O ==> set operating system to 'os'
3837 -T ==> set image type to 'type'
3838 -C ==> set compression type 'comp'
3839 -a ==> set load address to 'addr' (hex)
3840 -e ==> set entry point to 'ep' (hex)
3841 -n ==> set image name to 'name'
3842 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003843
wdenk69459792004-05-29 16:53:29 +00003844Right now, all Linux kernels for PowerPC systems use the same load
3845address (0x00000000), but the entry point address depends on the
3846kernel version:
wdenkc6097192002-11-03 00:24:07 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848- 2.2.x kernels have the entry point at 0x0000000C,
3849- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003852
wdenk2729af92004-05-03 20:45:30 +00003853 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3854 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003855 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00003856 > examples/uImage.TQM850L
3857 Image Name: 2.4.4 kernel for TQM850L
3858 Created: Wed Jul 19 02:34:59 2000
3859 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3860 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3861 Load Address: 0x00000000
3862 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003865
wdenk2729af92004-05-03 20:45:30 +00003866 -> tools/mkimage -l examples/uImage.TQM850L
3867 Image Name: 2.4.4 kernel for TQM850L
3868 Created: Wed Jul 19 02:34:59 2000
3869 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3870 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3871 Load Address: 0x00000000
3872 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003873
wdenk2729af92004-05-03 20:45:30 +00003874NOTE: for embedded systems where boot time is critical you can trade
3875speed for memory and install an UNCOMPRESSED image instead: this
3876needs more space in Flash, but boots much faster since it does not
3877need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003878
Stefan Roesea47a12b2010-04-15 16:07:28 +02003879 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00003880 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3881 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02003882 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00003883 > examples/uImage.TQM850L-uncompressed
3884 Image Name: 2.4.4 kernel for TQM850L
3885 Created: Wed Jul 19 02:34:59 2000
3886 Image Type: PowerPC Linux Kernel Image (uncompressed)
3887 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3888 Load Address: 0x00000000
3889 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003890
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk2729af92004-05-03 20:45:30 +00003892Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3893when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003894
wdenk2729af92004-05-03 20:45:30 +00003895 -> tools/mkimage -n 'Simple Ramdisk Image' \
3896 > -A ppc -O linux -T ramdisk -C gzip \
3897 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3898 Image Name: Simple Ramdisk Image
3899 Created: Wed Jan 12 14:01:50 2000
3900 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3901 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3902 Load Address: 0x00000000
3903 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003904
wdenkdb01a2e2004-04-15 23:14:49 +00003905
wdenk2729af92004-05-03 20:45:30 +00003906Installing a Linux Image:
3907-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003908
wdenk2729af92004-05-03 20:45:30 +00003909To downloading a U-Boot image over the serial (console) interface,
3910you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003911
wdenk2729af92004-05-03 20:45:30 +00003912 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003913
wdenk2729af92004-05-03 20:45:30 +00003914The 'objcopy' does not understand the information in the U-Boot
3915image header, so the resulting S-Record file will be relative to
3916address 0x00000000. To load it to a given address, you need to
3917specify the target address as 'offset' parameter with the 'loads'
3918command.
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk2729af92004-05-03 20:45:30 +00003920Example: install the image to address 0x40100000 (which on the
3921TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003922
wdenk2729af92004-05-03 20:45:30 +00003923 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003924
wdenk2729af92004-05-03 20:45:30 +00003925 .......... done
3926 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk2729af92004-05-03 20:45:30 +00003928 => loads 40100000
3929 ## Ready for S-Record download ...
3930 ~>examples/image.srec
3931 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3932 ...
3933 15989 15990 15991 15992
3934 [file transfer complete]
3935 [connected]
3936 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003937
3938
wdenk2729af92004-05-03 20:45:30 +00003939You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003940this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003941corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003942
wdenk2729af92004-05-03 20:45:30 +00003943 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945 ## Checking Image at 40100000 ...
3946 Image Name: 2.2.13 for initrd on TQM850L
3947 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3948 Data Size: 335725 Bytes = 327 kB = 0 MB
3949 Load Address: 00000000
3950 Entry Point: 0000000c
3951 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003952
3953
wdenk2729af92004-05-03 20:45:30 +00003954Boot Linux:
3955-----------
wdenkc6097192002-11-03 00:24:07 +00003956
wdenk2729af92004-05-03 20:45:30 +00003957The "bootm" command is used to boot an application that is stored in
3958memory (RAM or Flash). In case of a Linux kernel image, the contents
3959of the "bootargs" environment variable is passed to the kernel as
3960parameters. You can check and modify this variable using the
3961"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003962
3963
wdenk2729af92004-05-03 20:45:30 +00003964 => printenv bootargs
3965 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003966
wdenk2729af92004-05-03 20:45:30 +00003967 => 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 +00003968
wdenk2729af92004-05-03 20:45:30 +00003969 => printenv bootargs
3970 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 +00003971
wdenk2729af92004-05-03 20:45:30 +00003972 => bootm 40020000
3973 ## Booting Linux kernel at 40020000 ...
3974 Image Name: 2.2.13 for NFS on TQM850L
3975 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3976 Data Size: 381681 Bytes = 372 kB = 0 MB
3977 Load Address: 00000000
3978 Entry Point: 0000000c
3979 Verifying Checksum ... OK
3980 Uncompressing Kernel Image ... OK
3981 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
3982 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3983 time_init: decrementer frequency = 187500000/60
3984 Calibrating delay loop... 49.77 BogoMIPS
3985 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3986 ...
wdenkc6097192002-11-03 00:24:07 +00003987
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003988If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003989the memory addresses of both the kernel and the initrd image (PPBCOOT
3990format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003993
wdenk2729af92004-05-03 20:45:30 +00003994 ## Checking Image at 40100000 ...
3995 Image Name: 2.2.13 for initrd on TQM850L
3996 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3997 Data Size: 335725 Bytes = 327 kB = 0 MB
3998 Load Address: 00000000
3999 Entry Point: 0000000c
4000 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004001
wdenk2729af92004-05-03 20:45:30 +00004002 ## Checking Image at 40200000 ...
4003 Image Name: Simple Ramdisk Image
4004 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4005 Data Size: 566530 Bytes = 553 kB = 0 MB
4006 Load Address: 00000000
4007 Entry Point: 00000000
4008 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004009
wdenk2729af92004-05-03 20:45:30 +00004010 => bootm 40100000 40200000
4011 ## Booting Linux kernel at 40100000 ...
4012 Image Name: 2.2.13 for initrd on TQM850L
4013 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4014 Data Size: 335725 Bytes = 327 kB = 0 MB
4015 Load Address: 00000000
4016 Entry Point: 0000000c
4017 Verifying Checksum ... OK
4018 Uncompressing Kernel Image ... OK
4019 ## Loading RAMDisk Image at 40200000 ...
4020 Image Name: Simple Ramdisk Image
4021 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4022 Data Size: 566530 Bytes = 553 kB = 0 MB
4023 Load Address: 00000000
4024 Entry Point: 00000000
4025 Verifying Checksum ... OK
4026 Loading Ramdisk ... OK
4027 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
4028 Boot arguments: root=/dev/ram
4029 time_init: decrementer frequency = 187500000/60
4030 Calibrating delay loop... 49.77 BogoMIPS
4031 ...
4032 RAMDISK: Compressed image found at block 0
4033 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk2729af92004-05-03 20:45:30 +00004035 bash#
wdenkc6097192002-11-03 00:24:07 +00004036
Matthew McClintock02677682006-06-28 10:41:37 -05004037Boot Linux and pass a flat device tree:
4038-----------
4039
4040First, U-Boot must be compiled with the appropriate defines. See the section
4041titled "Linux Kernel Interface" above for a more in depth explanation. The
4042following is an example of how to start a kernel and pass an updated
4043flat device tree:
4044
4045=> print oftaddr
4046oftaddr=0x300000
4047=> print oft
4048oft=oftrees/mpc8540ads.dtb
4049=> tftp $oftaddr $oft
4050Speed: 1000, full duplex
4051Using TSEC0 device
4052TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4053Filename 'oftrees/mpc8540ads.dtb'.
4054Load address: 0x300000
4055Loading: #
4056done
4057Bytes transferred = 4106 (100a hex)
4058=> tftp $loadaddr $bootfile
4059Speed: 1000, full duplex
4060Using TSEC0 device
4061TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4062Filename 'uImage'.
4063Load address: 0x200000
4064Loading:############
4065done
4066Bytes transferred = 1029407 (fb51f hex)
4067=> print loadaddr
4068loadaddr=200000
4069=> print oftaddr
4070oftaddr=0x300000
4071=> bootm $loadaddr - $oftaddr
4072## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004073 Image Name: Linux-2.6.17-dirty
4074 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4075 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004076 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004077 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004078 Verifying Checksum ... OK
4079 Uncompressing Kernel Image ... OK
4080Booting using flat device tree at 0x300000
4081Using MPC85xx ADS machine description
4082Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4083[snip]
4084
4085
wdenk2729af92004-05-03 20:45:30 +00004086More About U-Boot Image Types:
4087------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004088
wdenk2729af92004-05-03 20:45:30 +00004089U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004090
wdenk2729af92004-05-03 20:45:30 +00004091 "Standalone Programs" are directly runnable in the environment
4092 provided by U-Boot; it is expected that (if they behave
4093 well) you can continue to work in U-Boot after return from
4094 the Standalone Program.
4095 "OS Kernel Images" are usually images of some Embedded OS which
4096 will take over control completely. Usually these programs
4097 will install their own set of exception handlers, device
4098 drivers, set up the MMU, etc. - this means, that you cannot
4099 expect to re-enter U-Boot except by resetting the CPU.
4100 "RAMDisk Images" are more or less just data blocks, and their
4101 parameters (address, size) are passed to an OS kernel that is
4102 being started.
4103 "Multi-File Images" contain several images, typically an OS
4104 (Linux) kernel image and one or more data images like
4105 RAMDisks. This construct is useful for instance when you want
4106 to boot over the network using BOOTP etc., where the boot
4107 server provides just a single image file, but you want to get
4108 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004109
wdenk2729af92004-05-03 20:45:30 +00004110 "Multi-File Images" start with a list of image sizes, each
4111 image size (in bytes) specified by an "uint32_t" in network
4112 byte order. This list is terminated by an "(uint32_t)0".
4113 Immediately after the terminating 0 follow the images, one by
4114 one, all aligned on "uint32_t" boundaries (size rounded up to
4115 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004116
wdenk2729af92004-05-03 20:45:30 +00004117 "Firmware Images" are binary images containing firmware (like
4118 U-Boot or FPGA images) which usually will be programmed to
4119 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004120
wdenk2729af92004-05-03 20:45:30 +00004121 "Script files" are command sequences that will be executed by
4122 U-Boot's command interpreter; this feature is especially
4123 useful when you configure U-Boot to use a real shell (hush)
4124 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004125
wdenkc6097192002-11-03 00:24:07 +00004126
wdenk2729af92004-05-03 20:45:30 +00004127Standalone HOWTO:
4128=================
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk2729af92004-05-03 20:45:30 +00004130One of the features of U-Boot is that you can dynamically load and
4131run "standalone" applications, which can use some resources of
4132U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004135
wdenk2729af92004-05-03 20:45:30 +00004136"Hello World" Demo:
4137-------------------
wdenkc6097192002-11-03 00:24:07 +00004138
wdenk2729af92004-05-03 20:45:30 +00004139'examples/hello_world.c' contains a small "Hello World" Demo
4140application; it is automatically compiled when you build U-Boot.
4141It's configured to run at address 0x00040004, so you can play with it
4142like that:
wdenkc6097192002-11-03 00:24:07 +00004143
wdenk2729af92004-05-03 20:45:30 +00004144 => loads
4145 ## Ready for S-Record download ...
4146 ~>examples/hello_world.srec
4147 1 2 3 4 5 6 7 8 9 10 11 ...
4148 [file transfer complete]
4149 [connected]
4150 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004151
wdenk2729af92004-05-03 20:45:30 +00004152 => go 40004 Hello World! This is a test.
4153 ## Starting application at 0x00040004 ...
4154 Hello World
4155 argc = 7
4156 argv[0] = "40004"
4157 argv[1] = "Hello"
4158 argv[2] = "World!"
4159 argv[3] = "This"
4160 argv[4] = "is"
4161 argv[5] = "a"
4162 argv[6] = "test."
4163 argv[7] = "<NULL>"
4164 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004167
wdenk2729af92004-05-03 20:45:30 +00004168Another example, which demonstrates how to register a CPM interrupt
4169handler with the U-Boot code, can be found in 'examples/timer.c'.
4170Here, a CPM timer is set up to generate an interrupt every second.
4171The interrupt service routine is trivial, just printing a '.'
4172character, but this is just a demo program. The application can be
4173controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004174
wdenk2729af92004-05-03 20:45:30 +00004175 ? - print current values og the CPM Timer registers
4176 b - enable interrupts and start timer
4177 e - stop timer and disable interrupts
4178 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004179
wdenk2729af92004-05-03 20:45:30 +00004180 => loads
4181 ## Ready for S-Record download ...
4182 ~>examples/timer.srec
4183 1 2 3 4 5 6 7 8 9 10 11 ...
4184 [file transfer complete]
4185 [connected]
4186 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004187
wdenk2729af92004-05-03 20:45:30 +00004188 => go 40004
4189 ## Starting application at 0x00040004 ...
4190 TIMERS=0xfff00980
4191 Using timer 1
4192 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004193
wdenk2729af92004-05-03 20:45:30 +00004194Hit 'b':
4195 [q, b, e, ?] Set interval 1000000 us
4196 Enabling timer
4197Hit '?':
4198 [q, b, e, ?] ........
4199 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4200Hit '?':
4201 [q, b, e, ?] .
4202 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4203Hit '?':
4204 [q, b, e, ?] .
4205 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4206Hit '?':
4207 [q, b, e, ?] .
4208 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4209Hit 'e':
4210 [q, b, e, ?] ...Stopping timer
4211Hit 'q':
4212 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004213
4214
wdenk2729af92004-05-03 20:45:30 +00004215Minicom warning:
4216================
wdenk85ec0bc2003-03-31 16:34:49 +00004217
wdenk2729af92004-05-03 20:45:30 +00004218Over time, many people have reported problems when trying to use the
4219"minicom" terminal emulation program for serial download. I (wd)
4220consider minicom to be broken, and recommend not to use it. Under
4221Unix, I recommend to use C-Kermit for general purpose use (and
4222especially for kermit binary protocol download ("loadb" command), and
4223use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004224
wdenk2729af92004-05-03 20:45:30 +00004225Nevertheless, if you absolutely want to use it try adding this
4226configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004227
wdenk2729af92004-05-03 20:45:30 +00004228 Name Program Name U/D FullScr IO-Red. Multi
4229 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4230 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004231
4232
wdenk2729af92004-05-03 20:45:30 +00004233NetBSD Notes:
4234=============
wdenkc6097192002-11-03 00:24:07 +00004235
wdenk2729af92004-05-03 20:45:30 +00004236Starting at version 0.9.2, U-Boot supports NetBSD both as host
4237(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004238
wdenk2729af92004-05-03 20:45:30 +00004239Building requires a cross environment; it is known to work on
4240NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4241need gmake since the Makefiles are not compatible with BSD make).
4242Note that the cross-powerpc package does not install include files;
4243attempting to build U-Boot will fail because <machine/ansi.h> is
4244missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk2729af92004-05-03 20:45:30 +00004246 # cd /usr/pkg/cross/powerpc-netbsd/include
4247 # mkdir powerpc
4248 # ln -s powerpc machine
4249 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4250 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004251
wdenk2729af92004-05-03 20:45:30 +00004252Native builds *don't* work due to incompatibilities between native
4253and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004254
wdenk2729af92004-05-03 20:45:30 +00004255Booting assumes that (the first part of) the image booted is a
4256stage-2 loader which in turn loads and then invokes the kernel
4257proper. Loader sources will eventually appear in the NetBSD source
4258tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004259meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004260
4261
wdenk2729af92004-05-03 20:45:30 +00004262Implementation Internals:
4263=========================
wdenkc6097192002-11-03 00:24:07 +00004264
wdenk2729af92004-05-03 20:45:30 +00004265The following is not intended to be a complete description of every
4266implementation detail. However, it should help to understand the
4267inner workings of U-Boot and make it easier to port it to custom
4268hardware.
wdenkc6097192002-11-03 00:24:07 +00004269
4270
wdenk2729af92004-05-03 20:45:30 +00004271Initial Stack, Global Data:
4272---------------------------
wdenkc6097192002-11-03 00:24:07 +00004273
wdenk2729af92004-05-03 20:45:30 +00004274The implementation of U-Boot is complicated by the fact that U-Boot
4275starts running out of ROM (flash memory), usually without access to
4276system RAM (because the memory controller is not initialized yet).
4277This means that we don't have writable Data or BSS segments, and BSS
4278is not initialized as zero. To be able to get a C environment working
4279at all, we have to allocate at least a minimal stack. Implementation
4280options for this are defined and restricted by the CPU used: Some CPU
4281models provide on-chip memory (like the IMMR area on MPC8xx and
4282MPC826x processors), on others (parts of) the data cache can be
4283locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004284
Wolfgang Denk218ca722008-03-26 10:40:12 +01004285 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004286 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004287
wdenk2729af92004-05-03 20:45:30 +00004288 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4289 From: "Chris Hallinan" <clh@net1plus.com>
4290 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4291 ...
wdenk43d96162003-03-06 00:02:04 +00004292
wdenk2729af92004-05-03 20:45:30 +00004293 Correct me if I'm wrong, folks, but the way I understand it
4294 is this: Using DCACHE as initial RAM for Stack, etc, does not
4295 require any physical RAM backing up the cache. The cleverness
4296 is that the cache is being used as a temporary supply of
4297 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004298 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004299 can see how this works by studying the cache architecture and
4300 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004301
wdenk2729af92004-05-03 20:45:30 +00004302 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4303 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004304 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004305 option should work for you. Using CS 4 should be fine if your
4306 board designers haven't used it for something that would
4307 cause you grief during the initial boot! It is frequently not
4308 used.
wdenk43d96162003-03-06 00:02:04 +00004309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004310 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004311 with your processor/board/system design. The default value
4312 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004313 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004314 than your SDRAM module. If you have a 64MB SDRAM module, set
4315 it above 400_0000. Just make sure your board has no resources
4316 that are supposed to respond to that address! That code in
4317 start.S has been around a while and should work as is when
4318 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004319
wdenk2729af92004-05-03 20:45:30 +00004320 -Chris Hallinan
4321 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004322
wdenk2729af92004-05-03 20:45:30 +00004323It is essential to remember this, since it has some impact on the C
4324code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004325
wdenk2729af92004-05-03 20:45:30 +00004326* Initialized global data (data segment) is read-only. Do not attempt
4327 to write it.
wdenkc6097192002-11-03 00:24:07 +00004328
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004329* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004330 as zero data - BSS segment) at all - this is undefined, initiali-
4331 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004332
wdenk2729af92004-05-03 20:45:30 +00004333* Stack space is very limited. Avoid big data buffers or things like
4334 that.
wdenkc6097192002-11-03 00:24:07 +00004335
wdenk2729af92004-05-03 20:45:30 +00004336Having only the stack as writable memory limits means we cannot use
4337normal global data to share information beween the code. But it
4338turned out that the implementation of U-Boot can be greatly
4339simplified by making a global data structure (gd_t) available to all
4340functions. We could pass a pointer to this data as argument to _all_
4341functions, but this would bloat the code. Instead we use a feature of
4342the GCC compiler (Global Register Variables) to share the data: we
4343place a pointer (gd) to the global data into a register which we
4344reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004345
wdenk2729af92004-05-03 20:45:30 +00004346When choosing a register for such a purpose we are restricted by the
4347relevant (E)ABI specifications for the current architecture, and by
4348GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004349
wdenk2729af92004-05-03 20:45:30 +00004350For PowerPC, the following registers have specific use:
4351 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004352 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004353 R3-R4: parameter passing and return values
4354 R5-R10: parameter passing
4355 R13: small data area pointer
4356 R30: GOT pointer
4357 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004358
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004359 (U-Boot also uses R12 as internal GOT pointer. r12
4360 is a volatile register so r12 needs to be reset when
4361 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004362
Wolfgang Denke7670f62008-02-14 22:43:22 +01004363 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004364
wdenk2729af92004-05-03 20:45:30 +00004365 Note: on PPC, we could use a static initializer (since the
4366 address of the global data structure is known at compile time),
4367 but it turned out that reserving a register results in somewhat
4368 smaller code - although the code savings are not that big (on
4369 average for all boards 752 bytes for the whole U-Boot image,
4370 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004371
Robin Getzc4db3352009-08-17 15:23:02 +00004372On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004373 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4374
Robin Getzc4db3352009-08-17 15:23:02 +00004375 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004376
wdenk2729af92004-05-03 20:45:30 +00004377On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004378
wdenk2729af92004-05-03 20:45:30 +00004379 R0: function argument word/integer result
4380 R1-R3: function argument word
4381 R9: GOT pointer
4382 R10: stack limit (used only if stack checking if enabled)
4383 R11: argument (frame) pointer
4384 R12: temporary workspace
4385 R13: stack pointer
4386 R14: link register
4387 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004390
Thomas Chou0df01fd2010-05-21 11:08:03 +08004391On Nios II, the ABI is documented here:
4392 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4393
4394 ==> U-Boot will use gp to hold a pointer to the global data
4395
4396 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4397 to access small data sections, so gp is free.
4398
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004399NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4400or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk2729af92004-05-03 20:45:30 +00004402Memory Management:
4403------------------
wdenkc6097192002-11-03 00:24:07 +00004404
wdenk2729af92004-05-03 20:45:30 +00004405U-Boot runs in system state and uses physical addresses, i.e. the
4406MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004407
wdenk2729af92004-05-03 20:45:30 +00004408The available memory is mapped to fixed addresses using the memory
4409controller. In this process, a contiguous block is formed for each
4410memory type (Flash, SDRAM, SRAM), even when it consists of several
4411physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004412
wdenk2729af92004-05-03 20:45:30 +00004413U-Boot is installed in the first 128 kB of the first Flash bank (on
4414TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4415booting and sizing and initializing DRAM, the code relocates itself
4416to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004417memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004418configuration setting]. Below that, a structure with global Board
4419Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004420
wdenk2729af92004-05-03 20:45:30 +00004421Additionally, some exception handler code is copied to the low 8 kB
4422of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004423
wdenk2729af92004-05-03 20:45:30 +00004424So a typical memory configuration with 16 MB of DRAM could look like
4425this:
wdenkc6097192002-11-03 00:24:07 +00004426
wdenk2729af92004-05-03 20:45:30 +00004427 0x0000 0000 Exception Vector code
4428 :
4429 0x0000 1FFF
4430 0x0000 2000 Free for Application Use
4431 :
4432 :
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk2729af92004-05-03 20:45:30 +00004434 :
4435 :
4436 0x00FB FF20 Monitor Stack (Growing downward)
4437 0x00FB FFAC Board Info Data and permanent copy of global data
4438 0x00FC 0000 Malloc Arena
4439 :
4440 0x00FD FFFF
4441 0x00FE 0000 RAM Copy of Monitor Code
4442 ... eventually: LCD or video framebuffer
4443 ... eventually: pRAM (Protected RAM - unchanged by reset)
4444 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004445
4446
wdenk2729af92004-05-03 20:45:30 +00004447System Initialization:
4448----------------------
wdenkc6097192002-11-03 00:24:07 +00004449
wdenk2729af92004-05-03 20:45:30 +00004450In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004451(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004452configuration for CS0# this is a mirror of the onboard Flash memory.
4453To be able to re-map memory U-Boot then jumps to its link address.
4454To be able to implement the initialization code in C, a (small!)
4455initial stack is set up in the internal Dual Ported RAM (in case CPUs
4456which provide such a feature like MPC8xx or MPC8260), or in a locked
4457part of the data cache. After that, U-Boot initializes the CPU core,
4458the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004459
wdenk2729af92004-05-03 20:45:30 +00004460Next, all (potentially) available memory banks are mapped using a
4461preliminary mapping. For example, we put them on 512 MB boundaries
4462(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4463on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4464programmed for SDRAM access. Using the temporary configuration, a
4465simple memory test is run that determines the size of the SDRAM
4466banks.
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk2729af92004-05-03 20:45:30 +00004468When there is more than one SDRAM bank, and the banks are of
4469different size, the largest is mapped first. For equal size, the first
4470bank (CS2#) is mapped first. The first mapping is always for address
44710x00000000, with any additional banks following immediately to create
4472contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004473
wdenk2729af92004-05-03 20:45:30 +00004474Then, the monitor installs itself at the upper end of the SDRAM area
4475and allocates memory for use by malloc() and for the global Board
4476Info data; also, the exception vector code is copied to the low RAM
4477pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004478
wdenk2729af92004-05-03 20:45:30 +00004479Only after this relocation will you have a "normal" C environment;
4480until that you are restricted in several ways, mostly because you are
4481running from ROM, and because the code will have to be relocated to a
4482new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004483
4484
wdenk2729af92004-05-03 20:45:30 +00004485U-Boot Porting Guide:
4486----------------------
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk2729af92004-05-03 20:45:30 +00004488[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4489list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004490
4491
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004492int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004493{
4494 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004495
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004496 signal(SIGALRM, no_more_time);
4497 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004498
wdenk2729af92004-05-03 20:45:30 +00004499 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004500 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004501 return 0;
4502 }
4503
wdenk2729af92004-05-03 20:45:30 +00004504 Download latest U-Boot source;
4505
Wolfgang Denk06682362008-12-30 22:56:11 +01004506 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004507
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004508 if (clueless)
4509 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004510
wdenk2729af92004-05-03 20:45:30 +00004511 while (learning) {
4512 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004513 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4514 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004515 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004516 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004517 }
wdenkc6097192002-11-03 00:24:07 +00004518
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004519 if (available_money > toLocalCurrency ($2500))
4520 Buy a BDI3000;
4521 else
wdenk2729af92004-05-03 20:45:30 +00004522 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004523
4524 if (a similar board exists) { /* hopefully... */
4525 cp -a board/<similar> board/<myboard>
4526 cp include/configs/<similar>.h include/configs/<myboard>.h
4527 } else {
4528 Create your own board support subdirectory;
4529 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004530 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004531 Edit new board/<myboard> files
4532 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004533
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004534 while (!accepted) {
4535 while (!running) {
4536 do {
4537 Add / modify source code;
4538 } until (compiles);
4539 Debug;
4540 if (clueless)
4541 email("Hi, I am having problems...");
4542 }
4543 Send patch file to the U-Boot email list;
4544 if (reasonable critiques)
4545 Incorporate improvements from email list code review;
4546 else
4547 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004548 }
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk2729af92004-05-03 20:45:30 +00004550 return 0;
4551}
4552
4553void no_more_time (int sig)
4554{
4555 hire_a_guru();
4556}
wdenkc6097192002-11-03 00:24:07 +00004557
4558
wdenk2729af92004-05-03 20:45:30 +00004559Coding Standards:
4560-----------------
wdenkc6097192002-11-03 00:24:07 +00004561
wdenk2729af92004-05-03 20:45:30 +00004562All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004563coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004564"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004565
Detlev Zundel2c051652006-09-01 15:39:02 +02004566Source files originating from a different project (for example the
4567MTD subsystem) are generally exempt from these guidelines and are not
4568reformated to ease subsequent migration to newer versions of those
4569sources.
4570
4571Please note that U-Boot is implemented in C (and to some small parts in
4572Assembler); no C++ is used, so please do not use C++ style comments (//)
4573in your code.
wdenk2729af92004-05-03 20:45:30 +00004574
4575Please also stick to the following formatting rules:
4576- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004577- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004578- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004579- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004580- do not add trailing empty lines to source files
4581
4582Submissions which do not conform to the standards may be returned
4583with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004584
4585
wdenk2729af92004-05-03 20:45:30 +00004586Submitting Patches:
4587-------------------
wdenkc6097192002-11-03 00:24:07 +00004588
wdenk2729af92004-05-03 20:45:30 +00004589Since the number of patches for U-Boot is growing, we need to
4590establish some rules. Submissions which do not conform to these rules
4591may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004592
Magnus Lilja0d28f342008-08-06 19:32:33 +02004593Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004594
Wolfgang Denk06682362008-12-30 22:56:11 +01004595Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4596see http://lists.denx.de/mailman/listinfo/u-boot
4597
wdenk2729af92004-05-03 20:45:30 +00004598When you send a patch, please include the following information with
4599it:
wdenkc6097192002-11-03 00:24:07 +00004600
wdenk2729af92004-05-03 20:45:30 +00004601* For bug fixes: a description of the bug and how your patch fixes
4602 this bug. Please try to include a way of demonstrating that the
4603 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004604
wdenk2729af92004-05-03 20:45:30 +00004605* For new features: a description of the feature and your
4606 implementation.
wdenkc6097192002-11-03 00:24:07 +00004607
wdenk2729af92004-05-03 20:45:30 +00004608* A CHANGELOG entry as plaintext (separate from the patch)
4609
4610* For major contributions, your entry to the CREDITS file
4611
4612* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004613 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004614
4615* If your patch adds new configuration options, don't forget to
4616 document these in the README file.
4617
Wolfgang Denk218ca722008-03-26 10:40:12 +01004618* The patch itself. If you are using git (which is *strongly*
4619 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004620 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004621 the U-Boot mailing list, you will avoid most of the common problems
4622 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004623
Wolfgang Denk218ca722008-03-26 10:40:12 +01004624 If you cannot use git, use "diff -purN OLD NEW". If your version of
4625 diff does not support these options, then get the latest version of
4626 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004627
Wolfgang Denk218ca722008-03-26 10:40:12 +01004628 The current directory when running this command shall be the parent
4629 directory of the U-Boot source tree (i. e. please make sure that
4630 your patch includes sufficient directory information for the
4631 affected files).
4632
4633 We prefer patches as plain text. MIME attachments are discouraged,
4634 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004635
4636* If one logical set of modifications affects or creates several
4637 files, all these changes shall be submitted in a SINGLE patch file.
4638
4639* Changesets that contain different, unrelated modifications shall be
4640 submitted as SEPARATE patches, one patch per changeset.
4641
4642
4643Notes:
4644
4645* Before sending the patch, run the MAKEALL script on your patched
4646 source tree and make sure that no errors or warnings are reported
4647 for any of the boards.
4648
4649* Keep your modifications to the necessary minimum: A patch
4650 containing several unrelated changes or arbitrary reformats will be
4651 returned with a request to re-formatting / split it.
4652
4653* If you modify existing code, make sure that your new code does not
4654 add to the memory footprint of the code ;-) Small is beautiful!
4655 When adding new features, these should compile conditionally only
4656 (using #ifdef), and the resulting code with the new feature
4657 disabled must not need more memory than the old code without your
4658 modification.
wdenk90dc6702005-05-03 14:12:25 +00004659
Wolfgang Denk06682362008-12-30 22:56:11 +01004660* Remember that there is a size limit of 100 kB per message on the
4661 u-boot mailing list. Bigger patches will be moderated. If they are
4662 reasonable and not too big, they will be acknowledged. But patches
4663 bigger than the size limit should be avoided.