blob: 1b183141299cd6b32f96a40698801e378ece9c23 [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:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000137 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200138 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
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800184 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000186 /nds32 Files generic to NDS32 architecture
187 /cpu CPU specific files
188 /n1213 Files specific to Andes Technology N1213 CPUs
189 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /nios2 Files generic to Altera NIOS2 architecture
191 /cpu CPU specific files
192 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200193 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500194 /cpu CPU specific files
195 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
196 /mpc5xx Files specific to Freescale MPC5xx CPUs
197 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
198 /mpc8xx Files specific to Freescale MPC8xx CPUs
199 /mpc8220 Files specific to Freescale MPC8220 CPUs
200 /mpc824x Files specific to Freescale MPC824x CPUs
201 /mpc8260 Files specific to Freescale MPC8260 CPUs
202 /mpc85xx Files specific to Freescale MPC85xx CPUs
203 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
204 /lib Architecture specific library files
205 /sh Files generic to SH architecture
206 /cpu CPU specific files
207 /sh2 Files specific to sh2 CPUs
208 /sh3 Files specific to sh3 CPUs
209 /sh4 Files specific to sh4 CPUs
210 /lib Architecture specific library files
211 /sparc Files generic to SPARC architecture
212 /cpu CPU specific files
213 /leon2 Files specific to Gaisler LEON2 SPARC CPU
214 /leon3 Files specific to Gaisler LEON3 SPARC CPU
215 /lib Architecture specific library files
216/api Machine/arch independent API for external apps
217/board Board dependent files
218/common Misc architecture independent functions
219/disk Code for disk drive partition handling
220/doc Documentation (don't expect too much)
221/drivers Commonly used device drivers
222/examples Example code for standalone applications, etc.
223/fs Filesystem code (cramfs, ext2, jffs2, etc.)
224/include Header Files
225/lib Files generic to all architectures
226 /libfdt Library files to support flattened device trees
227 /lzma Library files to support LZMA decompression
228 /lzo Library files to support LZO decompression
229/net Networking code
230/post Power On Self Test
231/rtc Real Time Clock drivers
232/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000233
wdenkc6097192002-11-03 00:24:07 +0000234Software Configuration:
235=======================
236
237Configuration is usually done using C preprocessor defines; the
238rationale behind that is to avoid dead code whenever possible.
239
240There are two classes of configuration variables:
241
242* Configuration _OPTIONS_:
243 These are selectable by the user and have names beginning with
244 "CONFIG_".
245
246* Configuration _SETTINGS_:
247 These depend on the hardware etc. and should not be meddled with if
248 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200249 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000250
251Later we will add a configuration tool - probably similar to or even
252identical to what's used for the Linux kernel. Right now, we have to
253do the configuration by hand, which means creating some symbolic
254links and editing some configuration files. We use the TQM8xxL boards
255as an example here.
256
257
258Selection of Processor Architecture and Board Type:
259---------------------------------------------------
260
261For all supported boards there are ready-to-use default
262configurations available; just type "make <board_name>_config".
263
264Example: For a TQM823L module type:
265
266 cd u-boot
267 make TQM823L_config
268
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200269For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000270e.g. "make cogent_mpc8xx_config". And also configure the cogent
271directory according to the instructions in cogent/README.
272
273
274Configuration Options:
275----------------------
276
277Configuration depends on the combination of board and CPU type; all
278such information is kept in a configuration file
279"include/configs/<board_name>.h".
280
281Example: For a TQM823L module, all configuration settings are in
282"include/configs/TQM823L.h".
283
284
wdenk7f6c2cb2002-11-10 22:06:23 +0000285Many of the options are named exactly as the corresponding Linux
286kernel configuration options. The intention is to make it easier to
287build a config tool - later.
288
289
wdenkc6097192002-11-03 00:24:07 +0000290The following options need to be configured:
291
Kim Phillips26281142007-08-10 13:28:25 -0500292- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000293
Kim Phillips26281142007-08-10 13:28:25 -0500294- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200295
296- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100297 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000298
299- CPU Module Type: (if CONFIG_COGENT is defined)
300 Define exactly one of
301 CONFIG_CMA286_60_OLD
302--- FIXME --- not tested yet:
303 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304 CONFIG_CMA287_23, CONFIG_CMA287_50
305
306- Motherboard Type: (if CONFIG_COGENT is defined)
307 Define exactly one of
308 CONFIG_CMA101, CONFIG_CMA102
309
310- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311 Define one or more of
312 CONFIG_CMA302
313
314- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315 Define one or more of
316 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200317 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000318 a "rotator" |\-/|\-/
319
wdenk2535d602003-07-17 23:16:40 +0000320- Board flavour: (if CONFIG_MPC8260ADS is defined)
321 CONFIG_ADSTYPE
322 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200323 CONFIG_SYS_8260ADS - original MPC8260ADS
324 CONFIG_SYS_8266ADS - MPC8266ADS
325 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
326 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000327
Lei Wencf946c62011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
wdenkc6097192002-11-03 00:24:07 +0000333- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000334 Define exactly one of
335 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000336
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200337- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
339 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000340 e.g. if there is no 32KHz
341 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
343 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000344
wdenk66ca92a2004-09-28 17:59:53 +0000345- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_8xx_CPUCLK_MIN
347 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000348 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000349 See doc/README.MPC866
350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000352
wdenkba56f622004-02-06 23:19:44 +0000353 Define this to measure the actual CPU clock instead
354 of relying on the correctness of the configured
355 values. Mostly useful for board bringup to make sure
356 the PLL is locked at the intended frequency. Note
357 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200358 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000359
Heiko Schocher506f3912009-03-12 07:37:15 +0100360 CONFIG_SYS_DELAYED_ICACHE
361
362 Define this option if you want to enable the
363 ICache only when Code runs from RAM.
364
Kumar Gala66412c62011-02-18 05:40:54 -0600365- 85xx CPU Options:
366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala8f290842011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100377- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200378 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100379
380 Defines the Monahans run mode to oscillator
381 ratio. Valid values are 8, 16, 24, 31. The core
382 frequency is this value multiplied by 13 MHz.
383
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200384 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200385
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100386 Defines the Monahans turbo mode to oscillator
387 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200388 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100389 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200390
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200391- MIPS CPU options:
392 CONFIG_SYS_INIT_SP_OFFSET
393
394 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
395 pointer. This is needed for the temporary stack before
396 relocation.
397
398 CONFIG_SYS_MIPS_CACHE_MODE
399
400 Cache operation mode for the MIPS CPU.
401 See also arch/mips/include/asm/mipsregs.h.
402 Possible values are:
403 CONF_CM_CACHABLE_NO_WA
404 CONF_CM_CACHABLE_WA
405 CONF_CM_UNCACHED
406 CONF_CM_CACHABLE_NONCOHERENT
407 CONF_CM_CACHABLE_CE
408 CONF_CM_CACHABLE_COW
409 CONF_CM_CACHABLE_CUW
410 CONF_CM_CACHABLE_ACCELERATED
411
412 CONFIG_SYS_XWAY_EBU_BOOTCFG
413
414 Special option for Lantiq XWAY SoCs for booting from NOR flash.
415 See also arch/mips/cpu/mips32/start.S.
416
417 CONFIG_XWAY_SWAP_BYTES
418
419 Enable compilation of tools/xway-swap-bytes needed for Lantiq
420 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
421 be swapped if a flash programmer is used.
422
wdenk5da627a2003-10-09 20:09:04 +0000423- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000424 CONFIG_CLOCKS_IN_MHZ
425
426 U-Boot stores all clock information in Hz
427 internally. For binary compatibility with older Linux
428 kernels (which expect the clocks passed in the
429 bd_info data to be in MHz) the environment variable
430 "clocks_in_mhz" can be defined so that U-Boot
431 converts clock data to MHZ before passing it to the
432 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000433 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100434 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000435 default environment.
436
wdenk5da627a2003-10-09 20:09:04 +0000437 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
438
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200439 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000440 expect it to be in bytes, others in MB.
441 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
442
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400443 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200444
445 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400446 passed using flattened device trees (based on open firmware
447 concepts).
448
449 CONFIG_OF_LIBFDT
450 * New libfdt-based support
451 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500452 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400453
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200454 OF_CPU - The proper name of the cpus node (only required for
455 MPC512X and MPC5xxx based boards).
456 OF_SOC - The proper name of the soc node (only required for
457 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200458 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600459 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200460
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200461 boards with QUICC Engines require OF_QE to set UCC MAC
462 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500463
Kumar Gala4e253132006-01-11 13:54:17 -0600464 CONFIG_OF_BOARD_SETUP
465
466 Board code has addition modification that it wants to make
467 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000468
Matthew McClintock02677682006-06-28 10:41:37 -0500469 CONFIG_OF_BOOT_CPU
470
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200471 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500472 param header, the default value is zero if undefined.
473
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200474 CONFIG_OF_IDE_FIXUP
475
476 U-Boot can detect if an IDE device is present or not.
477 If not, and this new config option is activated, U-Boot
478 removes the ATA node from the DTS before booting Linux,
479 so the Linux IDE driver does not probe the device and
480 crash. This is needed for buggy hardware (uc101) where
481 no pull down resistor is connected to the signal IDE5V_DD7.
482
Igor Grinberg7eb29392011-07-14 05:45:07 +0000483 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
484
485 This setting is mandatory for all boards that have only one
486 machine type and must be used to specify the machine type
487 number as it appears in the ARM machine registry
488 (see http://www.arm.linux.org.uk/developer/machines/).
489 Only boards that have multiple machine types supported
490 in a single configuration file and the machine type is
491 runtime discoverable, do not have to use this setting.
492
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100493- vxWorks boot parameters:
494
495 bootvx constructs a valid bootline using the following
496 environments variables: bootfile, ipaddr, serverip, hostname.
497 It loads the vxWorks image pointed bootfile.
498
499 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
500 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
501 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
502 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
503
504 CONFIG_SYS_VXWORKS_ADD_PARAMS
505
506 Add it at the end of the bootline. E.g "u=username pw=secret"
507
508 Note: If a "bootargs" environment is defined, it will overwride
509 the defaults discussed just above.
510
Aneesh V2c451f72011-06-16 23:30:47 +0000511- Cache Configuration:
512 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
513 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
514 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
515
Aneesh V93bc2192011-06-16 23:30:51 +0000516- Cache Configuration for ARM:
517 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
518 controller
519 CONFIG_SYS_PL310_BASE - Physical base address of PL310
520 controller register space
521
wdenk6705d812004-08-02 23:22:59 +0000522- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200523 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000524
525 Define this if you want support for Amba PrimeCell PL010 UARTs.
526
Andreas Engel48d01922008-09-08 14:30:53 +0200527 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000528
529 Define this if you want support for Amba PrimeCell PL011 UARTs.
530
531 CONFIG_PL011_CLOCK
532
533 If you have Amba PrimeCell PL011 UARTs, set this variable to
534 the clock speed of the UARTs.
535
536 CONFIG_PL01x_PORTS
537
538 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
539 define this to a list of base addresses for each (supported)
540 port. See e.g. include/configs/versatile.h
541
John Rigby910f1ae2011-04-19 10:42:39 +0000542 CONFIG_PL011_SERIAL_RLCR
543
544 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
545 have separate receive and transmit line control registers. Set
546 this variable to initialize the extra register.
547
548 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
549
550 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
551 boot loader that has already initialized the UART. Define this
552 variable to flush the UART at init time.
553
wdenk6705d812004-08-02 23:22:59 +0000554
wdenkc6097192002-11-03 00:24:07 +0000555- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000556 Depending on board, define exactly one serial port
557 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
558 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
559 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000560
561 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
562 port routines must be defined elsewhere
563 (i.e. serial_init(), serial_getc(), ...)
564
565 CONFIG_CFB_CONSOLE
566 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000567 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000568 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
569 (default big endian)
570 VIDEO_HW_RECTFILL graphic chip supports
571 rectangle fill
572 (cf. smiLynxEM)
573 VIDEO_HW_BITBLT graphic chip supports
574 bit-blit (cf. smiLynxEM)
575 VIDEO_VISIBLE_COLS visible pixel columns
576 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000577 VIDEO_VISIBLE_ROWS visible pixel rows
578 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000579 VIDEO_DATA_FORMAT graphic data format
580 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000581 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000582 VIDEO_KBD_INIT_FCT keyboard int fct
583 (i.e. i8042_kbd_init())
584 VIDEO_TSTC_FCT test char fct
585 (i.e. i8042_tstc)
586 VIDEO_GETC_FCT get char fct
587 (i.e. i8042_getc)
588 CONFIG_CONSOLE_CURSOR cursor drawing on/off
589 (requires blink timer
590 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200591 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000592 CONFIG_CONSOLE_TIME display time/date info in
593 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500594 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000595 CONFIG_VIDEO_LOGO display Linux logo in
596 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000597 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
598 linux_logo.h for logo.
599 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000600 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200601 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000602 the logo
603
wdenk43d96162003-03-06 00:02:04 +0000604 When CONFIG_CFB_CONSOLE is defined, video console is
605 default i/o. Serial console can be forced with
606 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000607
wdenkd4ca31c2004-01-02 14:00:00 +0000608 When CONFIG_SILENT_CONSOLE is defined, all console
609 messages (by U-Boot and Linux!) can be silenced with
610 the "silent" environment variable. See
611 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000612
wdenkc6097192002-11-03 00:24:07 +0000613- Console Baudrate:
614 CONFIG_BAUDRATE - in bps
615 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200616 CONFIG_SYS_BAUDRATE_TABLE, see below.
617 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000618
Heiko Schocherc92fac92009-01-30 12:55:38 +0100619- Console Rx buffer length
620 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
621 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100622 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100623 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
624 must be defined, to setup the maximum idle timeout for
625 the SMC.
626
Graeme Russ9558b482011-09-01 00:48:27 +0000627- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200628 Prior to the console being initialised (i.e. serial UART
629 initialised etc) all console output is silently discarded.
630 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
631 buffer any console messages prior to the console being
632 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
633 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
634 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200635 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200636 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000637
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200638 'Sane' compilers will generate smaller code if
639 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000640
Simon Glass295d3942011-10-18 13:43:20 +0000641- Pre-console putc():
642 Prior to the console being initialised, console output is
643 normally silently discarded. This can be annoying if a
644 panic() happens in this time.
645
646 If the CONFIG_PRE_CONSOLE_PUTC option is defined, then
647 U-Boot will call board_pre_console_putc() for each output
648 character in this case, This function should try to output
649 the character if possible, perhaps on all available UARTs
650 (it will need to do this directly, since the console code
651 is not functional yet). Note that if the panic happens
652 early enough, then it is possible that board_init_f()
653 (or even arch_cpu_init() on ARM) has not been called yet.
654 You should init all clocks, GPIOs, etc. that are needed
655 to get the character out. Baud rates will need to default
656 to something sensible.
657
wdenkc6097192002-11-03 00:24:07 +0000658- Boot Delay: CONFIG_BOOTDELAY - in seconds
659 Delay before automatically booting the default image;
660 set to -1 to disable autoboot.
661
662 See doc/README.autoboot for these options that
663 work with CONFIG_BOOTDELAY. None are required.
664 CONFIG_BOOT_RETRY_TIME
665 CONFIG_BOOT_RETRY_MIN
666 CONFIG_AUTOBOOT_KEYED
667 CONFIG_AUTOBOOT_PROMPT
668 CONFIG_AUTOBOOT_DELAY_STR
669 CONFIG_AUTOBOOT_STOP_STR
670 CONFIG_AUTOBOOT_DELAY_STR2
671 CONFIG_AUTOBOOT_STOP_STR2
672 CONFIG_ZERO_BOOTDELAY_CHECK
673 CONFIG_RESET_TO_RETRY
674
675- Autoboot Command:
676 CONFIG_BOOTCOMMAND
677 Only needed when CONFIG_BOOTDELAY is enabled;
678 define a command string that is automatically executed
679 when no character is read on the console interface
680 within "Boot Delay" after reset.
681
682 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000683 This can be used to pass arguments to the bootm
684 command. The value of CONFIG_BOOTARGS goes into the
685 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000686
687 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000688 The value of these goes into the environment as
689 "ramboot" and "nfsboot" respectively, and can be used
690 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200691 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000692
693- Pre-Boot Commands:
694 CONFIG_PREBOOT
695
696 When this option is #defined, the existence of the
697 environment variable "preboot" will be checked
698 immediately before starting the CONFIG_BOOTDELAY
699 countdown and/or running the auto-boot command resp.
700 entering interactive mode.
701
702 This feature is especially useful when "preboot" is
703 automatically generated or modified. For an example
704 see the LWMON board specific code: here "preboot" is
705 modified when the user holds down a certain
706 combination of keys on the (special) keyboard when
707 booting the systems
708
709- Serial Download Echo Mode:
710 CONFIG_LOADS_ECHO
711 If defined to 1, all characters received during a
712 serial download (using the "loads" command) are
713 echoed back. This might be needed by some terminal
714 emulations (like "cu"), but may as well just take
715 time on others. This setting #define's the initial
716 value of the "loads_echo" environment variable.
717
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500718- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000719 CONFIG_KGDB_BAUDRATE
720 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200721 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000722
723- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500724 Monitor commands can be included or excluded
725 from the build by using the #include files
726 "config_cmd_all.h" and #undef'ing unwanted
727 commands, or using "config_cmd_default.h"
728 and augmenting with additional #define's
729 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000730
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500731 The default command configuration includes all commands
732 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000733
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500734 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500735 CONFIG_CMD_BDI bdinfo
736 CONFIG_CMD_BEDBUG * Include BedBug Debugger
737 CONFIG_CMD_BMP * BMP support
738 CONFIG_CMD_BSP * Board specific commands
739 CONFIG_CMD_BOOTD bootd
740 CONFIG_CMD_CACHE * icache, dcache
741 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500742 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500743 CONFIG_CMD_DATE * support for RTC, date/time...
744 CONFIG_CMD_DHCP * DHCP support
745 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600746 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
747 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
748 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
749 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500750 CONFIG_CMD_DTT * Digital Therm and Thermostat
751 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500752 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500753 CONFIG_CMD_EEPROM * EEPROM read/write support
754 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500755 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500756 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500757 CONFIG_CMD_FDC * Floppy Disk Support
758 CONFIG_CMD_FAT * FAT partition support
759 CONFIG_CMD_FDOS * Dos diskette Support
760 CONFIG_CMD_FLASH flinfo, erase, protect
761 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500762 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000763 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500764 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
765 CONFIG_CMD_I2C * I2C serial bus support
766 CONFIG_CMD_IDE * IDE harddisk support
767 CONFIG_CMD_IMI iminfo
768 CONFIG_CMD_IMLS List all found images
769 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500770 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500771 CONFIG_CMD_IRQ * irqinfo
772 CONFIG_CMD_ITEST Integer/string test of 2 values
773 CONFIG_CMD_JFFS2 * JFFS2 Support
774 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500775 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500776 CONFIG_CMD_LOADB loadb
777 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400778 CONFIG_CMD_MD5SUM print md5 message digest
779 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500780 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
781 loop, loopw, mtest
782 CONFIG_CMD_MISC Misc functions like sleep etc
783 CONFIG_CMD_MMC * MMC memory mapped support
784 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100785 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500786 CONFIG_CMD_NAND * NAND support
787 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600788 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000789 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500790 CONFIG_CMD_PCI * pciinfo
791 CONFIG_CMD_PCMCIA * PCMCIA support
792 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
793 host
794 CONFIG_CMD_PORTIO * Port I/O
795 CONFIG_CMD_REGINFO * Register dump
796 CONFIG_CMD_RUN run command in env variable
797 CONFIG_CMD_SAVES * save S record dump
798 CONFIG_CMD_SCSI * SCSI Support
799 CONFIG_CMD_SDRAM * print SDRAM configuration information
800 (requires CONFIG_CMD_I2C)
801 CONFIG_CMD_SETGETDCR Support for DCR Register access
802 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100803 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400804 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200805 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500806 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000807 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000808 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000809 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500810 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500811 CONFIG_CMD_CDP * Cisco Discover Protocol support
812 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000813
wdenkc6097192002-11-03 00:24:07 +0000814
815 EXAMPLE: If you want all functions except of network
816 support you can write:
817
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500818 #include "config_cmd_all.h"
819 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000820
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400821 Other Commands:
822 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000823
824 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500825 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000826 what you (and your U-Boot users) are doing. Data
827 cache cannot be enabled on systems like the 8xx or
828 8260 (where accesses to the IMMR region must be
829 uncached), and it cannot be disabled on all other
830 systems where we (mis-) use the data cache to hold an
831 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000832
833
834 XXX - this list needs to get updated!
835
Simon Glass45ba8072011-10-15 05:48:20 +0000836- Device tree:
837 CONFIG_OF_CONTROL
838 If this variable is defined, U-Boot will use a device tree
839 to configure its devices, instead of relying on statically
840 compiled #defines in the board file. This option is
841 experimental and only available on a few boards. The device
842 tree is available in the global data as gd->fdt_blob.
843
Simon Glass2c0f79e2011-10-24 19:15:31 +0000844 U-Boot needs to get its device tree from somewhere. This can
845 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000846
847 CONFIG_OF_EMBED
848 If this variable is defined, U-Boot will embed a device tree
849 binary in its image. This device tree file should be in the
850 board directory and called <soc>-<board>.dts. The binary file
851 is then picked up in board_init_f() and made available through
852 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000853
Simon Glass2c0f79e2011-10-24 19:15:31 +0000854 CONFIG_OF_SEPARATE
855 If this variable is defined, U-Boot will build a device tree
856 binary. It will be called u-boot.dtb. Architecture-specific
857 code will locate it at run-time. Generally this works by:
858
859 cat u-boot.bin u-boot.dtb >image.bin
860
861 and in fact, U-Boot does this for you, creating a file called
862 u-boot-dtb.bin which is useful in the common case. You can
863 still use the individual files if you need something more
864 exotic.
865
wdenkc6097192002-11-03 00:24:07 +0000866- Watchdog:
867 CONFIG_WATCHDOG
868 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000869 support for the SoC. There must be support in the SoC
870 specific code for a watchdog. For the 8xx and 8260
871 CPUs, the SIU Watchdog feature is enabled in the SYPCR
872 register. When supported for a specific SoC is
873 available, then no further board specific code should
874 be needed to use it.
875
876 CONFIG_HW_WATCHDOG
877 When using a watchdog circuitry external to the used
878 SoC, then define this variable and provide board
879 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000880
stroesec1551ea2003-04-04 15:53:41 +0000881- U-Boot Version:
882 CONFIG_VERSION_VARIABLE
883 If this variable is defined, an environment variable
884 named "ver" is created by U-Boot showing the U-Boot
885 version as printed by the "version" command.
886 This variable is readonly.
887
wdenkc6097192002-11-03 00:24:07 +0000888- Real-Time Clock:
889
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500890 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000891 has to be selected, too. Define exactly one of the
892 following options:
893
894 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
895 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000896 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000897 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000898 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000899 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000900 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000901 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100902 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000903 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200904 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200905 CONFIG_SYS_RV3029_TCR - enable trickle charger on
906 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000907
wdenkb37c7e52003-06-30 16:24:52 +0000908 Note that if the RTC uses I2C, then the I2C interface
909 must also be configured. See I2C Support, below.
910
Peter Tysere92739d2008-12-17 16:36:21 -0600911- GPIO Support:
912 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
913 CONFIG_PCA953X_INFO - enable pca953x info command
914
Chris Packham5dec49c2010-12-19 10:12:13 +0000915 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
916 chip-ngpio pairs that tell the PCA953X driver the number of
917 pins supported by a particular chip.
918
Peter Tysere92739d2008-12-17 16:36:21 -0600919 Note that if the GPIO device uses I2C, then the I2C interface
920 must also be configured. See I2C Support, below.
921
wdenkc6097192002-11-03 00:24:07 +0000922- Timestamp Support:
923
wdenk43d96162003-03-06 00:02:04 +0000924 When CONFIG_TIMESTAMP is selected, the timestamp
925 (date and time) of an image is printed by image
926 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500927 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000928
929- Partition Support:
930 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400931 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000932
Wolfgang Denk218ca722008-03-26 10:40:12 +0100933 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
934 CONFIG_CMD_SCSI) you must configure support for at
935 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000936
937- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000938 CONFIG_IDE_RESET_ROUTINE - this is defined in several
939 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000940
wdenk4d13cba2004-03-14 14:09:05 +0000941 CONFIG_IDE_RESET - is this is defined, IDE Reset will
942 be performed by calling the function
943 ide_set_reset(int reset)
944 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000945
946- ATAPI Support:
947 CONFIG_ATAPI
948
949 Set this to enable ATAPI support.
950
wdenkc40b2952004-03-13 23:29:43 +0000951- LBA48 Support
952 CONFIG_LBA48
953
954 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100955 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000956 Whithout these , LBA48 support uses 32bit variables and will 'only'
957 support disks up to 2.1TB.
958
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200959 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000960 When enabled, makes the IDE subsystem use 64bit sector addresses.
961 Default is 32bit.
962
wdenkc6097192002-11-03 00:24:07 +0000963- SCSI Support:
964 At the moment only there is only support for the
965 SYM53C8XX SCSI controller; define
966 CONFIG_SCSI_SYM53C8XX to enable it.
967
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200968 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
969 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
970 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000971 maximum numbers of LUNs, SCSI ID's and target
972 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200973 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000974
975- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000976 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000977 Support for Intel 8254x/8257x gigabit chips.
978
979 CONFIG_E1000_SPI
980 Utility code for direct access to the SPI bus on Intel 8257x.
981 This does not do anything useful unless you set at least one
982 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
983
984 CONFIG_E1000_SPI_GENERIC
985 Allow generic access to the SPI bus on the Intel 8257x, for
986 example with the "sspi" command.
987
988 CONFIG_CMD_E1000
989 Management command for E1000 devices. When used on devices
990 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +0000991
Andre Schwarzac3315c2008-03-06 16:45:44 +0100992 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200993 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100994
wdenkc6097192002-11-03 00:24:07 +0000995 CONFIG_EEPRO100
996 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200997 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000998 write routine for first time initialisation.
999
1000 CONFIG_TULIP
1001 Support for Digital 2114x chips.
1002 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1003 modem chip initialisation (KS8761/QS6611).
1004
1005 CONFIG_NATSEMI
1006 Support for National dp83815 chips.
1007
1008 CONFIG_NS8382X
1009 Support for National dp8382[01] gigabit chips.
1010
wdenk45219c42003-05-12 21:50:16 +00001011- NETWORK Support (other):
1012
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001013 CONFIG_DRIVER_AT91EMAC
1014 Support for AT91RM9200 EMAC.
1015
1016 CONFIG_RMII
1017 Define this to use reduced MII inteface
1018
1019 CONFIG_DRIVER_AT91EMAC_QUIET
1020 If this defined, the driver is quiet.
1021 The driver doen't show link status messages.
1022
Rob Herring03b15d22011-04-04 23:52:36 -05001023 CONFIG_CALXEDA_XGMAC
1024 Support for the Calxeda XGMAC device
1025
wdenk45219c42003-05-12 21:50:16 +00001026 CONFIG_DRIVER_LAN91C96
1027 Support for SMSC's LAN91C96 chips.
1028
1029 CONFIG_LAN91C96_BASE
1030 Define this to hold the physical address
1031 of the LAN91C96's I/O space
1032
1033 CONFIG_LAN91C96_USE_32_BIT
1034 Define this to enable 32 bit addressing
1035
wdenkf39748a2004-06-09 13:37:52 +00001036 CONFIG_DRIVER_SMC91111
1037 Support for SMSC's LAN91C111 chip
1038
1039 CONFIG_SMC91111_BASE
1040 Define this to hold the physical address
1041 of the device (I/O space)
1042
1043 CONFIG_SMC_USE_32_BIT
1044 Define this if data bus is 32 bits
1045
1046 CONFIG_SMC_USE_IOFUNCS
1047 Define this to use i/o functions instead of macros
1048 (some hardware wont work with macros)
1049
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001050 CONFIG_DRIVER_TI_EMAC
1051 Support for davinci emac
1052
1053 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1054 Define this if you have more then 3 PHYs.
1055
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001056 CONFIG_FTGMAC100
1057 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1058
1059 CONFIG_FTGMAC100_EGIGA
1060 Define this to use GE link update with gigabit PHY.
1061 Define this if FTGMAC100 is connected to gigabit PHY.
1062 If your system has 10/100 PHY only, it might not occur
1063 wrong behavior. Because PHY usually return timeout or
1064 useless data when polling gigabit status and gigabit
1065 control registers. This behavior won't affect the
1066 correctnessof 10/100 link speed update.
1067
Mike Rapoportc2fff332009-11-11 10:03:03 +02001068 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001069 Support for SMSC's LAN911x and LAN921x chips
1070
Mike Rapoportc2fff332009-11-11 10:03:03 +02001071 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001072 Define this to hold the physical address
1073 of the device (I/O space)
1074
Mike Rapoportc2fff332009-11-11 10:03:03 +02001075 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001076 Define this if data bus is 32 bits
1077
Mike Rapoportc2fff332009-11-11 10:03:03 +02001078 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001079 Define this if data bus is 16 bits. If your processor
1080 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001081 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001082
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001083 CONFIG_SH_ETHER
1084 Support for Renesas on-chip Ethernet controller
1085
1086 CONFIG_SH_ETHER_USE_PORT
1087 Define the number of ports to be used
1088
1089 CONFIG_SH_ETHER_PHY_ADDR
1090 Define the ETH PHY's address
1091
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001092 CONFIG_SH_ETHER_CACHE_WRITEBACK
1093 If this option is set, the driver enables cache flush.
1094
Vadim Bendebury5e124722011-10-17 08:36:14 +00001095- TPM Support:
1096 CONFIG_GENERIC_LPC_TPM
1097 Support for generic parallel port TPM devices. Only one device
1098 per system is supported at this time.
1099
1100 CONFIG_TPM_TIS_BASE_ADDRESS
1101 Base address where the generic TPM device is mapped
1102 to. Contemporary x86 systems usually map it at
1103 0xfed40000.
1104
wdenkc6097192002-11-03 00:24:07 +00001105- USB Support:
1106 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001107 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001108 CONFIG_USB_UHCI to enable it.
1109 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001110 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001111 storage devices.
1112 Note:
1113 Supported are USB Keyboards and USB Floppy drives
1114 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001115 MPC5200 USB requires additional defines:
1116 CONFIG_USB_CLOCK
1117 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001118 CONFIG_PSC3_USB
1119 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001120 CONFIG_USB_CONFIG
1121 for differential drivers: 0x00001000
1122 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001123 for differential drivers on PSC3: 0x00000100
1124 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001125 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001126 May be defined to allow interrupt polling
1127 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001128
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001129- USB Device:
1130 Define the below if you wish to use the USB console.
1131 Once firmware is rebuilt from a serial console issue the
1132 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001133 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001134 it has found a new device. The environment variable usbtty
1135 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001136 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001137 Common Device Class Abstract Control Model serial device.
1138 If you select usbtty = gserial you should be able to enumerate
1139 a Linux host by
1140 # modprobe usbserial vendor=0xVendorID product=0xProductID
1141 else if using cdc_acm, simply setting the environment
1142 variable usbtty to be cdc_acm should suffice. The following
1143 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001144
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001145 CONFIG_USB_DEVICE
1146 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001147
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001148 CONFIG_USB_TTY
1149 Define this to have a tty type of device available to
1150 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001152 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001153 Define this if you want stdin, stdout &/or stderr to
1154 be set to usbtty.
1155
1156 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001157 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001158 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001159 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001160
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001161 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001162 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001163 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001164
Wolfgang Denk386eda02006-06-14 18:14:56 +02001165 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001166 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001167 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001168 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1169 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1170 should pretend to be a Linux device to it's target host.
1171
1172 CONFIG_USBD_MANUFACTURER
1173 Define this string as the name of your company for
1174 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001175
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001176 CONFIG_USBD_PRODUCT_NAME
1177 Define this string as the name of your product
1178 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1179
1180 CONFIG_USBD_VENDORID
1181 Define this as your assigned Vendor ID from the USB
1182 Implementors Forum. This *must* be a genuine Vendor ID
1183 to avoid polluting the USB namespace.
1184 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001185
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001186 CONFIG_USBD_PRODUCTID
1187 Define this as the unique Product ID
1188 for your device
1189 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001190
Igor Grinbergd70a5602011-12-12 12:08:35 +02001191- ULPI Layer Support:
1192 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1193 the generic ULPI layer. The generic layer accesses the ULPI PHY
1194 via the platform viewport, so you need both the genric layer and
1195 the viewport enabled. Currently only Chipidea/ARC based
1196 viewport is supported.
1197 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1198 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
wdenkc6097192002-11-03 00:24:07 +00001199
1200- MMC Support:
1201 The MMC controller on the Intel PXA is supported. To
1202 enable this define CONFIG_MMC. The MMC can be
1203 accessed from the boot prompt by mapping the device
1204 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001205 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1206 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001207
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001208 CONFIG_SH_MMCIF
1209 Support for Renesas on-chip MMCIF controller
1210
1211 CONFIG_SH_MMCIF_ADDR
1212 Define the base address of MMCIF registers
1213
1214 CONFIG_SH_MMCIF_CLK
1215 Define the clock frequency for MMCIF
1216
wdenk6705d812004-08-02 23:22:59 +00001217- Journaling Flash filesystem support:
1218 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1219 CONFIG_JFFS2_NAND_DEV
1220 Define these for a default partition on a NAND device
1221
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001222 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1223 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001224 Define these for a default partition on a NOR device
1225
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001226 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001227 Define this to create an own partition. You have to provide a
1228 function struct part_info* jffs2_part_info(int part_num)
1229
1230 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001231 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001232 to disable the command chpart. This is the default when you
1233 have not defined a custom partition
1234
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001235- FAT(File Allocation Table) filesystem write function support:
1236 CONFIG_FAT_WRITE
1237 Support for saving memory data as a file
1238 in FAT formatted partition
1239
wdenkc6097192002-11-03 00:24:07 +00001240- Keyboard Support:
1241 CONFIG_ISA_KEYBOARD
1242
1243 Define this to enable standard (PC-Style) keyboard
1244 support
1245
1246 CONFIG_I8042_KBD
1247 Standard PC keyboard driver with US (is default) and
1248 GERMAN key layout (switch via environment 'keymap=de') support.
1249 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1250 for cfb_console. Supports cursor blinking.
1251
1252- Video support:
1253 CONFIG_VIDEO
1254
1255 Define this to enable video support (for output to
1256 video).
1257
1258 CONFIG_VIDEO_CT69000
1259
1260 Enable Chips & Technologies 69000 Video chip
1261
1262 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001263 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001264 video output is selected via environment 'videoout'
1265 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1266 assumed.
wdenkc6097192002-11-03 00:24:07 +00001267
wdenkb79a11c2004-03-25 15:14:43 +00001268 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001269 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001270 are possible:
1271 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001272 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001273
1274 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1275 -------------+---------------------------------------------
1276 8 bits | 0x301* 0x303 0x305 0x161 0x307
1277 15 bits | 0x310 0x313 0x316 0x162 0x319
1278 16 bits | 0x311 0x314 0x317 0x163 0x31A
1279 24 bits | 0x312 0x315 0x318 ? 0x31B
1280 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001281 (i.e. setenv videomode 317; saveenv; reset;)
1282
wdenkb79a11c2004-03-25 15:14:43 +00001283 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001284 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001285
1286
stroesec1551ea2003-04-04 15:53:41 +00001287 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001288 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001289 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1290 or CONFIG_VIDEO_SED13806_16BPP
1291
Timur Tabi7d3053f2011-02-15 17:09:19 -06001292 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001293 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001294 SOCs that have a DIU should define this macro to enable DIU
1295 support, and should also define these other macros:
1296
1297 CONFIG_SYS_DIU_ADDR
1298 CONFIG_VIDEO
1299 CONFIG_CMD_BMP
1300 CONFIG_CFB_CONSOLE
1301 CONFIG_VIDEO_SW_CURSOR
1302 CONFIG_VGA_AS_SINGLE_DEVICE
1303 CONFIG_VIDEO_LOGO
1304 CONFIG_VIDEO_BMP_LOGO
1305
Timur Tabiba8e76b2011-04-11 14:18:22 -05001306 The DIU driver will look for the 'video-mode' environment
1307 variable, and if defined, enable the DIU as a console during
1308 boot. See the documentation file README.video for a
1309 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001310
wdenk682011f2003-06-03 23:54:09 +00001311- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001312 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001313
wdenk8bde7f72003-06-27 21:31:46 +00001314 Define this to enable a custom keyboard support.
1315 This simply calls drv_keyboard_init() which must be
1316 defined in your board-specific files.
1317 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001318
wdenkc6097192002-11-03 00:24:07 +00001319- LCD Support: CONFIG_LCD
1320
1321 Define this to enable LCD support (for output to LCD
1322 display); also select one of the supported displays
1323 by defining one of these:
1324
Stelian Pop39cf4802008-05-09 21:57:18 +02001325 CONFIG_ATMEL_LCD:
1326
1327 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1328
wdenkfd3103b2003-11-25 16:55:19 +00001329 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001330
wdenkfd3103b2003-11-25 16:55:19 +00001331 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001332
wdenkfd3103b2003-11-25 16:55:19 +00001333 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001334
wdenkfd3103b2003-11-25 16:55:19 +00001335 NEC NL6448BC20-08. 6.5", 640x480.
1336 Active, color, single scan.
1337
1338 CONFIG_NEC_NL6448BC33_54
1339
1340 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001341 Active, color, single scan.
1342
1343 CONFIG_SHARP_16x9
1344
1345 Sharp 320x240. Active, color, single scan.
1346 It isn't 16x9, and I am not sure what it is.
1347
1348 CONFIG_SHARP_LQ64D341
1349
1350 Sharp LQ64D341 display, 640x480.
1351 Active, color, single scan.
1352
1353 CONFIG_HLD1045
1354
1355 HLD1045 display, 640x480.
1356 Active, color, single scan.
1357
1358 CONFIG_OPTREX_BW
1359
1360 Optrex CBL50840-2 NF-FW 99 22 M5
1361 or
1362 Hitachi LMG6912RPFC-00T
1363 or
1364 Hitachi SP14Q002
1365
1366 320x240. Black & white.
1367
1368 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001369 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001370
wdenk7152b1d2003-09-05 23:19:14 +00001371- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001372
wdenk8bde7f72003-06-27 21:31:46 +00001373 If this option is set, the environment is checked for
1374 a variable "splashimage". If found, the usual display
1375 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001376 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001377 specified in "splashimage" is loaded instead. The
1378 console is redirected to the "nulldev", too. This
1379 allows for a "silent" boot where a splash screen is
1380 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001381
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001382 CONFIG_SPLASH_SCREEN_ALIGN
1383
1384 If this option is set the splash image can be freely positioned
1385 on the screen. Environment variable "splashpos" specifies the
1386 position as "x,y". If a positive number is given it is used as
1387 number of pixel from left/top. If a negative number is given it
1388 is used as number of pixel from right/bottom. You can also
1389 specify 'm' for centering the image.
1390
1391 Example:
1392 setenv splashpos m,m
1393 => image at center of screen
1394
1395 setenv splashpos 30,20
1396 => image at x = 30 and y = 20
1397
1398 setenv splashpos -10,m
1399 => vertically centered image
1400 at x = dspWidth - bmpWidth - 9
1401
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001402- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1403
1404 If this option is set, additionally to standard BMP
1405 images, gzipped BMP images can be displayed via the
1406 splashscreen support or the bmp command.
1407
Anatolij Gustschind5011762010-03-15 14:50:25 +01001408- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1409
1410 If this option is set, 8-bit RLE compressed BMP images
1411 can be displayed via the splashscreen support or the
1412 bmp command.
1413
wdenkc29fdfc2003-08-29 20:57:53 +00001414- Compression support:
1415 CONFIG_BZIP2
1416
1417 If this option is set, support for bzip2 compressed
1418 images is included. If not, only uncompressed and gzip
1419 compressed images are supported.
1420
wdenk42d1f032003-10-15 23:53:47 +00001421 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001422 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001423 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001424
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001425 CONFIG_LZMA
1426
1427 If this option is set, support for lzma compressed
1428 images is included.
1429
1430 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1431 requires an amount of dynamic memory that is given by the
1432 formula:
1433
1434 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1435
1436 Where lc and lp stand for, respectively, Literal context bits
1437 and Literal pos bits.
1438
1439 This value is upper-bounded by 14MB in the worst case. Anyway,
1440 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1441 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1442 a very small buffer.
1443
1444 Use the lzmainfo tool to determinate the lc and lp values and
1445 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001446 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001447
wdenk17ea1172004-06-06 21:51:03 +00001448- MII/PHY support:
1449 CONFIG_PHY_ADDR
1450
1451 The address of PHY on MII bus.
1452
1453 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1454
1455 The clock frequency of the MII bus
1456
1457 CONFIG_PHY_GIGE
1458
1459 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001460 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001461
1462 CONFIG_PHY_RESET_DELAY
1463
1464 Some PHY like Intel LXT971A need extra delay after
1465 reset before any MII register access is possible.
1466 For such PHY, set this option to the usec delay
1467 required. (minimum 300usec for LXT971A)
1468
1469 CONFIG_PHY_CMD_DELAY (ppc4xx)
1470
1471 Some PHY like Intel LXT971A need extra delay after
1472 command issued before MII status register can be read
1473
wdenkc6097192002-11-03 00:24:07 +00001474- Ethernet address:
1475 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001476 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001477 CONFIG_ETH2ADDR
1478 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001479 CONFIG_ETH4ADDR
1480 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001481
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001482 Define a default value for Ethernet address to use
1483 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001484 is not determined automatically.
1485
1486- IP address:
1487 CONFIG_IPADDR
1488
1489 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001490 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001491 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001492 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001493
1494- Server IP address:
1495 CONFIG_SERVERIP
1496
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001497 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001498 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001499 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001500
Robin Getz97cfe862009-07-21 12:15:28 -04001501 CONFIG_KEEP_SERVERADDR
1502
1503 Keeps the server's MAC address, in the env 'serveraddr'
1504 for passing to bootargs (like Linux's netconsole option)
1505
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001506- Gateway IP address:
1507 CONFIG_GATEWAYIP
1508
1509 Defines a default value for the IP address of the
1510 default router where packets to other networks are
1511 sent to.
1512 (Environment variable "gatewayip")
1513
1514- Subnet mask:
1515 CONFIG_NETMASK
1516
1517 Defines a default value for the subnet mask (or
1518 routing prefix) which is used to determine if an IP
1519 address belongs to the local subnet or needs to be
1520 forwarded through a router.
1521 (Environment variable "netmask")
1522
David Updegraff53a5c422007-06-11 10:41:07 -05001523- Multicast TFTP Mode:
1524 CONFIG_MCAST_TFTP
1525
1526 Defines whether you want to support multicast TFTP as per
1527 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001528 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001529 driver in use must provide a function: mcast() to join/leave a
1530 multicast group.
1531
wdenkc6097192002-11-03 00:24:07 +00001532- BOOTP Recovery Mode:
1533 CONFIG_BOOTP_RANDOM_DELAY
1534
1535 If you have many targets in a network that try to
1536 boot using BOOTP, you may want to avoid that all
1537 systems send out BOOTP requests at precisely the same
1538 moment (which would happen for instance at recovery
1539 from a power failure, when all systems will try to
1540 boot, thus flooding the BOOTP server. Defining
1541 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1542 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001543 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001544
1545 1st BOOTP request: delay 0 ... 1 sec
1546 2nd BOOTP request: delay 0 ... 2 sec
1547 3rd BOOTP request: delay 0 ... 4 sec
1548 4th and following
1549 BOOTP requests: delay 0 ... 8 sec
1550
stroesefe389a82003-08-28 14:17:32 +00001551- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001552 You can fine tune the DHCP functionality by defining
1553 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001554
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001555 CONFIG_BOOTP_SUBNETMASK
1556 CONFIG_BOOTP_GATEWAY
1557 CONFIG_BOOTP_HOSTNAME
1558 CONFIG_BOOTP_NISDOMAIN
1559 CONFIG_BOOTP_BOOTPATH
1560 CONFIG_BOOTP_BOOTFILESIZE
1561 CONFIG_BOOTP_DNS
1562 CONFIG_BOOTP_DNS2
1563 CONFIG_BOOTP_SEND_HOSTNAME
1564 CONFIG_BOOTP_NTPSERVER
1565 CONFIG_BOOTP_TIMEOFFSET
1566 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001567
Wilson Callan5d110f02007-07-28 10:56:13 -04001568 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1569 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001570
1571 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1572 serverip from a DHCP server, it is possible that more
1573 than one DNS serverip is offered to the client.
1574 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1575 serverip will be stored in the additional environment
1576 variable "dnsip2". The first DNS serverip is always
1577 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001578 is defined.
stroesefe389a82003-08-28 14:17:32 +00001579
1580 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1581 to do a dynamic update of a DNS server. To do this, they
1582 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001583 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001584 of the "hostname" environment variable is passed as
1585 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001586
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001587 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1588
1589 A 32bit value in microseconds for a delay between
1590 receiving a "DHCP Offer" and sending the "DHCP Request".
1591 This fixes a problem with certain DHCP servers that don't
1592 respond 100% of the time to a "DHCP request". E.g. On an
1593 AT91RM9200 processor running at 180MHz, this delay needed
1594 to be *at least* 15,000 usec before a Windows Server 2003
1595 DHCP server would reply 100% of the time. I recommend at
1596 least 50,000 usec to be safe. The alternative is to hope
1597 that one of the retries will be successful but note that
1598 the DHCP timeout and retry process takes a longer than
1599 this delay.
1600
wdenka3d991b2004-04-15 21:48:45 +00001601 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001602 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001603
1604 The device id used in CDP trigger frames.
1605
1606 CONFIG_CDP_DEVICE_ID_PREFIX
1607
1608 A two character string which is prefixed to the MAC address
1609 of the device.
1610
1611 CONFIG_CDP_PORT_ID
1612
1613 A printf format string which contains the ascii name of
1614 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001615 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001616
1617 CONFIG_CDP_CAPABILITIES
1618
1619 A 32bit integer which indicates the device capabilities;
1620 0x00000010 for a normal host which does not forwards.
1621
1622 CONFIG_CDP_VERSION
1623
1624 An ascii string containing the version of the software.
1625
1626 CONFIG_CDP_PLATFORM
1627
1628 An ascii string containing the name of the platform.
1629
1630 CONFIG_CDP_TRIGGER
1631
1632 A 32bit integer sent on the trigger.
1633
1634 CONFIG_CDP_POWER_CONSUMPTION
1635
1636 A 16bit integer containing the power consumption of the
1637 device in .1 of milliwatts.
1638
1639 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1640
1641 A byte containing the id of the VLAN.
1642
wdenkc6097192002-11-03 00:24:07 +00001643- Status LED: CONFIG_STATUS_LED
1644
1645 Several configurations allow to display the current
1646 status using a LED. For instance, the LED will blink
1647 fast while running U-Boot code, stop blinking as
1648 soon as a reply to a BOOTP request was received, and
1649 start blinking slow once the Linux kernel is running
1650 (supported by a status LED driver in the Linux
1651 kernel). Defining CONFIG_STATUS_LED enables this
1652 feature in U-Boot.
1653
1654- CAN Support: CONFIG_CAN_DRIVER
1655
1656 Defining CONFIG_CAN_DRIVER enables CAN driver support
1657 on those systems that support this (optional)
1658 feature, like the TQM8xxL modules.
1659
1660- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1661
wdenkb37c7e52003-06-30 16:24:52 +00001662 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001663 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001664 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001665
wdenk945af8d2003-07-16 21:53:01 +00001666 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001667 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001668 CONFIG_COMMANDS) and communicate with i2c based realtime
1669 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001670 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001671
Ben Warrenbb99ad62006-09-07 16:50:54 -04001672 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001673
wdenk945af8d2003-07-16 21:53:01 +00001674 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001675 bit-banging) driver instead of CPM or similar hardware
1676 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001677
wdenk945af8d2003-07-16 21:53:01 +00001678 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001679 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001681 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001682 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001683 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001684 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001685
Peter Tyser8d321b82010-04-12 22:28:21 -05001686 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001687 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001688 and so its address should therefore be cleared to 0 (See,
1689 eg, MPC823e User's Manual p.16-473). So, set
1690 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001691
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001692 CONFIG_SYS_I2C_INIT_MPC5XXX
1693
1694 When a board is reset during an i2c bus transfer
1695 chips might think that the current transfer is still
1696 in progress. Reset the slave devices by sending start
1697 commands until the slave device responds.
1698
wdenk945af8d2003-07-16 21:53:01 +00001699 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001700
1701 If you use the software i2c interface (CONFIG_SOFT_I2C)
1702 then the following macros need to be defined (examples are
1703 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001704
1705 I2C_INIT
1706
wdenkb37c7e52003-06-30 16:24:52 +00001707 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001708 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001709
wdenkba56f622004-02-06 23:19:44 +00001710 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001711
wdenkc6097192002-11-03 00:24:07 +00001712 I2C_PORT
1713
wdenk43d96162003-03-06 00:02:04 +00001714 (Only for MPC8260 CPU). The I/O port to use (the code
1715 assumes both bits are on the same port). Valid values
1716 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001717
1718 I2C_ACTIVE
1719
1720 The code necessary to make the I2C data line active
1721 (driven). If the data line is open collector, this
1722 define can be null.
1723
wdenkb37c7e52003-06-30 16:24:52 +00001724 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1725
wdenkc6097192002-11-03 00:24:07 +00001726 I2C_TRISTATE
1727
1728 The code necessary to make the I2C data line tri-stated
1729 (inactive). If the data line is open collector, this
1730 define can be null.
1731
wdenkb37c7e52003-06-30 16:24:52 +00001732 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1733
wdenkc6097192002-11-03 00:24:07 +00001734 I2C_READ
1735
1736 Code that returns TRUE if the I2C data line is high,
1737 FALSE if it is low.
1738
wdenkb37c7e52003-06-30 16:24:52 +00001739 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1740
wdenkc6097192002-11-03 00:24:07 +00001741 I2C_SDA(bit)
1742
1743 If <bit> is TRUE, sets the I2C data line high. If it
1744 is FALSE, it clears it (low).
1745
wdenkb37c7e52003-06-30 16:24:52 +00001746 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001747 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001748 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001749
wdenkc6097192002-11-03 00:24:07 +00001750 I2C_SCL(bit)
1751
1752 If <bit> is TRUE, sets the I2C clock line high. If it
1753 is FALSE, it clears it (low).
1754
wdenkb37c7e52003-06-30 16:24:52 +00001755 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001756 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001757 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001758
wdenkc6097192002-11-03 00:24:07 +00001759 I2C_DELAY
1760
1761 This delay is invoked four times per clock cycle so this
1762 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001763 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001764 like:
1765
wdenkb37c7e52003-06-30 16:24:52 +00001766 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001767
Mike Frysinger793b5722010-07-21 13:38:02 -04001768 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1769
1770 If your arch supports the generic GPIO framework (asm/gpio.h),
1771 then you may alternatively define the two GPIOs that are to be
1772 used as SCL / SDA. Any of the previous I2C_xxx macros will
1773 have GPIO-based defaults assigned to them as appropriate.
1774
1775 You should define these to the GPIO value as given directly to
1776 the generic GPIO functions.
1777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001778 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001779
wdenk8bde7f72003-06-27 21:31:46 +00001780 When a board is reset during an i2c bus transfer
1781 chips might think that the current transfer is still
1782 in progress. On some boards it is possible to access
1783 the i2c SCLK line directly, either by using the
1784 processor pin as a GPIO or by having a second pin
1785 connected to the bus. If this option is defined a
1786 custom i2c_init_board() routine in boards/xxx/board.c
1787 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001788
Richard Retanubun26a33502010-04-12 15:08:17 -04001789 CONFIG_SYS_I2C_BOARD_LATE_INIT
1790
1791 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1792 defined a custom i2c_board_late_init() routine in
1793 boards/xxx/board.c is run AFTER the operations in i2c_init()
1794 is completed. This callpoint can be used to unreset i2c bus
1795 using CPU i2c controller register accesses for CPUs whose i2c
1796 controller provide such a method. It is called at the end of
1797 i2c_init() to allow i2c_init operations to setup the i2c bus
1798 controller on the CPU (e.g. setting bus speed & slave address).
1799
wdenk17ea1172004-06-06 21:51:03 +00001800 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1801
1802 This option enables configuration of bi_iic_fast[] flags
1803 in u-boot bd_info structure based on u-boot environment
1804 variable "i2cfast". (see also i2cfast)
1805
Ben Warrenbb99ad62006-09-07 16:50:54 -04001806 CONFIG_I2C_MULTI_BUS
1807
1808 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001809 must have a controller. At any point in time, only one bus is
1810 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001811 Note that bus numbering is zero-based.
1812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001813 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001814
1815 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001816 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001817 is set, specify a list of bus-device pairs. Otherwise, specify
1818 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001819
1820 e.g.
1821 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001822 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001823
1824 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1825
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001826 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001827 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001828
1829 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1830
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001831 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001832
1833 If defined, then this indicates the I2C bus number for DDR SPD.
1834 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1835
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001836 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001837
1838 If defined, then this indicates the I2C bus number for the RTC.
1839 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001841 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001842
1843 If defined, then this indicates the I2C bus number for the DTT.
1844 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1845
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001846 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001847
1848 If defined, specifies the I2C address of the DTT device.
1849 If not defined, then U-Boot uses predefined value for
1850 specified DTT device.
1851
Timur Tabibe5e6182006-11-03 19:15:00 -06001852 CONFIG_FSL_I2C
1853
1854 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001855 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001856
Heiko Schocher67b23a32008-10-15 09:39:47 +02001857 CONFIG_I2C_MUX
1858
1859 Define this option if you have I2C devices reached over 1 .. n
1860 I2C Muxes like the pca9544a. This option addes a new I2C
1861 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1862 new I2C Bus to the existing I2C Busses. If you select the
1863 new Bus with "i2c dev", u-bbot sends first the commandos for
1864 the muxes to activate this new "bus".
1865
1866 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1867 feature!
1868
1869 Example:
1870 Adding a new I2C Bus reached over 2 pca9544a muxes
1871 The First mux with address 70 and channel 6
1872 The Second mux with address 71 and channel 4
1873
1874 => i2c bus pca9544a:70:6:pca9544a:71:4
1875
1876 Use the "i2c bus" command without parameter, to get a list
1877 of I2C Busses with muxes:
1878
1879 => i2c bus
1880 Busses reached over muxes:
1881 Bus ID: 2
1882 reached over Mux(es):
1883 pca9544a@70 ch: 4
1884 Bus ID: 3
1885 reached over Mux(es):
1886 pca9544a@70 ch: 6
1887 pca9544a@71 ch: 4
1888 =>
1889
1890 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001891 u-boot first sends the command to the mux@70 to enable
1892 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001893 the channel 4.
1894
1895 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001896 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001897 the 2 muxes.
1898
1899 This option is actually implemented for the bitbanging
1900 algorithm in common/soft_i2c.c and for the Hardware I2C
1901 Bus on the MPC8260. But it should be not so difficult
1902 to add this option to other architectures.
1903
Andrew Dyer2ac69852008-12-29 17:36:01 -06001904 CONFIG_SOFT_I2C_READ_REPEATED_START
1905
1906 defining this will force the i2c_read() function in
1907 the soft_i2c driver to perform an I2C repeated start
1908 between writing the address pointer and reading the
1909 data. If this define is omitted the default behaviour
1910 of doing a stop-start sequence will be used. Most I2C
1911 devices can use either method, but some require one or
1912 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001913
wdenkc6097192002-11-03 00:24:07 +00001914- SPI Support: CONFIG_SPI
1915
1916 Enables SPI driver (so far only tested with
1917 SPI EEPROM, also an instance works with Crystal A/D and
1918 D/As on the SACSng board)
1919
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001920 CONFIG_SH_SPI
1921
1922 Enables the driver for SPI controller on SuperH. Currently
1923 only SH7757 is supported.
1924
wdenkc6097192002-11-03 00:24:07 +00001925 CONFIG_SPI_X
1926
1927 Enables extended (16-bit) SPI EEPROM addressing.
1928 (symmetrical to CONFIG_I2C_X)
1929
1930 CONFIG_SOFT_SPI
1931
wdenk43d96162003-03-06 00:02:04 +00001932 Enables a software (bit-bang) SPI driver rather than
1933 using hardware support. This is a general purpose
1934 driver that only requires three general I/O port pins
1935 (two outputs, one input) to function. If this is
1936 defined, the board configuration must define several
1937 SPI configuration items (port pins to use, etc). For
1938 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001939
Ben Warren04a9e112008-01-16 22:37:35 -05001940 CONFIG_HARD_SPI
1941
1942 Enables a hardware SPI driver for general-purpose reads
1943 and writes. As with CONFIG_SOFT_SPI, the board configuration
1944 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001945 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05001946 example, see include/configs/mpc8349emds.h.
1947
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001948 CONFIG_MXC_SPI
1949
1950 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00001951 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001952
Matthias Fuchs01335022007-12-27 17:12:34 +01001953- FPGA Support: CONFIG_FPGA
1954
1955 Enables FPGA subsystem.
1956
1957 CONFIG_FPGA_<vendor>
1958
1959 Enables support for specific chip vendors.
1960 (ALTERA, XILINX)
1961
1962 CONFIG_FPGA_<family>
1963
1964 Enables support for FPGA family.
1965 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1966
1967 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001968
wdenk43d96162003-03-06 00:02:04 +00001969 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001970
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001971 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001972
wdenk8bde7f72003-06-27 21:31:46 +00001973 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001975 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001976
wdenk43d96162003-03-06 00:02:04 +00001977 Enable checks on FPGA configuration interface busy
1978 status by the configuration function. This option
1979 will require a board or device specific function to
1980 be written.
wdenkc6097192002-11-03 00:24:07 +00001981
1982 CONFIG_FPGA_DELAY
1983
1984 If defined, a function that provides delays in the FPGA
1985 configuration driver.
1986
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001987 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001988 Allow Control-C to interrupt FPGA configuration
1989
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001990 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001991
wdenk43d96162003-03-06 00:02:04 +00001992 Check for configuration errors during FPGA bitfile
1993 loading. For example, abort during Virtex II
1994 configuration if the INIT_B line goes low (which
1995 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001997 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001998
wdenk43d96162003-03-06 00:02:04 +00001999 Maximum time to wait for the INIT_B line to deassert
2000 after PROB_B has been deasserted during a Virtex II
2001 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002002 ms.
wdenkc6097192002-11-03 00:24:07 +00002003
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002004 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002005
wdenk43d96162003-03-06 00:02:04 +00002006 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002007 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002008
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002009 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002010
wdenk43d96162003-03-06 00:02:04 +00002011 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002012 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002013
2014- Configuration Management:
2015 CONFIG_IDENT_STRING
2016
wdenk43d96162003-03-06 00:02:04 +00002017 If defined, this string will be added to the U-Boot
2018 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002019
2020- Vendor Parameter Protection:
2021
wdenk43d96162003-03-06 00:02:04 +00002022 U-Boot considers the values of the environment
2023 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002024 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002025 are set once by the board vendor / manufacturer, and
2026 protects these variables from casual modification by
2027 the user. Once set, these variables are read-only,
2028 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002029 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002030
2031 If CONFIG_ENV_OVERWRITE is #defined in your config
2032 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002033 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002034 these parameters.
2035
2036 Alternatively, if you #define _both_ CONFIG_ETHADDR
2037 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002038 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002039 which can be changed exactly ONCE by the user. [The
2040 serial# is unaffected by this, i. e. it remains
2041 read-only.]
2042
2043- Protected RAM:
2044 CONFIG_PRAM
2045
2046 Define this variable to enable the reservation of
2047 "protected RAM", i. e. RAM which is not overwritten
2048 by U-Boot. Define CONFIG_PRAM to hold the number of
2049 kB you want to reserve for pRAM. You can overwrite
2050 this default value by defining an environment
2051 variable "pram" to the number of kB you want to
2052 reserve. Note that the board info structure will
2053 still show the full amount of RAM. If pRAM is
2054 reserved, a new environment variable "mem" will
2055 automatically be defined to hold the amount of
2056 remaining RAM in a form that can be passed as boot
2057 argument to Linux, for instance like that:
2058
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002059 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002060 saveenv
2061
2062 This way you can tell Linux not to use this memory,
2063 either, which results in a memory region that will
2064 not be affected by reboots.
2065
2066 *WARNING* If your board configuration uses automatic
2067 detection of the RAM size, you must make sure that
2068 this memory test is non-destructive. So far, the
2069 following board configurations are known to be
2070 "pRAM-clean":
2071
2072 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2073 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002074 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002075
2076- Error Recovery:
2077 CONFIG_PANIC_HANG
2078
2079 Define this variable to stop the system in case of a
2080 fatal error, so that you have to reset it manually.
2081 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002082 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002083 automatically as fast as possible, but it may be
2084 useful during development since you can try to debug
2085 the conditions that lead to the situation.
2086
2087 CONFIG_NET_RETRY_COUNT
2088
wdenk43d96162003-03-06 00:02:04 +00002089 This variable defines the number of retries for
2090 network operations like ARP, RARP, TFTP, or BOOTP
2091 before giving up the operation. If not defined, a
2092 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002093
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002094 CONFIG_ARP_TIMEOUT
2095
2096 Timeout waiting for an ARP reply in milliseconds.
2097
wdenkc6097192002-11-03 00:24:07 +00002098- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002099 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002100
2101 Enable auto completion of commands using TAB.
2102
Wolfgang Denka9398e02006-11-27 15:32:42 +01002103 Note that this feature has NOT been implemented yet
2104 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002105
2106
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002107 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002108
2109 Define this variable to enable the "hush" shell (from
2110 Busybox) as command line interpreter, thus enabling
2111 powerful command line syntax like
2112 if...then...else...fi conditionals or `&&' and '||'
2113 constructs ("shell scripts").
2114
2115 If undefined, you get the old, much simpler behaviour
2116 with a somewhat smaller memory footprint.
2117
2118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002119 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002120
2121 This defines the secondary prompt string, which is
2122 printed when the command interpreter needs more input
2123 to complete a command. Usually "> ".
2124
2125 Note:
2126
wdenk8bde7f72003-06-27 21:31:46 +00002127 In the current implementation, the local variables
2128 space and global environment variables space are
2129 separated. Local variables are those you define by
2130 simply typing `name=value'. To access a local
2131 variable later on, you have write `$name' or
2132 `${name}'; to execute the contents of a variable
2133 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002134
wdenk43d96162003-03-06 00:02:04 +00002135 Global environment variables are those you use
2136 setenv/printenv to work with. To run a command stored
2137 in such a variable, you need to use the run command,
2138 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002139
2140 To store commands and special characters in a
2141 variable, please use double quotation marks
2142 surrounding the whole text of the variable, instead
2143 of the backslashes before semicolons and special
2144 symbols.
2145
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002146- Commandline Editing and History:
2147 CONFIG_CMDLINE_EDITING
2148
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002149 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002150 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002151
wdenka8c7c702003-12-06 19:49:23 +00002152- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002153 CONFIG_EXTRA_ENV_SETTINGS
2154
wdenk43d96162003-03-06 00:02:04 +00002155 Define this to contain any number of null terminated
2156 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002157 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002158
wdenk43d96162003-03-06 00:02:04 +00002159 For example, place something like this in your
2160 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002161
2162 #define CONFIG_EXTRA_ENV_SETTINGS \
2163 "myvar1=value1\0" \
2164 "myvar2=value2\0"
2165
wdenk43d96162003-03-06 00:02:04 +00002166 Warning: This method is based on knowledge about the
2167 internal format how the environment is stored by the
2168 U-Boot code. This is NOT an official, exported
2169 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002170 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002171 You better know what you are doing here.
2172
wdenk43d96162003-03-06 00:02:04 +00002173 Note: overly (ab)use of the default environment is
2174 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002175 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002176 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002177
wdenka8c7c702003-12-06 19:49:23 +00002178- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002179 CONFIG_HAS_DATAFLASH
2180
wdenk8bde7f72003-06-27 21:31:46 +00002181 Defining this option enables DataFlash features and
2182 allows to read/write in Dataflash via the standard
2183 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002184
wdenk3f85ce22004-02-23 16:11:30 +00002185- SystemACE Support:
2186 CONFIG_SYSTEMACE
2187
2188 Adding this option adds support for Xilinx SystemACE
2189 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002190 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002191 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002192
2193 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002194 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002195
2196 When SystemACE support is added, the "ace" device type
2197 becomes available to the fat commands, i.e. fatls.
2198
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002199- TFTP Fixed UDP Port:
2200 CONFIG_TFTP_PORT
2201
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002202 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002203 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002204 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002205 number generator is used.
2206
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002207 Also, the environment variable tftpdstp is used to supply
2208 the TFTP UDP destination port value. If tftpdstp isn't
2209 defined, the normal port 69 is used.
2210
2211 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002212 blindly start the TFTP transfer using the pre-configured
2213 target IP address and UDP port. This has the effect of
2214 "punching through" the (Windows XP) firewall, allowing
2215 the remainder of the TFTP transfer to proceed normally.
2216 A better solution is to properly configure the firewall,
2217 but sometimes that is not allowed.
2218
wdenka8c7c702003-12-06 19:49:23 +00002219- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002220 CONFIG_SHOW_BOOT_PROGRESS
2221
wdenk43d96162003-03-06 00:02:04 +00002222 Defining this option allows to add some board-
2223 specific code (calling a user-provided function
2224 "show_boot_progress(int)") that enables you to show
2225 the system's boot progress on some display (for
2226 example, some LED's) on your board. At the moment,
2227 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002228
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002229Legacy uImage format:
2230
wdenkc6097192002-11-03 00:24:07 +00002231 Arg Where When
2232 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002233 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002234 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002235 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002236 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002237 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002238 4 common/cmd_bootm.c Image data has correct checksum
2239 -4 common/cmd_bootm.c Image is for unsupported architecture
2240 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002241 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002242 6 common/cmd_bootm.c Image Type check OK
2243 -6 common/cmd_bootm.c gunzip uncompression error
2244 -7 common/cmd_bootm.c Unimplemented compression type
2245 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002246 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002247 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002248
2249 9 common/image.c Start initial ramdisk verification
2250 -10 common/image.c Ramdisk header has bad magic number
2251 -11 common/image.c Ramdisk header has bad checksum
2252 10 common/image.c Ramdisk header is OK
2253 -12 common/image.c Ramdisk data has bad checksum
2254 11 common/image.c Ramdisk data has correct checksum
2255 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002256 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002257 13 common/image.c Start multifile image verification
2258 14 common/image.c No initial ramdisk, no multifile, continue.
2259
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002260 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002261
Stefan Roesea47a12b2010-04-15 16:07:28 +02002262 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002263 -31 post/post.c POST test failed, detected by post_output_backlog()
2264 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002265
Heiko Schocher566a4942007-06-22 19:11:54 +02002266 34 common/cmd_doc.c before loading a Image from a DOC device
2267 -35 common/cmd_doc.c Bad usage of "doc" command
2268 35 common/cmd_doc.c correct usage of "doc" command
2269 -36 common/cmd_doc.c No boot device
2270 36 common/cmd_doc.c correct boot device
2271 -37 common/cmd_doc.c Unknown Chip ID on boot device
2272 37 common/cmd_doc.c correct chip ID found, device available
2273 -38 common/cmd_doc.c Read Error on boot device
2274 38 common/cmd_doc.c reading Image header from DOC device OK
2275 -39 common/cmd_doc.c Image header has bad magic number
2276 39 common/cmd_doc.c Image header has correct magic number
2277 -40 common/cmd_doc.c Error reading Image from DOC device
2278 40 common/cmd_doc.c Image header has correct magic number
2279 41 common/cmd_ide.c before loading a Image from a IDE device
2280 -42 common/cmd_ide.c Bad usage of "ide" command
2281 42 common/cmd_ide.c correct usage of "ide" command
2282 -43 common/cmd_ide.c No boot device
2283 43 common/cmd_ide.c boot device found
2284 -44 common/cmd_ide.c Device not available
2285 44 common/cmd_ide.c Device available
2286 -45 common/cmd_ide.c wrong partition selected
2287 45 common/cmd_ide.c partition selected
2288 -46 common/cmd_ide.c Unknown partition table
2289 46 common/cmd_ide.c valid partition table found
2290 -47 common/cmd_ide.c Invalid partition type
2291 47 common/cmd_ide.c correct partition type
2292 -48 common/cmd_ide.c Error reading Image Header on boot device
2293 48 common/cmd_ide.c reading Image Header from IDE device OK
2294 -49 common/cmd_ide.c Image header has bad magic number
2295 49 common/cmd_ide.c Image header has correct magic number
2296 -50 common/cmd_ide.c Image header has bad checksum
2297 50 common/cmd_ide.c Image header has correct checksum
2298 -51 common/cmd_ide.c Error reading Image from IDE device
2299 51 common/cmd_ide.c reading Image from IDE device OK
2300 52 common/cmd_nand.c before loading a Image from a NAND device
2301 -53 common/cmd_nand.c Bad usage of "nand" command
2302 53 common/cmd_nand.c correct usage of "nand" command
2303 -54 common/cmd_nand.c No boot device
2304 54 common/cmd_nand.c boot device found
2305 -55 common/cmd_nand.c Unknown Chip ID on boot device
2306 55 common/cmd_nand.c correct chip ID found, device available
2307 -56 common/cmd_nand.c Error reading Image Header on boot device
2308 56 common/cmd_nand.c reading Image Header from NAND device OK
2309 -57 common/cmd_nand.c Image header has bad magic number
2310 57 common/cmd_nand.c Image header has correct magic number
2311 -58 common/cmd_nand.c Error reading Image from NAND device
2312 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002313
Heiko Schocher566a4942007-06-22 19:11:54 +02002314 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002315
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002316 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002317 -64 net/eth.c no Ethernet found.
2318 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002319
Heiko Schocher566a4942007-06-22 19:11:54 +02002320 -80 common/cmd_net.c usage wrong
2321 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002322 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002323 81 common/cmd_net.c NetLoop() back without error
2324 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2325 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002326 83 common/cmd_net.c running "source" command
2327 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002328 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002329
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002330FIT uImage format:
2331
2332 Arg Where When
2333 100 common/cmd_bootm.c Kernel FIT Image has correct format
2334 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2335 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2336 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2337 102 common/cmd_bootm.c Kernel unit name specified
2338 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002339 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002340 104 common/cmd_bootm.c Got kernel subimage node offset
2341 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2342 105 common/cmd_bootm.c Kernel subimage hash verification OK
2343 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2344 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002345 -106 common/cmd_bootm.c Kernel subimage has wrong type
2346 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002347 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2348 108 common/cmd_bootm.c Got kernel subimage data/size
2349 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2350 -109 common/cmd_bootm.c Can't get kernel subimage type
2351 -110 common/cmd_bootm.c Can't get kernel subimage comp
2352 -111 common/cmd_bootm.c Can't get kernel subimage os
2353 -112 common/cmd_bootm.c Can't get kernel subimage load address
2354 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2355
2356 120 common/image.c Start initial ramdisk verification
2357 -120 common/image.c Ramdisk FIT image has incorrect format
2358 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002359 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002360 -122 common/image.c Can't get configuration for ramdisk subimage
2361 123 common/image.c Ramdisk unit name specified
2362 -124 common/image.c Can't get ramdisk subimage node offset
2363 125 common/image.c Got ramdisk subimage node offset
2364 -125 common/image.c Ramdisk subimage hash verification failed
2365 126 common/image.c Ramdisk subimage hash verification OK
2366 -126 common/image.c Ramdisk subimage for unsupported architecture
2367 127 common/image.c Architecture check OK
2368 -127 common/image.c Can't get ramdisk subimage data/size
2369 128 common/image.c Got ramdisk subimage data/size
2370 129 common/image.c Can't get ramdisk load address
2371 -129 common/image.c Got ramdisk load address
2372
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002373 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002374 131 common/cmd_doc.c FIT image format OK
2375
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002376 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002377 141 common/cmd_ide.c FIT image format OK
2378
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002379 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002380 151 common/cmd_nand.c FIT image format OK
2381
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002382- Standalone program support:
2383 CONFIG_STANDALONE_LOAD_ADDR
2384
Wolfgang Denk6feff892011-10-09 21:06:34 +02002385 This option defines a board specific value for the
2386 address where standalone program gets loaded, thus
2387 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002388 settings.
2389
2390- Frame Buffer Address:
2391 CONFIG_FB_ADDR
2392
2393 Define CONFIG_FB_ADDR if you want to use specific
2394 address for frame buffer.
2395 Then system will reserve the frame buffer address to
2396 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002397 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002398
2399 Please see board_init_f function.
2400
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002401- Automatic software updates via TFTP server
2402 CONFIG_UPDATE_TFTP
2403 CONFIG_UPDATE_TFTP_CNT_MAX
2404 CONFIG_UPDATE_TFTP_MSEC_MAX
2405
2406 These options enable and control the auto-update feature;
2407 for a more detailed description refer to doc/README.update.
2408
2409- MTD Support (mtdparts command, UBI support)
2410 CONFIG_MTD_DEVICE
2411
2412 Adds the MTD device infrastructure from the Linux kernel.
2413 Needed for mtdparts command support.
2414
2415 CONFIG_MTD_PARTITIONS
2416
2417 Adds the MTD partitioning infrastructure from the Linux
2418 kernel. Needed for UBI support.
2419
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002420- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002421 CONFIG_SPL
2422 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002423
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002424 CONFIG_SPL_TEXT_BASE
2425 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002426
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002427 CONFIG_SPL_LDSCRIPT
2428 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002429
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002430 CONFIG_SPL_LIBCOMMON_SUPPORT
2431 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002432
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002433 CONFIG_SPL_LIBDISK_SUPPORT
2434 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002435
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002436 CONFIG_SPL_I2C_SUPPORT
2437 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002438
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002439 CONFIG_SPL_GPIO_SUPPORT
2440 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002441
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002442 CONFIG_SPL_MMC_SUPPORT
2443 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002444
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002445 CONFIG_SPL_SERIAL_SUPPORT
2446 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002447
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002448 CONFIG_SPL_SPI_FLASH_SUPPORT
2449 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002450
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002451 CONFIG_SPL_SPI_SUPPORT
2452 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002453
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002454 CONFIG_SPL_FAT_SUPPORT
2455 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002456
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002457 CONFIG_SPL_LIBGENERIC_SUPPORT
2458 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002459
wdenkc6097192002-11-03 00:24:07 +00002460Modem Support:
2461--------------
2462
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002463[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002464
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002465- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002466 CONFIG_MODEM_SUPPORT
2467
2468- RTS/CTS Flow control enable:
2469 CONFIG_HWFLOW
2470
2471- Modem debug support:
2472 CONFIG_MODEM_SUPPORT_DEBUG
2473
wdenk43d96162003-03-06 00:02:04 +00002474 Enables debugging stuff (char screen[1024], dbg())
2475 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002476
wdenka8c7c702003-12-06 19:49:23 +00002477- Interrupt support (PPC):
2478
wdenkd4ca31c2004-01-02 14:00:00 +00002479 There are common interrupt_init() and timer_interrupt()
2480 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002481 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002482 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002483 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002484 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002485 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002486 specific handling. If board has watchdog / status_led
2487 / other_activity_monitor it works automatically from
2488 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002489
wdenkc6097192002-11-03 00:24:07 +00002490- General:
2491
wdenk43d96162003-03-06 00:02:04 +00002492 In the target system modem support is enabled when a
2493 specific key (key combination) is pressed during
2494 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002495 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002496 board_init(). Currently key_pressed() is a dummy
2497 function, returning 1 and thus enabling modem
2498 initialization.
wdenkc6097192002-11-03 00:24:07 +00002499
wdenk43d96162003-03-06 00:02:04 +00002500 If there are no modem init strings in the
2501 environment, U-Boot proceed to autoboot; the
2502 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002503 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002504
2505 See also: doc/README.Modem
2506
Helmut Raiger9660e442011-10-20 04:19:47 +00002507Board initialization settings:
2508------------------------------
2509
2510During Initialization u-boot calls a number of board specific functions
2511to allow the preparation of board specific prerequisites, e.g. pin setup
2512before drivers are initialized. To enable these callbacks the
2513following configuration macros have to be defined. Currently this is
2514architecture specific, so please check arch/your_architecture/lib/board.c
2515typically in board_init_f() and board_init_r().
2516
2517- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2518- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2519- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2520- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002521
wdenkc6097192002-11-03 00:24:07 +00002522Configuration Settings:
2523-----------------------
2524
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002525- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002526 undefine this when you're short of memory.
2527
Peter Tyser2fb26042009-01-27 18:03:12 -06002528- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2529 width of the commands listed in the 'help' command output.
2530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002531- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002532 prompt for user input.
2533
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002534- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002535
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002536- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002538- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002539
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002540- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002541 the application (usually a Linux kernel) when it is
2542 booted
2543
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002544- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002545 List of legal baudrate settings for this board.
2546
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002547- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002548 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002549
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002550- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002551 If the board specific function
2552 extern int overwrite_console (void);
2553 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002554 serial port, else the settings in the environment are used.
2555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002556- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002557 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002558
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002559- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002560 Enable overwrite of previous console environment settings.
2561
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002562- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002563 Begin and End addresses of the area used by the
2564 simple memory test.
2565
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002566- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002567 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002568
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002569- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002570 Scratch address used by the alternate memory test
2571 You only need to set this if address zero isn't writeable
2572
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002573- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2574 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002575 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002576 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002577 fixing up gd->ram_size the Linux kernel should gets passed
2578 the now "corrected" memory size and won't touch it either.
2579 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002580 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002581 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002582 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002583
2584 This option can be used as a workaround for the 440EPx/GRx
2585 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2586 be touched.
2587
2588 WARNING: Please make sure that this value is a multiple of
2589 the Linux page size (normally 4k). If this is not the case,
2590 then the end address of the Linux memory will be located at a
2591 non page size aligned address and this could cause major
2592 problems.
2593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002594- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002595 Default load address for network file downloads
2596
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002597- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002598 Enable temporary baudrate change while serial download
2599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002600- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002601 Physical start address of SDRAM. _Must_ be 0 here.
2602
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002603- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002604 Physical start address of Motherboard I/O (if using a
2605 Cogent motherboard)
2606
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002607- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002608 Physical start address of Flash memory.
2609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002610- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002611 Physical start address of boot monitor code (set by
2612 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002613 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002614 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002616- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002617 Size of memory reserved for monitor code, used to
2618 determine _at_compile_time_ (!) if the environment is
2619 embedded within the U-Boot image, or in a separate
2620 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002621
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002622- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002623 Size of DRAM reserved for malloc() use.
2624
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002625- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002626 Normally compressed uImages are limited to an
2627 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002628 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002629 to adjust this setting to your needs.
2630
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002631- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002632 Maximum size of memory mapped by the startup code of
2633 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002634 the Linux kernel (bd_info, boot arguments, FDT blob if
2635 used) must be put below this limit, unless "bootm_low"
2636 enviroment variable is defined and non-zero. In such case
2637 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002638 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002639 variable "bootm_mapsize" will override the value of
2640 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2641 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002642
John Rigbyfca43cc2010-10-13 13:57:35 -06002643- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2644 Enable initrd_high functionality. If defined then the
2645 initrd_high feature is enabled and the bootm ramdisk subcommand
2646 is enabled.
2647
2648- CONFIG_SYS_BOOT_GET_CMDLINE:
2649 Enables allocating and saving kernel cmdline in space between
2650 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2651
2652- CONFIG_SYS_BOOT_GET_KBD:
2653 Enables allocating and saving a kernel copy of the bd_info in
2654 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2655
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002656- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002657 Max number of Flash memory banks
2658
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002659- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002660 Max number of sectors on a Flash chip
2661
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002662- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002663 Timeout for Flash erase operations (in ms)
2664
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002665- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002666 Timeout for Flash write operations (in ms)
2667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002668- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002669 Timeout for Flash set sector lock bit operation (in ms)
2670
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002671- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002672 Timeout for Flash clear lock bits operation (in ms)
2673
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002674- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002675 If defined, hardware flash sectors protection is used
2676 instead of U-Boot software protection.
2677
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002678- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002679
2680 Enable TFTP transfers directly to flash memory;
2681 without this option such a download has to be
2682 performed in two steps: (1) download to RAM, and (2)
2683 copy from RAM to flash.
2684
2685 The two-step approach is usually more reliable, since
2686 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002687 the flash, but in some situations (when system RAM is
2688 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002689 downloaded image) this option may be very useful.
2690
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002691- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002692 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002693 common flash structure for storing flash geometry.
2694
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002695- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002696 This option also enables the building of the cfi_flash driver
2697 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002698
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002699- CONFIG_FLASH_CFI_MTD
2700 This option enables the building of the cfi_mtd driver
2701 in the drivers directory. The driver exports CFI flash
2702 to the MTD layer.
2703
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002704- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002705 Use buffered writes to flash.
2706
2707- CONFIG_FLASH_SPANSION_S29WS_N
2708 s29ws-n MirrorBit flash has non-standard addresses for buffered
2709 write commands.
2710
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002711- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002712 If this option is defined, the common CFI flash doesn't
2713 print it's warning upon not recognized FLASH banks. This
2714 is useful, if some of the configured banks are only
2715 optionally available.
2716
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002717- CONFIG_FLASH_SHOW_PROGRESS
2718 If defined (must be an integer), print out countdown
2719 digits and dots. Recommended value: 45 (9..1) for 80
2720 column displays, 15 (3..1) for 40 column displays.
2721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002722- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002723 Defines the number of Ethernet receive buffers. On some
2724 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002725 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2726 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002727 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002728 Defaults to 4 if not defined.
2729
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002730- CONFIG_ENV_MAX_ENTRIES
2731
Wolfgang Denk071bc922010-10-27 22:48:30 +02002732 Maximum number of entries in the hash table that is used
2733 internally to store the environment settings. The default
2734 setting is supposed to be generous and should work in most
2735 cases. This setting can be used to tune behaviour; see
2736 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002737
wdenkc6097192002-11-03 00:24:07 +00002738The following definitions that deal with the placement and management
2739of environment data (variable area); in general, we support the
2740following configurations:
2741
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002742- CONFIG_BUILD_ENVCRC:
2743
2744 Builds up envcrc with the target environment so that external utils
2745 may easily extract it and embed it in final U-Boot images.
2746
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002747- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002748
2749 Define this if the environment is in flash memory.
2750
2751 a) The environment occupies one whole flash sector, which is
2752 "embedded" in the text segment with the U-Boot code. This
2753 happens usually with "bottom boot sector" or "top boot
2754 sector" type flash chips, which have several smaller
2755 sectors at the start or the end. For instance, such a
2756 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2757 such a case you would place the environment in one of the
2758 4 kB sectors - with U-Boot code before and after it. With
2759 "top boot sector" type flash chips, you would put the
2760 environment in one of the last sectors, leaving a gap
2761 between U-Boot and the environment.
2762
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002763 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002764
2765 Offset of environment data (variable area) to the
2766 beginning of flash memory; for instance, with bottom boot
2767 type flash chips the second sector can be used: the offset
2768 for this sector is given here.
2769
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002770 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002771
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002772 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002773
2774 This is just another way to specify the start address of
2775 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002776 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002777
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002778 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002779
2780 Size of the sector containing the environment.
2781
2782
2783 b) Sometimes flash chips have few, equal sized, BIG sectors.
2784 In such a case you don't want to spend a whole sector for
2785 the environment.
2786
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002787 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002788
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002789 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002790 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002791 of this flash sector for the environment. This saves
2792 memory for the RAM copy of the environment.
2793
2794 It may also save flash memory if you decide to use this
2795 when your environment is "embedded" within U-Boot code,
2796 since then the remainder of the flash sector could be used
2797 for U-Boot code. It should be pointed out that this is
2798 STRONGLY DISCOURAGED from a robustness point of view:
2799 updating the environment in flash makes it always
2800 necessary to erase the WHOLE sector. If something goes
2801 wrong before the contents has been restored from a copy in
2802 RAM, your target system will be dead.
2803
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002804 - CONFIG_ENV_ADDR_REDUND
2805 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002806
wdenk43d96162003-03-06 00:02:04 +00002807 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002808 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002809 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002810 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002811
2812BE CAREFUL! Any changes to the flash layout, and some changes to the
2813source code will make it necessary to adapt <board>/u-boot.lds*
2814accordingly!
2815
2816
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002817- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002818
2819 Define this if you have some non-volatile memory device
2820 (NVRAM, battery buffered SRAM) which you want to use for the
2821 environment.
2822
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002823 - CONFIG_ENV_ADDR:
2824 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002825
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002826 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002827 want to use for environment. It is assumed that this memory
2828 can just be read and written to, without any special
2829 provision.
2830
2831BE CAREFUL! The first access to the environment happens quite early
2832in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002833console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002834U-Boot will hang.
2835
2836Please note that even with NVRAM we still use a copy of the
2837environment in RAM: we could work on NVRAM directly, but we want to
2838keep settings there always unmodified except somebody uses "saveenv"
2839to save the current settings.
2840
2841
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002842- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002843
2844 Use this if you have an EEPROM or similar serial access
2845 device and a driver for it.
2846
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002847 - CONFIG_ENV_OFFSET:
2848 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002849
2850 These two #defines specify the offset and size of the
2851 environment area within the total memory of your EEPROM.
2852
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002853 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002854 If defined, specified the chip address of the EEPROM device.
2855 The default address is zero.
2856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002857 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002858 If defined, the number of bits used to address bytes in a
2859 single page in the EEPROM device. A 64 byte page, for example
2860 would require six bits.
2861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002862 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002863 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002864 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002865
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002866 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002867 The length in bytes of the EEPROM memory array address. Note
2868 that this is NOT the chip address length!
2869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002870 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002871 EEPROM chips that implement "address overflow" are ones
2872 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2873 address and the extra bits end up in the "chip address" bit
2874 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2875 byte chips.
2876
2877 Note that we consider the length of the address field to
2878 still be one byte because the extra address bits are hidden
2879 in the chip address.
2880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002881 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002882 The size in bytes of the EEPROM device.
2883
Heiko Schocher548738b2010-01-07 08:55:40 +01002884 - CONFIG_ENV_EEPROM_IS_ON_I2C
2885 define this, if you have I2C and SPI activated, and your
2886 EEPROM, which holds the environment, is on the I2C bus.
2887
2888 - CONFIG_I2C_ENV_EEPROM_BUS
2889 if you have an Environment on an EEPROM reached over
2890 I2C muxes, you can define here, how to reach this
2891 EEPROM. For example:
2892
Wolfgang Denka9046b92010-06-13 17:48:15 +02002893 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002894
2895 EEPROM which holds the environment, is reached over
2896 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002897
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002898- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002899
wdenkd4ca31c2004-01-02 14:00:00 +00002900 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002901 want to use for the environment.
2902
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002903 - CONFIG_ENV_OFFSET:
2904 - CONFIG_ENV_ADDR:
2905 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002906
2907 These three #defines specify the offset and size of the
2908 environment area within the total memory of your DataFlash placed
2909 at the specified address.
2910
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002911- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002912
2913 Define this if you have a NAND device which you want to use
2914 for the environment.
2915
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002916 - CONFIG_ENV_OFFSET:
2917 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002918
2919 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002920 area within the first NAND device. CONFIG_ENV_OFFSET must be
2921 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002922
Scott Woodfdd813d2010-09-17 14:38:37 -05002923 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002924
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002925 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002926 size used to hold a redundant copy of the environment data, so
2927 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002928 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05002929 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002930
Scott Woodfdd813d2010-09-17 14:38:37 -05002931 - CONFIG_ENV_RANGE (optional):
2932
2933 Specifies the length of the region in which the environment
2934 can be written. This should be a multiple of the NAND device's
2935 block size. Specifying a range with more erase blocks than
2936 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2937 the range to be avoided.
2938
2939 - CONFIG_ENV_OFFSET_OOB (optional):
2940
2941 Enables support for dynamically retrieving the offset of the
2942 environment from block zero's out-of-band data. The
2943 "nand env.oob" command can be used to record this offset.
2944 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2945 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002946
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002947- CONFIG_NAND_ENV_DST
2948
2949 Defines address in RAM to which the nand_spl code should copy the
2950 environment. If redundant environment is used, it will be copied to
2951 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002953- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002954
2955 Defines offset to the initial SPI buffer area in DPRAM. The
2956 area is used at an early stage (ROM part) if the environment
2957 is configured to reside in the SPI EEPROM: We need a 520 byte
2958 scratch DPRAM area. It is used between the two initialization
2959 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2960 to be a good choice since it makes it far enough from the
2961 start of the data area as well as from the stack pointer.
2962
Bruce Adlere881cb52007-11-02 13:15:42 -07002963Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002964has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002965created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002966until then to read environment variables.
2967
wdenk85ec0bc2003-03-31 16:34:49 +00002968The environment is protected by a CRC32 checksum. Before the monitor
2969is relocated into RAM, as a result of a bad CRC you will be working
2970with the compiled-in default environment - *silently*!!! [This is
2971necessary, because the first environment variable we need is the
2972"baudrate" setting for the console - if we have a bad CRC, we don't
2973have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002974
2975Note: once the monitor has been relocated, then it will complain if
2976the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002977use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002978
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002979- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002980 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002981
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002982 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002983 also needs to be defined.
2984
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002985- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002986 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002987
Ron Madridf5675aa2009-02-18 14:30:44 -08002988- CONFIG_NS16550_MIN_FUNCTIONS:
2989 Define this if you desire to only have use of the NS16550_init
2990 and NS16550_putc functions for the serial driver located at
2991 drivers/serial/ns16550.c. This option is useful for saving
2992 space for already greatly restricted images, including but not
2993 limited to NAND_SPL configurations.
2994
wdenkc6097192002-11-03 00:24:07 +00002995Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002996---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002997
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002998- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002999 Cache Line Size of the CPU.
3000
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003001- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003002 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003003
wdenk42d1f032003-10-15 23:53:47 +00003004 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3005 and RPXsuper) to be able to adjust the position of
3006 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003007
Timur Tabie46fedf2011-08-04 18:03:41 -05003008- CONFIG_SYS_CCSRBAR_DEFAULT:
3009 Default (power-on reset) physical address of CCSR on Freescale
3010 PowerPC SOCs.
3011
3012- CONFIG_SYS_CCSRBAR:
3013 Virtual address of CCSR. On a 32-bit build, this is typically
3014 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3015
3016 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3017 for cross-platform code that uses that macro instead.
3018
3019- CONFIG_SYS_CCSRBAR_PHYS:
3020 Physical address of CCSR. CCSR can be relocated to a new
3021 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003022 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003023 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3024 is typically relocated on 36-bit builds. It is recommended
3025 that this macro be defined via the _HIGH and _LOW macros:
3026
3027 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3028 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3029
3030- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003031 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3032 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003033 used in assembly code, so it must not contain typecasts or
3034 integer size suffixes (e.g. "ULL").
3035
3036- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3037 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3038 used in assembly code, so it must not contain typecasts or
3039 integer size suffixes (e.g. "ULL").
3040
3041- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3042 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3043 forced to a value that ensures that CCSR is not relocated.
3044
wdenk7f6c2cb2002-11-10 22:06:23 +00003045- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003046 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003047
3048 the default drive number (default value 0)
3049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003050 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003051
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003052 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003053 (default value 1)
3054
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003055 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003056
wdenk43d96162003-03-06 00:02:04 +00003057 defines the offset of register from address. It
3058 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003059 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003061 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3062 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003063 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003064
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003065 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003066 fdc_hw_init() is called at the beginning of the FDC
3067 setup. fdc_hw_init() must be provided by the board
3068 source code. It is used to make hardware dependant
3069 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003070
Macpaul Lin0abddf82011-04-11 20:45:32 +00003071- CONFIG_IDE_AHB:
3072 Most IDE controllers were designed to be connected with PCI
3073 interface. Only few of them were designed for AHB interface.
3074 When software is doing ATA command and data transfer to
3075 IDE devices through IDE-AHB controller, some additional
3076 registers accessing to these kind of IDE-AHB controller
3077 is requierd.
3078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003079- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003080 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003081 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003082
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003083- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003084
wdenk7152b1d2003-09-05 23:19:14 +00003085 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003086 initial data and stack; please note that this must be
3087 writable memory that is working WITHOUT special
3088 initialization, i. e. you CANNOT use normal RAM which
3089 will become available only after programming the
3090 memory controller and running certain initialization
3091 sequences.
3092
3093 U-Boot uses the following memory types:
3094 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3095 - MPC824X: data cache
3096 - PPC4xx: data cache
3097
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003098- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003099
3100 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003101 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3102 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003103 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003104 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003105 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3106 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3107 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003108
3109 Note:
3110 On the MPC824X (or other systems that use the data
3111 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003112 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003113 point to an otherwise UNUSED address space between
3114 the top of RAM and the start of the PCI space.
3115
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003116- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003117
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003118- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003119
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003120- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003121
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003122- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003124- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003125
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003126- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003127
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003128- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003129 SDRAM timing
3130
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003131- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003132 periodic timer for refresh
3133
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003134- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003136- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3137 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3138 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3139 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003140 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3141
3142- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003143 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3144 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003145 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3146
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003147- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3148 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003149 Machine Mode Register and Memory Periodic Timer
3150 Prescaler definitions (SDRAM timing)
3151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003152- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003153 enable I2C microcode relocation patch (MPC8xx);
3154 define relocation offset in DPRAM [DSP2]
3155
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003156- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003157 enable SMC microcode relocation patch (MPC8xx);
3158 define relocation offset in DPRAM [SMC1]
3159
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003160- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003161 enable SPI microcode relocation patch (MPC8xx);
3162 define relocation offset in DPRAM [SCC4]
3163
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003164- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003165 Use OSCM clock mode on MBX8xx board. Be careful,
3166 wrong setting might damage your board. Read
3167 doc/README.MBX before setting this variable!
3168
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003169- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003170 Offset of the bootmode word in DPRAM used by post
3171 (Power On Self Tests). This definition overrides
3172 #define'd default value in commproc.h resp.
3173 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003174
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003175- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3176 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3177 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3178 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3179 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3180 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3181 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3182 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003183 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003184
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003185- CONFIG_PCI_DISABLE_PCIE:
3186 Disable PCI-Express on systems where it is supported but not
3187 required.
3188
Kumar Galaa09b9b62010-12-30 12:09:53 -06003189- CONFIG_SYS_SRIO:
3190 Chip has SRIO or not
3191
3192- CONFIG_SRIO1:
3193 Board has SRIO 1 port available
3194
3195- CONFIG_SRIO2:
3196 Board has SRIO 2 port available
3197
3198- CONFIG_SYS_SRIOn_MEM_VIRT:
3199 Virtual Address of SRIO port 'n' memory region
3200
3201- CONFIG_SYS_SRIOn_MEM_PHYS:
3202 Physical Address of SRIO port 'n' memory region
3203
3204- CONFIG_SYS_SRIOn_MEM_SIZE:
3205 Size of SRIO port 'n' memory region
3206
Alex Watermaneced4622011-05-19 15:08:36 -04003207- CONFIG_SYS_NDFC_16
3208 Defined to tell the NDFC that the NAND chip is using a
3209 16 bit bus.
3210
3211- CONFIG_SYS_NDFC_EBC0_CFG
3212 Sets the EBC0_CFG register for the NDFC. If not defined
3213 a default value will be used.
3214
Ben Warrenbb99ad62006-09-07 16:50:54 -04003215- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003216 Get DDR timing information from an I2C EEPROM. Common
3217 with pluggable memory modules such as SODIMMs
3218
Ben Warrenbb99ad62006-09-07 16:50:54 -04003219 SPD_EEPROM_ADDRESS
3220 I2C address of the SPD EEPROM
3221
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003222- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003223 If SPD EEPROM is on an I2C bus other than the first
3224 one, specify here. Note that the value must resolve
3225 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003226
York Sun1b3e3c42011-06-07 09:42:16 +08003227- CONFIG_SYS_DDR_RAW_TIMING
3228 Get DDR timing information from other than SPD. Common with
3229 soldered DDR chips onboard without SPD. DDR raw timing
3230 parameters are extracted from datasheet and hard-coded into
3231 header files or board specific files.
3232
York Sun6f5e1dc2011-09-16 13:21:35 -07003233- CONFIG_FSL_DDR_INTERACTIVE
3234 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3235
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003236- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003237 Only for 83xx systems. If specified, then DDR should
3238 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003239
wdenkc26e4542004-04-18 10:13:26 +00003240- CONFIG_ETHER_ON_FEC[12]
3241 Define to enable FEC[12] on a 8xx series processor.
3242
3243- CONFIG_FEC[12]_PHY
3244 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003245 to the given FEC; i. e.
3246 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003247 means that the PHY with address 4 is connected to FEC1
3248
3249 When set to -1, means to probe for first available.
3250
3251- CONFIG_FEC[12]_PHY_NORXERR
3252 The PHY does not have a RXERR line (RMII only).
3253 (so program the FEC to ignore it).
3254
3255- CONFIG_RMII
3256 Enable RMII mode for all FECs.
3257 Note that this is a global option, we can't
3258 have one FEC in standard MII mode and another in RMII mode.
3259
wdenk5cf91d62004-04-23 20:32:05 +00003260- CONFIG_CRC32_VERIFY
3261 Add a verify option to the crc32 command.
3262 The syntax is:
3263
3264 => crc32 -v <address> <count> <crc32>
3265
3266 Where address/count indicate a memory area
3267 and crc32 is the correct crc32 which the
3268 area should have.
3269
wdenk56523f12004-07-11 17:40:54 +00003270- CONFIG_LOOPW
3271 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003272 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003273
stroese7b466642004-12-16 18:46:55 +00003274- CONFIG_MX_CYCLIC
3275 Add the "mdc" and "mwc" memory commands. These are cyclic
3276 "md/mw" commands.
3277 Examples:
3278
wdenkefe2a4d2004-12-16 21:44:03 +00003279 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003280 This command will print 4 bytes (10,11,12,13) each 500 ms.
3281
wdenkefe2a4d2004-12-16 21:44:03 +00003282 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003283 This command will write 12345678 to address 100 all 10 ms.
3284
wdenkefe2a4d2004-12-16 21:44:03 +00003285 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003286 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003287
wdenk8aa1a2d2005-04-04 12:44:11 +00003288- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003289 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003290 low level initializations (like setting up the memory
3291 controller) are omitted and/or U-Boot does not
3292 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003293
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003294 Normally this variable MUST NOT be defined. The only
3295 exception is when U-Boot is loaded (to RAM) by some
3296 other boot loader or by a debugger which performs
3297 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003298
Aneesh V401bb302011-07-13 05:11:07 +00003299- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003300 Modifies the behaviour of start.S when compiling a loader
3301 that is executed before the actual U-Boot. E.g. when
3302 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003303
Heiko Schocher68bb8292011-11-01 20:00:30 +00003304- CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3305 define this, if you want to read first the oob data
3306 and then the data. This is used for example on
3307 davinci plattforms.
3308
Matthias Weisserd8834a12011-03-10 21:36:32 +00003309- CONFIG_USE_ARCH_MEMCPY
3310 CONFIG_USE_ARCH_MEMSET
3311 If these options are used a optimized version of memcpy/memset will
3312 be used if available. These functions may be faster under some
3313 conditions but may increase the binary size.
3314
Timur Tabif2717b42011-11-22 09:21:25 -06003315Freescale QE/FMAN Firmware Support:
3316-----------------------------------
3317
3318The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3319loading of "firmware", which is encoded in the QE firmware binary format.
3320This firmware often needs to be loaded during U-Boot booting, so macros
3321are used to identify the storage device (NOR flash, SPI, etc) and the address
3322within that device.
3323
3324- CONFIG_SYS_QE_FMAN_FW_ADDR
3325 The address in the storage device where the firmware is located. The
3326 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3327 is also specified.
3328
3329- CONFIG_SYS_QE_FMAN_FW_LENGTH
3330 The maximum possible size of the firmware. The firmware binary format
3331 has a field that specifies the actual size of the firmware, but it
3332 might not be possible to read any part of the firmware unless some
3333 local storage is allocated to hold the entire firmware first.
3334
3335- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3336 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3337 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3338 virtual address in NOR flash.
3339
3340- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3341 Specifies that QE/FMAN firmware is located in NAND flash.
3342 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3343
3344- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3345 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3346 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3347
3348- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3349 Specifies that QE/FMAN firmware is located on the primary SPI
3350 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3351
3352
wdenkc6097192002-11-03 00:24:07 +00003353Building the Software:
3354======================
3355
Wolfgang Denk218ca722008-03-26 10:40:12 +01003356Building U-Boot has been tested in several native build environments
3357and in many different cross environments. Of course we cannot support
3358all possibly existing versions of cross development tools in all
3359(potentially obsolete) versions. In case of tool chain problems we
3360recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3361which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003362
Wolfgang Denk218ca722008-03-26 10:40:12 +01003363If you are not using a native environment, it is assumed that you
3364have GNU cross compiling tools available in your path. In this case,
3365you must set the environment variable CROSS_COMPILE in your shell.
3366Note that no changes to the Makefile or any other source files are
3367necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003368
Wolfgang Denk218ca722008-03-26 10:40:12 +01003369 $ CROSS_COMPILE=ppc_4xx-
3370 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003371
Peter Tyser2f8d3962009-03-13 18:54:51 -05003372Note: If you wish to generate Windows versions of the utilities in
3373 the tools directory you can use the MinGW toolchain
3374 (http://www.mingw.org). Set your HOST tools to the MinGW
3375 toolchain and execute 'make tools'. For example:
3376
3377 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3378
3379 Binaries such as tools/mkimage.exe will be created which can
3380 be executed on computers running Windows.
3381
Wolfgang Denk218ca722008-03-26 10:40:12 +01003382U-Boot is intended to be simple to build. After installing the
3383sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003384is done by typing:
3385
3386 make NAME_config
3387
Wolfgang Denk218ca722008-03-26 10:40:12 +01003388where "NAME_config" is the name of one of the existing configu-
3389rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003390
wdenk2729af92004-05-03 20:45:30 +00003391Note: for some board special configuration names may exist; check if
3392 additional information is available from the board vendor; for
3393 instance, the TQM823L systems are available without (standard)
3394 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003395 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003396
wdenk2729af92004-05-03 20:45:30 +00003397 make TQM823L_config
3398 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003399
wdenk2729af92004-05-03 20:45:30 +00003400 make TQM823L_LCD_config
3401 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403 etc.
wdenkc6097192002-11-03 00:24:07 +00003404
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406Finally, type "make all", and you should get some working U-Boot
3407images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003408
wdenk2729af92004-05-03 20:45:30 +00003409- "u-boot.bin" is a raw binary image
3410- "u-boot" is an image in ELF binary format
3411- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003412
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003413By default the build is performed locally and the objects are saved
3414in the source directory. One of the two methods can be used to change
3415this behavior and build U-Boot to some external directory:
3416
34171. Add O= to the make command line invocations:
3418
3419 make O=/tmp/build distclean
3420 make O=/tmp/build NAME_config
3421 make O=/tmp/build all
3422
34232. Set environment variable BUILD_DIR to point to the desired location:
3424
3425 export BUILD_DIR=/tmp/build
3426 make distclean
3427 make NAME_config
3428 make all
3429
3430Note that the command line "O=" setting overrides the BUILD_DIR environment
3431variable.
3432
wdenkc6097192002-11-03 00:24:07 +00003433
wdenk2729af92004-05-03 20:45:30 +00003434Please be aware that the Makefiles assume you are using GNU make, so
3435for instance on NetBSD you might need to use "gmake" instead of
3436native "make".
wdenkc6097192002-11-03 00:24:07 +00003437
wdenkc6097192002-11-03 00:24:07 +00003438
wdenk2729af92004-05-03 20:45:30 +00003439If the system board that you have is not listed, then you will need
3440to port U-Boot to your hardware platform. To do this, follow these
3441steps:
wdenkc6097192002-11-03 00:24:07 +00003442
wdenk2729af92004-05-03 20:45:30 +000034431. Add a new configuration option for your board to the toplevel
3444 "Makefile" and to the "MAKEALL" script, using the existing
3445 entries as examples. Note that here and at many other places
3446 boards and other names are listed in alphabetical sort order. Please
3447 keep this order.
34482. Create a new directory to hold your board specific code. Add any
3449 files you need. In your board directory, you will need at least
3450 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
34513. Create a new configuration file "include/configs/<board>.h" for
3452 your board
34533. If you're porting U-Boot to a new CPU, then also create a new
3454 directory to hold your CPU specific code. Add any files you need.
34554. Run "make <board>_config" with your new name.
34565. Type "make", and you should get a working "u-boot.srec" file
3457 to be installed on your target system.
34586. Debug and solve any problems that might arise.
3459 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003460
wdenkc6097192002-11-03 00:24:07 +00003461
wdenk2729af92004-05-03 20:45:30 +00003462Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3463==============================================================
wdenkc6097192002-11-03 00:24:07 +00003464
Wolfgang Denk218ca722008-03-26 10:40:12 +01003465If you have modified U-Boot sources (for instance added a new board
3466or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003467provide feedback to the other developers. The feedback normally takes
3468the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003469official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003470
Wolfgang Denk218ca722008-03-26 10:40:12 +01003471But before you submit such a patch, please verify that your modifi-
3472cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003473the supported boards compile WITHOUT ANY compiler warnings. To do so,
3474just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003475for ALL supported system. Be warned, this will take a while. You can
3476select which (cross) compiler to use by passing a `CROSS_COMPILE'
3477environment variable to the script, i. e. to use the ELDK cross tools
3478you can type
wdenkc6097192002-11-03 00:24:07 +00003479
wdenk2729af92004-05-03 20:45:30 +00003480 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk2729af92004-05-03 20:45:30 +00003482or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk2729af92004-05-03 20:45:30 +00003484 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003485
Wolfgang Denk218ca722008-03-26 10:40:12 +01003486When using the MAKEALL script, the default behaviour is to build
3487U-Boot in the source directory. This location can be changed by
3488setting the BUILD_DIR environment variable. Also, for each target
3489built, the MAKEALL script saves two log files (<target>.ERR and
3490<target>.MAKEALL) in the <source dir>/LOG directory. This default
3491location can be changed by setting the MAKEALL_LOGDIR environment
3492variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003493
3494 export BUILD_DIR=/tmp/build
3495 export MAKEALL_LOGDIR=/tmp/log
3496 CROSS_COMPILE=ppc_8xx- MAKEALL
3497
Wolfgang Denk218ca722008-03-26 10:40:12 +01003498With the above settings build objects are saved in the /tmp/build,
3499log files are saved in the /tmp/log and the source tree remains clean
3500during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003501
3502
wdenk2729af92004-05-03 20:45:30 +00003503See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003504
wdenkc6097192002-11-03 00:24:07 +00003505
wdenk2729af92004-05-03 20:45:30 +00003506Monitor Commands - Overview:
3507============================
wdenkc6097192002-11-03 00:24:07 +00003508
wdenk2729af92004-05-03 20:45:30 +00003509go - start application at address 'addr'
3510run - run commands in an environment variable
3511bootm - boot application image from memory
3512bootp - boot image via network using BootP/TFTP protocol
3513tftpboot- boot image via network using TFTP protocol
3514 and env variables "ipaddr" and "serverip"
3515 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003516tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003517rarpboot- boot image via network using RARP/TFTP protocol
3518diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3519loads - load S-Record file over serial line
3520loadb - load binary file over serial line (kermit mode)
3521md - memory display
3522mm - memory modify (auto-incrementing)
3523nm - memory modify (constant address)
3524mw - memory write (fill)
3525cp - memory copy
3526cmp - memory compare
3527crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003528i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003529sspi - SPI utility commands
3530base - print or set address offset
3531printenv- print environment variables
3532setenv - set environment variables
3533saveenv - save environment variables to persistent storage
3534protect - enable or disable FLASH write protection
3535erase - erase FLASH memory
3536flinfo - print FLASH memory information
3537bdinfo - print Board Info structure
3538iminfo - print header information for application image
3539coninfo - print console devices and informations
3540ide - IDE sub-system
3541loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003542loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003543mtest - simple RAM test
3544icache - enable or disable instruction cache
3545dcache - enable or disable data cache
3546reset - Perform RESET of the CPU
3547echo - echo args to console
3548version - print monitor version
3549help - print online help
3550? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003551
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk2729af92004-05-03 20:45:30 +00003553Monitor Commands - Detailed Description:
3554========================================
wdenkc6097192002-11-03 00:24:07 +00003555
wdenk2729af92004-05-03 20:45:30 +00003556TODO.
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk2729af92004-05-03 20:45:30 +00003558For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003559
3560
wdenk2729af92004-05-03 20:45:30 +00003561Environment Variables:
3562======================
wdenkc6097192002-11-03 00:24:07 +00003563
wdenk2729af92004-05-03 20:45:30 +00003564U-Boot supports user configuration using Environment Variables which
3565can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003566
wdenk2729af92004-05-03 20:45:30 +00003567Environment Variables are set using "setenv", printed using
3568"printenv", and saved to Flash using "saveenv". Using "setenv"
3569without a value can be used to delete a variable from the
3570environment. As long as you don't save the environment you are
3571working with an in-memory copy. In case the Flash area containing the
3572environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003573
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003574Some configuration options can be set using Environment Variables.
3575
3576List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003577
wdenk2729af92004-05-03 20:45:30 +00003578 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003579
wdenk2729af92004-05-03 20:45:30 +00003580 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003581
wdenk2729af92004-05-03 20:45:30 +00003582 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003583
wdenk2729af92004-05-03 20:45:30 +00003584 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003585
wdenk2729af92004-05-03 20:45:30 +00003586 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003587
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003588 bootm_low - Memory range available for image processing in the bootm
3589 command can be restricted. This variable is given as
3590 a hexadecimal number and defines lowest address allowed
3591 for use by the bootm command. See also "bootm_size"
3592 environment variable. Address defined by "bootm_low" is
3593 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003594 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3595 bootm_mapsize.
3596
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003597 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003598 This variable is given as a hexadecimal number and it
3599 defines the size of the memory region starting at base
3600 address bootm_low that is accessible by the Linux kernel
3601 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3602 as the default value if it is defined, and bootm_size is
3603 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003604
3605 bootm_size - Memory range available for image processing in the bootm
3606 command can be restricted. This variable is given as
3607 a hexadecimal number and defines the size of the region
3608 allowed for use by the bootm command. See also "bootm_low"
3609 environment variable.
3610
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003611 updatefile - Location of the software update file on a TFTP server, used
3612 by the automatic software update feature. Please refer to
3613 documentation in doc/README.update for more details.
3614
wdenk2729af92004-05-03 20:45:30 +00003615 autoload - if set to "no" (any string beginning with 'n'),
3616 "bootp" will just load perform a lookup of the
3617 configuration from the BOOTP server, but not try to
3618 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003619
wdenk2729af92004-05-03 20:45:30 +00003620 autostart - if set to "yes", an image loaded using the "bootp",
3621 "rarpboot", "tftpboot" or "diskboot" commands will
3622 be automatically started (by internally calling
3623 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003624
wdenk2729af92004-05-03 20:45:30 +00003625 If set to "no", a standalone image passed to the
3626 "bootm" command will be copied to the load address
3627 (and eventually uncompressed), but NOT be started.
3628 This can be used to load and uncompress arbitrary
3629 data.
wdenkc6097192002-11-03 00:24:07 +00003630
David A. Longa28afca2011-07-09 16:40:19 -04003631 fdt_high - if set this restricts the maximum address that the
3632 flattened device tree will be copied into upon boot.
Shawn Guo3e306c72012-01-11 13:35:06 +01003633 For example, if you have a system with 1 GB memory
3634 at physical address 0x10000000, while Linux kernel
3635 only recognizes the first 704 MB as low memory, you
3636 may need to set fdt_high as 0x3C000000 to have the
3637 device tree blob be copied to the maximum address
3638 of the 704 MB low memory, so that Linux kernel can
3639 access it during the boot procedure.
3640
David A. Longa28afca2011-07-09 16:40:19 -04003641 If this is set to the special value 0xFFFFFFFF then
3642 the fdt will not be copied at all on boot. For this
3643 to work it must reside in writable memory, have
3644 sufficient padding on the end of it for u-boot to
3645 add the information it needs into it, and the memory
3646 must be accessible by the kernel.
3647
Simon Glasseea63e02011-10-24 19:15:34 +00003648 fdtcontroladdr- if set this is the address of the control flattened
3649 device tree used by U-Boot when CONFIG_OF_CONTROL is
3650 defined.
3651
wdenk17ea1172004-06-06 21:51:03 +00003652 i2cfast - (PPC405GP|PPC405EP only)
3653 if set to 'y' configures Linux I2C driver for fast
3654 mode (400kHZ). This environment variable is used in
3655 initialization code. So, for changes to be effective
3656 it must be saved and board must be reset.
3657
wdenk2729af92004-05-03 20:45:30 +00003658 initrd_high - restrict positioning of initrd images:
3659 If this variable is not set, initrd images will be
3660 copied to the highest possible address in RAM; this
3661 is usually what you want since it allows for
3662 maximum initrd size. If for some reason you want to
3663 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003664 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003665 variable to a value of "no" or "off" or "0".
3666 Alternatively, you can set it to a maximum upper
3667 address to use (U-Boot will still check that it
3668 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003669
wdenk2729af92004-05-03 20:45:30 +00003670 For instance, when you have a system with 16 MB
3671 RAM, and want to reserve 4 MB from use by Linux,
3672 you can do this by adding "mem=12M" to the value of
3673 the "bootargs" variable. However, now you must make
3674 sure that the initrd image is placed in the first
3675 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003676
wdenk2729af92004-05-03 20:45:30 +00003677 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003678
wdenk2729af92004-05-03 20:45:30 +00003679 If you set initrd_high to 0xFFFFFFFF, this is an
3680 indication to U-Boot that all addresses are legal
3681 for the Linux kernel, including addresses in flash
3682 memory. In this case U-Boot will NOT COPY the
3683 ramdisk at all. This may be useful to reduce the
3684 boot time on your system, but requires that this
3685 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003686
wdenk2729af92004-05-03 20:45:30 +00003687 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003688
wdenk2729af92004-05-03 20:45:30 +00003689 loadaddr - Default load address for commands like "bootp",
3690 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003691
wdenk2729af92004-05-03 20:45:30 +00003692 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003693
wdenk2729af92004-05-03 20:45:30 +00003694 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003695
wdenk2729af92004-05-03 20:45:30 +00003696 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003697
wdenk2729af92004-05-03 20:45:30 +00003698 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk2729af92004-05-03 20:45:30 +00003700 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003701
Mike Frysingere2a53452011-10-02 10:01:27 +00003702 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003703
Mike Frysingere2a53452011-10-02 10:01:27 +00003704 ethact - controls which interface is currently active.
3705 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003706
Heiko Schocher48690d82010-07-20 17:45:02 +02003707 => setenv ethact FEC
3708 => ping 192.168.0.1 # traffic sent on FEC
3709 => setenv ethact SCC
3710 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003711
Matthias Fuchse1692572008-01-17 07:45:05 +01003712 ethrotate - When set to "no" U-Boot does not go through all
3713 available network interfaces.
3714 It just stays at the currently selected interface.
3715
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003716 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003717 either succeed or fail without retrying.
3718 When set to "once" the network operation will
3719 fail when all the available network interfaces
3720 are tried once without success.
3721 Useful on scripts which control the retry operation
3722 themselves.
wdenkc6097192002-11-03 00:24:07 +00003723
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003724 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003725
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003726 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003727 UDP source port.
3728
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003729 tftpdstport - If this is set, the value is used for TFTP's UDP
3730 destination port instead of the Well Know Port 69.
3731
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003732 tftpblocksize - Block size to use for TFTP transfers; if not set,
3733 we use the TFTP server's default block size
3734
3735 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3736 seconds, minimum value is 1000 = 1 second). Defines
3737 when a packet is considered to be lost so it has to
3738 be retransmitted. The default is 5000 = 5 seconds.
3739 Lowering this value may make downloads succeed
3740 faster in networks with high packet loss rates or
3741 with unreliable TFTP servers.
3742
3743 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003744 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003745 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003746
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003747The following image location variables contain the location of images
3748used in booting. The "Image" column gives the role of the image and is
3749not an environment variable name. The other columns are environment
3750variable names. "File Name" gives the name of the file on a TFTP
3751server, "RAM Address" gives the location in RAM the image will be
3752loaded to, and "Flash Location" gives the image's address in NOR
3753flash or offset in NAND flash.
3754
3755*Note* - these variables don't have to be defined for all boards, some
3756boards currenlty use other variables for these purposes, and some
3757boards use these variables for other purposes.
3758
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003759Image File Name RAM Address Flash Location
3760----- --------- ----------- --------------
3761u-boot u-boot u-boot_addr_r u-boot_addr
3762Linux kernel bootfile kernel_addr_r kernel_addr
3763device tree blob fdtfile fdt_addr_r fdt_addr
3764ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003765
wdenk2729af92004-05-03 20:45:30 +00003766The following environment variables may be used and automatically
3767updated by the network boot commands ("bootp" and "rarpboot"),
3768depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770 bootfile - see above
3771 dnsip - IP address of your Domain Name Server
3772 dnsip2 - IP address of your secondary Domain Name Server
3773 gatewayip - IP address of the Gateway (Router) to use
3774 hostname - Target hostname
3775 ipaddr - see above
3776 netmask - Subnet Mask
3777 rootpath - Pathname of the root filesystem on the NFS server
3778 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003779
wdenka3d991b2004-04-15 21:48:45 +00003780
wdenk2729af92004-05-03 20:45:30 +00003781There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003782
wdenk2729af92004-05-03 20:45:30 +00003783 serial# - contains hardware identification information such
3784 as type string and/or serial number
3785 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003786
wdenk2729af92004-05-03 20:45:30 +00003787These variables can be set only once (usually during manufacturing of
3788the board). U-Boot refuses to delete or overwrite these variables
3789once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003790
3791
wdenk2729af92004-05-03 20:45:30 +00003792Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003793
wdenk2729af92004-05-03 20:45:30 +00003794 ver - Contains the U-Boot version string as printed
3795 with the "version" command. This variable is
3796 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003797
wdenkc6097192002-11-03 00:24:07 +00003798
wdenk2729af92004-05-03 20:45:30 +00003799Please note that changes to some configuration parameters may take
3800only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003801
stroesec1551ea2003-04-04 15:53:41 +00003802
wdenk2729af92004-05-03 20:45:30 +00003803Command Line Parsing:
3804=====================
stroesec1551ea2003-04-04 15:53:41 +00003805
wdenk2729af92004-05-03 20:45:30 +00003806There are two different command line parsers available with U-Boot:
3807the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003808
wdenk2729af92004-05-03 20:45:30 +00003809Old, simple command line parser:
3810--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003811
wdenk2729af92004-05-03 20:45:30 +00003812- supports environment variables (through setenv / saveenv commands)
3813- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003814- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003815- special characters ('$', ';') can be escaped by prefixing with '\',
3816 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003817 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003818- You can also escape text by enclosing in single apostrophes, for example:
3819 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk2729af92004-05-03 20:45:30 +00003821Hush shell:
3822-----------
wdenkf07771c2003-05-28 08:06:31 +00003823
wdenk2729af92004-05-03 20:45:30 +00003824- similar to Bourne shell, with control structures like
3825 if...then...else...fi, for...do...done; while...do...done,
3826 until...do...done, ...
3827- supports environment ("global") variables (through setenv / saveenv
3828 commands) and local shell variables (through standard shell syntax
3829 "name=value"); only environment variables can be used with "run"
3830 command
wdenkf07771c2003-05-28 08:06:31 +00003831
wdenk2729af92004-05-03 20:45:30 +00003832General rules:
3833--------------
wdenkf07771c2003-05-28 08:06:31 +00003834
wdenk2729af92004-05-03 20:45:30 +00003835(1) If a command line (or an environment variable executed by a "run"
3836 command) contains several commands separated by semicolon, and
3837 one of these commands fails, then the remaining commands will be
3838 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003841 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003842 command will cause "run" to terminate, i. e. the remaining
3843 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003844
wdenk2729af92004-05-03 20:45:30 +00003845Note for Redundant Ethernet Interfaces:
3846=======================================
wdenkf07771c2003-05-28 08:06:31 +00003847
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003848Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003849such configurations and is capable of automatic selection of a
3850"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003851
wdenk2729af92004-05-03 20:45:30 +00003852Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3853MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3854"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003855
wdenk2729af92004-05-03 20:45:30 +00003856If the network interface stores some valid MAC address (for instance
3857in SROM), this is used as default address if there is NO correspon-
3858ding setting in the environment; if the corresponding environment
3859variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003860
wdenk2729af92004-05-03 20:45:30 +00003861o If the SROM has a valid MAC address, and there is no address in the
3862 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864o If there is no valid address in the SROM, and a definition in the
3865 environment exists, then the value from the environment variable is
3866 used.
wdenkc6097192002-11-03 00:24:07 +00003867
wdenk2729af92004-05-03 20:45:30 +00003868o If both the SROM and the environment contain a MAC address, and
3869 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003870
wdenk2729af92004-05-03 20:45:30 +00003871o If both the SROM and the environment contain a MAC address, and the
3872 addresses differ, the value from the environment is used and a
3873 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003874
wdenk2729af92004-05-03 20:45:30 +00003875o If neither SROM nor the environment contain a MAC address, an error
3876 is raised.
wdenkc6097192002-11-03 00:24:07 +00003877
Ben Warrenecee9322010-04-26 11:11:46 -07003878If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003879will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07003880may be skipped by setting the appropriate 'ethmacskip' environment variable.
3881The naming convention is as follows:
3882"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884Image Formats:
3885==============
wdenkc6097192002-11-03 00:24:07 +00003886
Marian Balakowicz3310c542008-03-12 12:13:13 +01003887U-Boot is capable of booting (and performing other auxiliary operations on)
3888images in two formats:
3889
3890New uImage format (FIT)
3891-----------------------
3892
3893Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3894to Flattened Device Tree). It allows the use of images with multiple
3895components (several kernels, ramdisks, etc.), with contents protected by
3896SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3897
3898
3899Old uImage format
3900-----------------
3901
3902Old image format is based on binary files which can be basically anything,
3903preceded by a special header; see the definitions in include/image.h for
3904details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk2729af92004-05-03 20:45:30 +00003906* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3907 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003908 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3909 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3910 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003911* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003912 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3913 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003914* Compression Type (uncompressed, gzip, bzip2)
3915* Load Address
3916* Entry Point
3917* Image Name
3918* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk2729af92004-05-03 20:45:30 +00003920The header is marked by a special Magic Number, and both the header
3921and the data portions of the image are secured against corruption by
3922CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003923
wdenkc6097192002-11-03 00:24:07 +00003924
wdenk2729af92004-05-03 20:45:30 +00003925Linux Support:
3926==============
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk2729af92004-05-03 20:45:30 +00003928Although U-Boot should support any OS or standalone application
3929easily, the main focus has always been on Linux during the design of
3930U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003931
wdenk2729af92004-05-03 20:45:30 +00003932U-Boot includes many features that so far have been part of some
3933special "boot loader" code within the Linux kernel. Also, any
3934"initrd" images to be used are no longer part of one big Linux image;
3935instead, kernel and "initrd" are separate images. This implementation
3936serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003937
wdenk2729af92004-05-03 20:45:30 +00003938- the same features can be used for other OS or standalone
3939 applications (for instance: using compressed images to reduce the
3940 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003941
wdenk2729af92004-05-03 20:45:30 +00003942- it becomes much easier to port new Linux kernel versions because
3943 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945- the same Linux kernel image can now be used with different "initrd"
3946 images; of course this also means that different kernel images can
3947 be run with the same "initrd". This makes testing easier (you don't
3948 have to build a new "zImage.initrd" Linux image when you just
3949 change a file in your "initrd"). Also, a field-upgrade of the
3950 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003951
wdenkc6097192002-11-03 00:24:07 +00003952
wdenk2729af92004-05-03 20:45:30 +00003953Linux HOWTO:
3954============
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk2729af92004-05-03 20:45:30 +00003956Porting Linux to U-Boot based systems:
3957---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003958
wdenk2729af92004-05-03 20:45:30 +00003959U-Boot cannot save you from doing all the necessary modifications to
3960configure the Linux device drivers for use with your target hardware
3961(no, we don't intend to provide a full virtual machine interface to
3962Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003963
Stefan Roesea47a12b2010-04-15 16:07:28 +02003964But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003965
wdenk2729af92004-05-03 20:45:30 +00003966Just make sure your machine specific header file (for instance
3967include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003968Information structure as we define in include/asm-<arch>/u-boot.h,
3969and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003970as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003971
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973Configuring the Linux kernel:
3974-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk2729af92004-05-03 20:45:30 +00003976No specific requirements for U-Boot. Make sure you have some root
3977device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003978
wdenkc6097192002-11-03 00:24:07 +00003979
wdenk2729af92004-05-03 20:45:30 +00003980Building a Linux Image:
3981-----------------------
wdenkc6097192002-11-03 00:24:07 +00003982
wdenk2729af92004-05-03 20:45:30 +00003983With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3984not used. If you use recent kernel source, a new build target
3985"uImage" will exist which automatically builds an image usable by
3986U-Boot. Most older kernels also have support for a "pImage" target,
3987which was introduced for our predecessor project PPCBoot and uses a
3988100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003989
wdenk2729af92004-05-03 20:45:30 +00003990Example:
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992 make TQM850L_config
3993 make oldconfig
3994 make dep
3995 make uImage
wdenkc6097192002-11-03 00:24:07 +00003996
wdenk2729af92004-05-03 20:45:30 +00003997The "uImage" build target uses a special tool (in 'tools/mkimage') to
3998encapsulate a compressed Linux kernel image with header information,
3999CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004000
wdenk2729af92004-05-03 20:45:30 +00004001* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004002
wdenk2729af92004-05-03 20:45:30 +00004003* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk2729af92004-05-03 20:45:30 +00004005 ${CROSS_COMPILE}-objcopy -O binary \
4006 -R .note -R .comment \
4007 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004008
wdenk2729af92004-05-03 20:45:30 +00004009* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004010
wdenk2729af92004-05-03 20:45:30 +00004011 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004012
wdenk2729af92004-05-03 20:45:30 +00004013* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004014
wdenk2729af92004-05-03 20:45:30 +00004015 mkimage -A ppc -O linux -T kernel -C gzip \
4016 -a 0 -e 0 -n "Linux Kernel Image" \
4017 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004018
wdenk24ee89b2002-11-03 17:56:27 +00004019
wdenk2729af92004-05-03 20:45:30 +00004020The "mkimage" tool can also be used to create ramdisk images for use
4021with U-Boot, either separated from the Linux kernel image, or
4022combined into one file. "mkimage" encapsulates the images with a 64
4023byte header containing information about target architecture,
4024operating system, image type, compression method, entry points, time
4025stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004026
wdenk2729af92004-05-03 20:45:30 +00004027"mkimage" can be called in two ways: to verify existing images and
4028print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004029
wdenk2729af92004-05-03 20:45:30 +00004030In the first form (with "-l" option) mkimage lists the information
4031contained in the header of an existing U-Boot image; this includes
4032checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004033
wdenk2729af92004-05-03 20:45:30 +00004034 tools/mkimage -l image
4035 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004036
wdenk2729af92004-05-03 20:45:30 +00004037The second form (with "-d" option) is used to build a U-Boot image
4038from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004039
wdenk2729af92004-05-03 20:45:30 +00004040 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4041 -n name -d data_file image
4042 -A ==> set architecture to 'arch'
4043 -O ==> set operating system to 'os'
4044 -T ==> set image type to 'type'
4045 -C ==> set compression type 'comp'
4046 -a ==> set load address to 'addr' (hex)
4047 -e ==> set entry point to 'ep' (hex)
4048 -n ==> set image name to 'name'
4049 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004050
wdenk69459792004-05-29 16:53:29 +00004051Right now, all Linux kernels for PowerPC systems use the same load
4052address (0x00000000), but the entry point address depends on the
4053kernel version:
wdenkc6097192002-11-03 00:24:07 +00004054
wdenk2729af92004-05-03 20:45:30 +00004055- 2.2.x kernels have the entry point at 0x0000000C,
4056- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004057
wdenk2729af92004-05-03 20:45:30 +00004058So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004059
wdenk2729af92004-05-03 20:45:30 +00004060 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4061 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004062 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004063 > examples/uImage.TQM850L
4064 Image Name: 2.4.4 kernel for TQM850L
4065 Created: Wed Jul 19 02:34:59 2000
4066 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4067 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4068 Load Address: 0x00000000
4069 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004072
wdenk2729af92004-05-03 20:45:30 +00004073 -> tools/mkimage -l examples/uImage.TQM850L
4074 Image Name: 2.4.4 kernel for TQM850L
4075 Created: Wed Jul 19 02:34:59 2000
4076 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4077 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4078 Load Address: 0x00000000
4079 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081NOTE: for embedded systems where boot time is critical you can trade
4082speed for memory and install an UNCOMPRESSED image instead: this
4083needs more space in Flash, but boots much faster since it does not
4084need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004085
Stefan Roesea47a12b2010-04-15 16:07:28 +02004086 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004087 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4088 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004089 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004090 > examples/uImage.TQM850L-uncompressed
4091 Image Name: 2.4.4 kernel for TQM850L
4092 Created: Wed Jul 19 02:34:59 2000
4093 Image Type: PowerPC Linux Kernel Image (uncompressed)
4094 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4095 Load Address: 0x00000000
4096 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004097
wdenkc6097192002-11-03 00:24:07 +00004098
wdenk2729af92004-05-03 20:45:30 +00004099Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4100when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004101
wdenk2729af92004-05-03 20:45:30 +00004102 -> tools/mkimage -n 'Simple Ramdisk Image' \
4103 > -A ppc -O linux -T ramdisk -C gzip \
4104 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4105 Image Name: Simple Ramdisk Image
4106 Created: Wed Jan 12 14:01:50 2000
4107 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4108 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4109 Load Address: 0x00000000
4110 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004111
wdenkdb01a2e2004-04-15 23:14:49 +00004112
wdenk2729af92004-05-03 20:45:30 +00004113Installing a Linux Image:
4114-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004115
wdenk2729af92004-05-03 20:45:30 +00004116To downloading a U-Boot image over the serial (console) interface,
4117you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004118
wdenk2729af92004-05-03 20:45:30 +00004119 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004120
wdenk2729af92004-05-03 20:45:30 +00004121The 'objcopy' does not understand the information in the U-Boot
4122image header, so the resulting S-Record file will be relative to
4123address 0x00000000. To load it to a given address, you need to
4124specify the target address as 'offset' parameter with the 'loads'
4125command.
wdenkc6097192002-11-03 00:24:07 +00004126
wdenk2729af92004-05-03 20:45:30 +00004127Example: install the image to address 0x40100000 (which on the
4128TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk2729af92004-05-03 20:45:30 +00004130 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004131
wdenk2729af92004-05-03 20:45:30 +00004132 .......... done
4133 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004134
wdenk2729af92004-05-03 20:45:30 +00004135 => loads 40100000
4136 ## Ready for S-Record download ...
4137 ~>examples/image.srec
4138 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4139 ...
4140 15989 15990 15991 15992
4141 [file transfer complete]
4142 [connected]
4143 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004144
4145
wdenk2729af92004-05-03 20:45:30 +00004146You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004147this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004148corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004149
wdenk2729af92004-05-03 20:45:30 +00004150 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004151
wdenk2729af92004-05-03 20:45:30 +00004152 ## Checking Image at 40100000 ...
4153 Image Name: 2.2.13 for initrd on TQM850L
4154 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4155 Data Size: 335725 Bytes = 327 kB = 0 MB
4156 Load Address: 00000000
4157 Entry Point: 0000000c
4158 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004159
4160
wdenk2729af92004-05-03 20:45:30 +00004161Boot Linux:
4162-----------
wdenkc6097192002-11-03 00:24:07 +00004163
wdenk2729af92004-05-03 20:45:30 +00004164The "bootm" command is used to boot an application that is stored in
4165memory (RAM or Flash). In case of a Linux kernel image, the contents
4166of the "bootargs" environment variable is passed to the kernel as
4167parameters. You can check and modify this variable using the
4168"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004169
4170
wdenk2729af92004-05-03 20:45:30 +00004171 => printenv bootargs
4172 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004173
wdenk2729af92004-05-03 20:45:30 +00004174 => 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 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176 => printenv bootargs
4177 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 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179 => bootm 40020000
4180 ## Booting Linux kernel at 40020000 ...
4181 Image Name: 2.2.13 for NFS on TQM850L
4182 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4183 Data Size: 381681 Bytes = 372 kB = 0 MB
4184 Load Address: 00000000
4185 Entry Point: 0000000c
4186 Verifying Checksum ... OK
4187 Uncompressing Kernel Image ... OK
4188 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
4189 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4190 time_init: decrementer frequency = 187500000/60
4191 Calibrating delay loop... 49.77 BogoMIPS
4192 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4193 ...
wdenkc6097192002-11-03 00:24:07 +00004194
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004195If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004196the memory addresses of both the kernel and the initrd image (PPBCOOT
4197format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004198
wdenk2729af92004-05-03 20:45:30 +00004199 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201 ## Checking Image at 40100000 ...
4202 Image Name: 2.2.13 for initrd on TQM850L
4203 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4204 Data Size: 335725 Bytes = 327 kB = 0 MB
4205 Load Address: 00000000
4206 Entry Point: 0000000c
4207 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004208
wdenk2729af92004-05-03 20:45:30 +00004209 ## Checking Image at 40200000 ...
4210 Image Name: Simple Ramdisk Image
4211 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4212 Data Size: 566530 Bytes = 553 kB = 0 MB
4213 Load Address: 00000000
4214 Entry Point: 00000000
4215 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004216
wdenk2729af92004-05-03 20:45:30 +00004217 => bootm 40100000 40200000
4218 ## Booting Linux kernel at 40100000 ...
4219 Image Name: 2.2.13 for initrd on TQM850L
4220 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4221 Data Size: 335725 Bytes = 327 kB = 0 MB
4222 Load Address: 00000000
4223 Entry Point: 0000000c
4224 Verifying Checksum ... OK
4225 Uncompressing Kernel Image ... OK
4226 ## Loading RAMDisk Image at 40200000 ...
4227 Image Name: Simple Ramdisk Image
4228 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4229 Data Size: 566530 Bytes = 553 kB = 0 MB
4230 Load Address: 00000000
4231 Entry Point: 00000000
4232 Verifying Checksum ... OK
4233 Loading Ramdisk ... OK
4234 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
4235 Boot arguments: root=/dev/ram
4236 time_init: decrementer frequency = 187500000/60
4237 Calibrating delay loop... 49.77 BogoMIPS
4238 ...
4239 RAMDISK: Compressed image found at block 0
4240 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004241
wdenk2729af92004-05-03 20:45:30 +00004242 bash#
wdenkc6097192002-11-03 00:24:07 +00004243
Matthew McClintock02677682006-06-28 10:41:37 -05004244Boot Linux and pass a flat device tree:
4245-----------
4246
4247First, U-Boot must be compiled with the appropriate defines. See the section
4248titled "Linux Kernel Interface" above for a more in depth explanation. The
4249following is an example of how to start a kernel and pass an updated
4250flat device tree:
4251
4252=> print oftaddr
4253oftaddr=0x300000
4254=> print oft
4255oft=oftrees/mpc8540ads.dtb
4256=> tftp $oftaddr $oft
4257Speed: 1000, full duplex
4258Using TSEC0 device
4259TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4260Filename 'oftrees/mpc8540ads.dtb'.
4261Load address: 0x300000
4262Loading: #
4263done
4264Bytes transferred = 4106 (100a hex)
4265=> tftp $loadaddr $bootfile
4266Speed: 1000, full duplex
4267Using TSEC0 device
4268TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4269Filename 'uImage'.
4270Load address: 0x200000
4271Loading:############
4272done
4273Bytes transferred = 1029407 (fb51f hex)
4274=> print loadaddr
4275loadaddr=200000
4276=> print oftaddr
4277oftaddr=0x300000
4278=> bootm $loadaddr - $oftaddr
4279## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004280 Image Name: Linux-2.6.17-dirty
4281 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4282 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004283 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004284 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004285 Verifying Checksum ... OK
4286 Uncompressing Kernel Image ... OK
4287Booting using flat device tree at 0x300000
4288Using MPC85xx ADS machine description
4289Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4290[snip]
4291
4292
wdenk2729af92004-05-03 20:45:30 +00004293More About U-Boot Image Types:
4294------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004295
wdenk2729af92004-05-03 20:45:30 +00004296U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004297
wdenk2729af92004-05-03 20:45:30 +00004298 "Standalone Programs" are directly runnable in the environment
4299 provided by U-Boot; it is expected that (if they behave
4300 well) you can continue to work in U-Boot after return from
4301 the Standalone Program.
4302 "OS Kernel Images" are usually images of some Embedded OS which
4303 will take over control completely. Usually these programs
4304 will install their own set of exception handlers, device
4305 drivers, set up the MMU, etc. - this means, that you cannot
4306 expect to re-enter U-Boot except by resetting the CPU.
4307 "RAMDisk Images" are more or less just data blocks, and their
4308 parameters (address, size) are passed to an OS kernel that is
4309 being started.
4310 "Multi-File Images" contain several images, typically an OS
4311 (Linux) kernel image and one or more data images like
4312 RAMDisks. This construct is useful for instance when you want
4313 to boot over the network using BOOTP etc., where the boot
4314 server provides just a single image file, but you want to get
4315 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004316
wdenk2729af92004-05-03 20:45:30 +00004317 "Multi-File Images" start with a list of image sizes, each
4318 image size (in bytes) specified by an "uint32_t" in network
4319 byte order. This list is terminated by an "(uint32_t)0".
4320 Immediately after the terminating 0 follow the images, one by
4321 one, all aligned on "uint32_t" boundaries (size rounded up to
4322 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004323
wdenk2729af92004-05-03 20:45:30 +00004324 "Firmware Images" are binary images containing firmware (like
4325 U-Boot or FPGA images) which usually will be programmed to
4326 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004327
wdenk2729af92004-05-03 20:45:30 +00004328 "Script files" are command sequences that will be executed by
4329 U-Boot's command interpreter; this feature is especially
4330 useful when you configure U-Boot to use a real shell (hush)
4331 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004332
wdenkc6097192002-11-03 00:24:07 +00004333
wdenk2729af92004-05-03 20:45:30 +00004334Standalone HOWTO:
4335=================
wdenkc6097192002-11-03 00:24:07 +00004336
wdenk2729af92004-05-03 20:45:30 +00004337One of the features of U-Boot is that you can dynamically load and
4338run "standalone" applications, which can use some resources of
4339U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004340
wdenk2729af92004-05-03 20:45:30 +00004341Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004342
wdenk2729af92004-05-03 20:45:30 +00004343"Hello World" Demo:
4344-------------------
wdenkc6097192002-11-03 00:24:07 +00004345
wdenk2729af92004-05-03 20:45:30 +00004346'examples/hello_world.c' contains a small "Hello World" Demo
4347application; it is automatically compiled when you build U-Boot.
4348It's configured to run at address 0x00040004, so you can play with it
4349like that:
wdenkc6097192002-11-03 00:24:07 +00004350
wdenk2729af92004-05-03 20:45:30 +00004351 => loads
4352 ## Ready for S-Record download ...
4353 ~>examples/hello_world.srec
4354 1 2 3 4 5 6 7 8 9 10 11 ...
4355 [file transfer complete]
4356 [connected]
4357 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004358
wdenk2729af92004-05-03 20:45:30 +00004359 => go 40004 Hello World! This is a test.
4360 ## Starting application at 0x00040004 ...
4361 Hello World
4362 argc = 7
4363 argv[0] = "40004"
4364 argv[1] = "Hello"
4365 argv[2] = "World!"
4366 argv[3] = "This"
4367 argv[4] = "is"
4368 argv[5] = "a"
4369 argv[6] = "test."
4370 argv[7] = "<NULL>"
4371 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004372
wdenk2729af92004-05-03 20:45:30 +00004373 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004374
wdenk2729af92004-05-03 20:45:30 +00004375Another example, which demonstrates how to register a CPM interrupt
4376handler with the U-Boot code, can be found in 'examples/timer.c'.
4377Here, a CPM timer is set up to generate an interrupt every second.
4378The interrupt service routine is trivial, just printing a '.'
4379character, but this is just a demo program. The application can be
4380controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004381
wdenk2729af92004-05-03 20:45:30 +00004382 ? - print current values og the CPM Timer registers
4383 b - enable interrupts and start timer
4384 e - stop timer and disable interrupts
4385 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004386
wdenk2729af92004-05-03 20:45:30 +00004387 => loads
4388 ## Ready for S-Record download ...
4389 ~>examples/timer.srec
4390 1 2 3 4 5 6 7 8 9 10 11 ...
4391 [file transfer complete]
4392 [connected]
4393 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004394
wdenk2729af92004-05-03 20:45:30 +00004395 => go 40004
4396 ## Starting application at 0x00040004 ...
4397 TIMERS=0xfff00980
4398 Using timer 1
4399 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004400
wdenk2729af92004-05-03 20:45:30 +00004401Hit 'b':
4402 [q, b, e, ?] Set interval 1000000 us
4403 Enabling timer
4404Hit '?':
4405 [q, b, e, ?] ........
4406 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4407Hit '?':
4408 [q, b, e, ?] .
4409 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4410Hit '?':
4411 [q, b, e, ?] .
4412 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4413Hit '?':
4414 [q, b, e, ?] .
4415 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4416Hit 'e':
4417 [q, b, e, ?] ...Stopping timer
4418Hit 'q':
4419 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004420
4421
wdenk2729af92004-05-03 20:45:30 +00004422Minicom warning:
4423================
wdenk85ec0bc2003-03-31 16:34:49 +00004424
wdenk2729af92004-05-03 20:45:30 +00004425Over time, many people have reported problems when trying to use the
4426"minicom" terminal emulation program for serial download. I (wd)
4427consider minicom to be broken, and recommend not to use it. Under
4428Unix, I recommend to use C-Kermit for general purpose use (and
4429especially for kermit binary protocol download ("loadb" command), and
4430use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004431
wdenk2729af92004-05-03 20:45:30 +00004432Nevertheless, if you absolutely want to use it try adding this
4433configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004434
wdenk2729af92004-05-03 20:45:30 +00004435 Name Program Name U/D FullScr IO-Red. Multi
4436 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4437 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004438
4439
wdenk2729af92004-05-03 20:45:30 +00004440NetBSD Notes:
4441=============
wdenkc6097192002-11-03 00:24:07 +00004442
wdenk2729af92004-05-03 20:45:30 +00004443Starting at version 0.9.2, U-Boot supports NetBSD both as host
4444(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004445
wdenk2729af92004-05-03 20:45:30 +00004446Building requires a cross environment; it is known to work on
4447NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4448need gmake since the Makefiles are not compatible with BSD make).
4449Note that the cross-powerpc package does not install include files;
4450attempting to build U-Boot will fail because <machine/ansi.h> is
4451missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004452
wdenk2729af92004-05-03 20:45:30 +00004453 # cd /usr/pkg/cross/powerpc-netbsd/include
4454 # mkdir powerpc
4455 # ln -s powerpc machine
4456 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4457 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004458
wdenk2729af92004-05-03 20:45:30 +00004459Native builds *don't* work due to incompatibilities between native
4460and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004461
wdenk2729af92004-05-03 20:45:30 +00004462Booting assumes that (the first part of) the image booted is a
4463stage-2 loader which in turn loads and then invokes the kernel
4464proper. Loader sources will eventually appear in the NetBSD source
4465tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004466meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004467
4468
wdenk2729af92004-05-03 20:45:30 +00004469Implementation Internals:
4470=========================
wdenkc6097192002-11-03 00:24:07 +00004471
wdenk2729af92004-05-03 20:45:30 +00004472The following is not intended to be a complete description of every
4473implementation detail. However, it should help to understand the
4474inner workings of U-Boot and make it easier to port it to custom
4475hardware.
wdenkc6097192002-11-03 00:24:07 +00004476
4477
wdenk2729af92004-05-03 20:45:30 +00004478Initial Stack, Global Data:
4479---------------------------
wdenkc6097192002-11-03 00:24:07 +00004480
wdenk2729af92004-05-03 20:45:30 +00004481The implementation of U-Boot is complicated by the fact that U-Boot
4482starts running out of ROM (flash memory), usually without access to
4483system RAM (because the memory controller is not initialized yet).
4484This means that we don't have writable Data or BSS segments, and BSS
4485is not initialized as zero. To be able to get a C environment working
4486at all, we have to allocate at least a minimal stack. Implementation
4487options for this are defined and restricted by the CPU used: Some CPU
4488models provide on-chip memory (like the IMMR area on MPC8xx and
4489MPC826x processors), on others (parts of) the data cache can be
4490locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004491
Wolfgang Denk218ca722008-03-26 10:40:12 +01004492 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004493 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004494
wdenk2729af92004-05-03 20:45:30 +00004495 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4496 From: "Chris Hallinan" <clh@net1plus.com>
4497 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4498 ...
wdenk43d96162003-03-06 00:02:04 +00004499
wdenk2729af92004-05-03 20:45:30 +00004500 Correct me if I'm wrong, folks, but the way I understand it
4501 is this: Using DCACHE as initial RAM for Stack, etc, does not
4502 require any physical RAM backing up the cache. The cleverness
4503 is that the cache is being used as a temporary supply of
4504 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004505 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004506 can see how this works by studying the cache architecture and
4507 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004508
wdenk2729af92004-05-03 20:45:30 +00004509 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4510 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004511 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004512 option should work for you. Using CS 4 should be fine if your
4513 board designers haven't used it for something that would
4514 cause you grief during the initial boot! It is frequently not
4515 used.
wdenk43d96162003-03-06 00:02:04 +00004516
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004517 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004518 with your processor/board/system design. The default value
4519 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004520 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004521 than your SDRAM module. If you have a 64MB SDRAM module, set
4522 it above 400_0000. Just make sure your board has no resources
4523 that are supposed to respond to that address! That code in
4524 start.S has been around a while and should work as is when
4525 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004526
wdenk2729af92004-05-03 20:45:30 +00004527 -Chris Hallinan
4528 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004529
wdenk2729af92004-05-03 20:45:30 +00004530It is essential to remember this, since it has some impact on the C
4531code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk2729af92004-05-03 20:45:30 +00004533* Initialized global data (data segment) is read-only. Do not attempt
4534 to write it.
wdenkc6097192002-11-03 00:24:07 +00004535
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004536* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004537 as zero data - BSS segment) at all - this is undefined, initiali-
4538 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk2729af92004-05-03 20:45:30 +00004540* Stack space is very limited. Avoid big data buffers or things like
4541 that.
wdenkc6097192002-11-03 00:24:07 +00004542
wdenk2729af92004-05-03 20:45:30 +00004543Having only the stack as writable memory limits means we cannot use
4544normal global data to share information beween the code. But it
4545turned out that the implementation of U-Boot can be greatly
4546simplified by making a global data structure (gd_t) available to all
4547functions. We could pass a pointer to this data as argument to _all_
4548functions, but this would bloat the code. Instead we use a feature of
4549the GCC compiler (Global Register Variables) to share the data: we
4550place a pointer (gd) to the global data into a register which we
4551reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004552
wdenk2729af92004-05-03 20:45:30 +00004553When choosing a register for such a purpose we are restricted by the
4554relevant (E)ABI specifications for the current architecture, and by
4555GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004556
wdenk2729af92004-05-03 20:45:30 +00004557For PowerPC, the following registers have specific use:
4558 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004559 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004560 R3-R4: parameter passing and return values
4561 R5-R10: parameter passing
4562 R13: small data area pointer
4563 R30: GOT pointer
4564 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004565
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004566 (U-Boot also uses R12 as internal GOT pointer. r12
4567 is a volatile register so r12 needs to be reset when
4568 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004569
Wolfgang Denke7670f62008-02-14 22:43:22 +01004570 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk2729af92004-05-03 20:45:30 +00004572 Note: on PPC, we could use a static initializer (since the
4573 address of the global data structure is known at compile time),
4574 but it turned out that reserving a register results in somewhat
4575 smaller code - although the code savings are not that big (on
4576 average for all boards 752 bytes for the whole U-Boot image,
4577 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004578
Robin Getzc4db3352009-08-17 15:23:02 +00004579On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004580 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4581
Robin Getzc4db3352009-08-17 15:23:02 +00004582 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004583
wdenk2729af92004-05-03 20:45:30 +00004584On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004585
wdenk2729af92004-05-03 20:45:30 +00004586 R0: function argument word/integer result
4587 R1-R3: function argument word
4588 R9: GOT pointer
4589 R10: stack limit (used only if stack checking if enabled)
4590 R11: argument (frame) pointer
4591 R12: temporary workspace
4592 R13: stack pointer
4593 R14: link register
4594 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk2729af92004-05-03 20:45:30 +00004596 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004597
Thomas Chou0df01fd2010-05-21 11:08:03 +08004598On Nios II, the ABI is documented here:
4599 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4600
4601 ==> U-Boot will use gp to hold a pointer to the global data
4602
4603 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4604 to access small data sections, so gp is free.
4605
Macpaul Linafc1ce82011-10-19 20:41:11 +00004606On NDS32, the following registers are used:
4607
4608 R0-R1: argument/return
4609 R2-R5: argument
4610 R15: temporary register for assembler
4611 R16: trampoline register
4612 R28: frame pointer (FP)
4613 R29: global pointer (GP)
4614 R30: link register (LP)
4615 R31: stack pointer (SP)
4616 PC: program counter (PC)
4617
4618 ==> U-Boot will use R10 to hold a pointer to the global data
4619
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004620NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4621or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004622
wdenk2729af92004-05-03 20:45:30 +00004623Memory Management:
4624------------------
wdenkc6097192002-11-03 00:24:07 +00004625
wdenk2729af92004-05-03 20:45:30 +00004626U-Boot runs in system state and uses physical addresses, i.e. the
4627MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004628
wdenk2729af92004-05-03 20:45:30 +00004629The available memory is mapped to fixed addresses using the memory
4630controller. In this process, a contiguous block is formed for each
4631memory type (Flash, SDRAM, SRAM), even when it consists of several
4632physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004633
wdenk2729af92004-05-03 20:45:30 +00004634U-Boot is installed in the first 128 kB of the first Flash bank (on
4635TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4636booting and sizing and initializing DRAM, the code relocates itself
4637to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004638memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004639configuration setting]. Below that, a structure with global Board
4640Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004641
wdenk2729af92004-05-03 20:45:30 +00004642Additionally, some exception handler code is copied to the low 8 kB
4643of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk2729af92004-05-03 20:45:30 +00004645So a typical memory configuration with 16 MB of DRAM could look like
4646this:
wdenkc6097192002-11-03 00:24:07 +00004647
wdenk2729af92004-05-03 20:45:30 +00004648 0x0000 0000 Exception Vector code
4649 :
4650 0x0000 1FFF
4651 0x0000 2000 Free for Application Use
4652 :
4653 :
wdenkc6097192002-11-03 00:24:07 +00004654
wdenk2729af92004-05-03 20:45:30 +00004655 :
4656 :
4657 0x00FB FF20 Monitor Stack (Growing downward)
4658 0x00FB FFAC Board Info Data and permanent copy of global data
4659 0x00FC 0000 Malloc Arena
4660 :
4661 0x00FD FFFF
4662 0x00FE 0000 RAM Copy of Monitor Code
4663 ... eventually: LCD or video framebuffer
4664 ... eventually: pRAM (Protected RAM - unchanged by reset)
4665 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004666
4667
wdenk2729af92004-05-03 20:45:30 +00004668System Initialization:
4669----------------------
wdenkc6097192002-11-03 00:24:07 +00004670
wdenk2729af92004-05-03 20:45:30 +00004671In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004672(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004673configuration for CS0# this is a mirror of the onboard Flash memory.
4674To be able to re-map memory U-Boot then jumps to its link address.
4675To be able to implement the initialization code in C, a (small!)
4676initial stack is set up in the internal Dual Ported RAM (in case CPUs
4677which provide such a feature like MPC8xx or MPC8260), or in a locked
4678part of the data cache. After that, U-Boot initializes the CPU core,
4679the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004680
wdenk2729af92004-05-03 20:45:30 +00004681Next, all (potentially) available memory banks are mapped using a
4682preliminary mapping. For example, we put them on 512 MB boundaries
4683(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4684on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4685programmed for SDRAM access. Using the temporary configuration, a
4686simple memory test is run that determines the size of the SDRAM
4687banks.
wdenkc6097192002-11-03 00:24:07 +00004688
wdenk2729af92004-05-03 20:45:30 +00004689When there is more than one SDRAM bank, and the banks are of
4690different size, the largest is mapped first. For equal size, the first
4691bank (CS2#) is mapped first. The first mapping is always for address
46920x00000000, with any additional banks following immediately to create
4693contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk2729af92004-05-03 20:45:30 +00004695Then, the monitor installs itself at the upper end of the SDRAM area
4696and allocates memory for use by malloc() and for the global Board
4697Info data; also, the exception vector code is copied to the low RAM
4698pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004699
wdenk2729af92004-05-03 20:45:30 +00004700Only after this relocation will you have a "normal" C environment;
4701until that you are restricted in several ways, mostly because you are
4702running from ROM, and because the code will have to be relocated to a
4703new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004704
4705
wdenk2729af92004-05-03 20:45:30 +00004706U-Boot Porting Guide:
4707----------------------
wdenkc6097192002-11-03 00:24:07 +00004708
wdenk2729af92004-05-03 20:45:30 +00004709[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4710list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004711
4712
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004713int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004714{
4715 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004716
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004717 signal(SIGALRM, no_more_time);
4718 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004719
wdenk2729af92004-05-03 20:45:30 +00004720 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004721 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004722 return 0;
4723 }
4724
wdenk2729af92004-05-03 20:45:30 +00004725 Download latest U-Boot source;
4726
Wolfgang Denk06682362008-12-30 22:56:11 +01004727 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004728
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004729 if (clueless)
4730 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004731
wdenk2729af92004-05-03 20:45:30 +00004732 while (learning) {
4733 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004734 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4735 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004736 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004737 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004738 }
wdenkc6097192002-11-03 00:24:07 +00004739
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004740 if (available_money > toLocalCurrency ($2500))
4741 Buy a BDI3000;
4742 else
wdenk2729af92004-05-03 20:45:30 +00004743 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004744
4745 if (a similar board exists) { /* hopefully... */
4746 cp -a board/<similar> board/<myboard>
4747 cp include/configs/<similar>.h include/configs/<myboard>.h
4748 } else {
4749 Create your own board support subdirectory;
4750 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004751 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004752 Edit new board/<myboard> files
4753 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004754
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004755 while (!accepted) {
4756 while (!running) {
4757 do {
4758 Add / modify source code;
4759 } until (compiles);
4760 Debug;
4761 if (clueless)
4762 email("Hi, I am having problems...");
4763 }
4764 Send patch file to the U-Boot email list;
4765 if (reasonable critiques)
4766 Incorporate improvements from email list code review;
4767 else
4768 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004769 }
wdenkc6097192002-11-03 00:24:07 +00004770
wdenk2729af92004-05-03 20:45:30 +00004771 return 0;
4772}
4773
4774void no_more_time (int sig)
4775{
4776 hire_a_guru();
4777}
wdenkc6097192002-11-03 00:24:07 +00004778
4779
wdenk2729af92004-05-03 20:45:30 +00004780Coding Standards:
4781-----------------
wdenkc6097192002-11-03 00:24:07 +00004782
wdenk2729af92004-05-03 20:45:30 +00004783All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004784coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004785"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004786
Detlev Zundel2c051652006-09-01 15:39:02 +02004787Source files originating from a different project (for example the
4788MTD subsystem) are generally exempt from these guidelines and are not
4789reformated to ease subsequent migration to newer versions of those
4790sources.
4791
4792Please note that U-Boot is implemented in C (and to some small parts in
4793Assembler); no C++ is used, so please do not use C++ style comments (//)
4794in your code.
wdenk2729af92004-05-03 20:45:30 +00004795
4796Please also stick to the following formatting rules:
4797- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004798- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004799- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004800- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004801- do not add trailing empty lines to source files
4802
4803Submissions which do not conform to the standards may be returned
4804with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004805
4806
wdenk2729af92004-05-03 20:45:30 +00004807Submitting Patches:
4808-------------------
wdenkc6097192002-11-03 00:24:07 +00004809
wdenk2729af92004-05-03 20:45:30 +00004810Since the number of patches for U-Boot is growing, we need to
4811establish some rules. Submissions which do not conform to these rules
4812may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004813
Magnus Lilja0d28f342008-08-06 19:32:33 +02004814Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004815
Wolfgang Denk06682362008-12-30 22:56:11 +01004816Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4817see http://lists.denx.de/mailman/listinfo/u-boot
4818
wdenk2729af92004-05-03 20:45:30 +00004819When you send a patch, please include the following information with
4820it:
wdenkc6097192002-11-03 00:24:07 +00004821
wdenk2729af92004-05-03 20:45:30 +00004822* For bug fixes: a description of the bug and how your patch fixes
4823 this bug. Please try to include a way of demonstrating that the
4824 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004825
wdenk2729af92004-05-03 20:45:30 +00004826* For new features: a description of the feature and your
4827 implementation.
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk2729af92004-05-03 20:45:30 +00004829* A CHANGELOG entry as plaintext (separate from the patch)
4830
4831* For major contributions, your entry to the CREDITS file
4832
4833* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004834 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004835
4836* If your patch adds new configuration options, don't forget to
4837 document these in the README file.
4838
Wolfgang Denk218ca722008-03-26 10:40:12 +01004839* The patch itself. If you are using git (which is *strongly*
4840 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004841 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004842 the U-Boot mailing list, you will avoid most of the common problems
4843 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004844
Wolfgang Denk218ca722008-03-26 10:40:12 +01004845 If you cannot use git, use "diff -purN OLD NEW". If your version of
4846 diff does not support these options, then get the latest version of
4847 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004848
Wolfgang Denk218ca722008-03-26 10:40:12 +01004849 The current directory when running this command shall be the parent
4850 directory of the U-Boot source tree (i. e. please make sure that
4851 your patch includes sufficient directory information for the
4852 affected files).
4853
4854 We prefer patches as plain text. MIME attachments are discouraged,
4855 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004856
4857* If one logical set of modifications affects or creates several
4858 files, all these changes shall be submitted in a SINGLE patch file.
4859
4860* Changesets that contain different, unrelated modifications shall be
4861 submitted as SEPARATE patches, one patch per changeset.
4862
4863
4864Notes:
4865
4866* Before sending the patch, run the MAKEALL script on your patched
4867 source tree and make sure that no errors or warnings are reported
4868 for any of the boards.
4869
4870* Keep your modifications to the necessary minimum: A patch
4871 containing several unrelated changes or arbitrary reformats will be
4872 returned with a request to re-formatting / split it.
4873
4874* If you modify existing code, make sure that your new code does not
4875 add to the memory footprint of the code ;-) Small is beautiful!
4876 When adding new features, these should compile conditionally only
4877 (using #ifdef), and the resulting code with the new feature
4878 disabled must not need more memory than the old code without your
4879 modification.
wdenk90dc6702005-05-03 14:12:25 +00004880
Wolfgang Denk06682362008-12-30 22:56:11 +01004881* Remember that there is a size limit of 100 kB per message on the
4882 u-boot mailing list. Bigger patches will be moderated. If they are
4883 reasonable and not too big, they will be acknowledged. But patches
4884 bigger than the size limit should be avoided.