blob: e9d189108f70f2cf526395fd2db06e10e7ec10ab [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
wdenkc6097192002-11-03 00:24:07 +0000641- Boot Delay: CONFIG_BOOTDELAY - in seconds
642 Delay before automatically booting the default image;
643 set to -1 to disable autoboot.
644
645 See doc/README.autoboot for these options that
646 work with CONFIG_BOOTDELAY. None are required.
647 CONFIG_BOOT_RETRY_TIME
648 CONFIG_BOOT_RETRY_MIN
649 CONFIG_AUTOBOOT_KEYED
650 CONFIG_AUTOBOOT_PROMPT
651 CONFIG_AUTOBOOT_DELAY_STR
652 CONFIG_AUTOBOOT_STOP_STR
653 CONFIG_AUTOBOOT_DELAY_STR2
654 CONFIG_AUTOBOOT_STOP_STR2
655 CONFIG_ZERO_BOOTDELAY_CHECK
656 CONFIG_RESET_TO_RETRY
657
658- Autoboot Command:
659 CONFIG_BOOTCOMMAND
660 Only needed when CONFIG_BOOTDELAY is enabled;
661 define a command string that is automatically executed
662 when no character is read on the console interface
663 within "Boot Delay" after reset.
664
665 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000666 This can be used to pass arguments to the bootm
667 command. The value of CONFIG_BOOTARGS goes into the
668 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000669
670 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000671 The value of these goes into the environment as
672 "ramboot" and "nfsboot" respectively, and can be used
673 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200674 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000675
676- Pre-Boot Commands:
677 CONFIG_PREBOOT
678
679 When this option is #defined, the existence of the
680 environment variable "preboot" will be checked
681 immediately before starting the CONFIG_BOOTDELAY
682 countdown and/or running the auto-boot command resp.
683 entering interactive mode.
684
685 This feature is especially useful when "preboot" is
686 automatically generated or modified. For an example
687 see the LWMON board specific code: here "preboot" is
688 modified when the user holds down a certain
689 combination of keys on the (special) keyboard when
690 booting the systems
691
692- Serial Download Echo Mode:
693 CONFIG_LOADS_ECHO
694 If defined to 1, all characters received during a
695 serial download (using the "loads" command) are
696 echoed back. This might be needed by some terminal
697 emulations (like "cu"), but may as well just take
698 time on others. This setting #define's the initial
699 value of the "loads_echo" environment variable.
700
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500701- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000702 CONFIG_KGDB_BAUDRATE
703 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200704 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000705
706- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500707 Monitor commands can be included or excluded
708 from the build by using the #include files
709 "config_cmd_all.h" and #undef'ing unwanted
710 commands, or using "config_cmd_default.h"
711 and augmenting with additional #define's
712 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000713
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500714 The default command configuration includes all commands
715 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000716
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500717 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500718 CONFIG_CMD_BDI bdinfo
719 CONFIG_CMD_BEDBUG * Include BedBug Debugger
720 CONFIG_CMD_BMP * BMP support
721 CONFIG_CMD_BSP * Board specific commands
722 CONFIG_CMD_BOOTD bootd
723 CONFIG_CMD_CACHE * icache, dcache
724 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500725 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500726 CONFIG_CMD_DATE * support for RTC, date/time...
727 CONFIG_CMD_DHCP * DHCP support
728 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600729 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
730 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
731 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
732 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500733 CONFIG_CMD_DTT * Digital Therm and Thermostat
734 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500735 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500736 CONFIG_CMD_EEPROM * EEPROM read/write support
737 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500738 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500739 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500740 CONFIG_CMD_FDC * Floppy Disk Support
741 CONFIG_CMD_FAT * FAT partition support
742 CONFIG_CMD_FDOS * Dos diskette Support
743 CONFIG_CMD_FLASH flinfo, erase, protect
744 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500745 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000746 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500747 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
748 CONFIG_CMD_I2C * I2C serial bus support
749 CONFIG_CMD_IDE * IDE harddisk support
750 CONFIG_CMD_IMI iminfo
751 CONFIG_CMD_IMLS List all found images
752 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500753 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500754 CONFIG_CMD_IRQ * irqinfo
755 CONFIG_CMD_ITEST Integer/string test of 2 values
756 CONFIG_CMD_JFFS2 * JFFS2 Support
757 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500758 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500759 CONFIG_CMD_LOADB loadb
760 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400761 CONFIG_CMD_MD5SUM print md5 message digest
762 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500763 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
764 loop, loopw, mtest
765 CONFIG_CMD_MISC Misc functions like sleep etc
766 CONFIG_CMD_MMC * MMC memory mapped support
767 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100768 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500769 CONFIG_CMD_NAND * NAND support
770 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600771 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000772 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500773 CONFIG_CMD_PCI * pciinfo
774 CONFIG_CMD_PCMCIA * PCMCIA support
775 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
776 host
777 CONFIG_CMD_PORTIO * Port I/O
778 CONFIG_CMD_REGINFO * Register dump
779 CONFIG_CMD_RUN run command in env variable
780 CONFIG_CMD_SAVES * save S record dump
781 CONFIG_CMD_SCSI * SCSI Support
782 CONFIG_CMD_SDRAM * print SDRAM configuration information
783 (requires CONFIG_CMD_I2C)
784 CONFIG_CMD_SETGETDCR Support for DCR Register access
785 (4xx only)
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100786 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400787 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200788 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500789 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000790 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000791 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000792 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500793 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500794 CONFIG_CMD_CDP * Cisco Discover Protocol support
795 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000796
wdenkc6097192002-11-03 00:24:07 +0000797
798 EXAMPLE: If you want all functions except of network
799 support you can write:
800
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500801 #include "config_cmd_all.h"
802 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000803
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400804 Other Commands:
805 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000806
807 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500808 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000809 what you (and your U-Boot users) are doing. Data
810 cache cannot be enabled on systems like the 8xx or
811 8260 (where accesses to the IMMR region must be
812 uncached), and it cannot be disabled on all other
813 systems where we (mis-) use the data cache to hold an
814 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000815
816
817 XXX - this list needs to get updated!
818
Simon Glass45ba8072011-10-15 05:48:20 +0000819- Device tree:
820 CONFIG_OF_CONTROL
821 If this variable is defined, U-Boot will use a device tree
822 to configure its devices, instead of relying on statically
823 compiled #defines in the board file. This option is
824 experimental and only available on a few boards. The device
825 tree is available in the global data as gd->fdt_blob.
826
Simon Glass2c0f79e2011-10-24 19:15:31 +0000827 U-Boot needs to get its device tree from somewhere. This can
828 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000829
830 CONFIG_OF_EMBED
831 If this variable is defined, U-Boot will embed a device tree
832 binary in its image. This device tree file should be in the
833 board directory and called <soc>-<board>.dts. The binary file
834 is then picked up in board_init_f() and made available through
835 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000836
Simon Glass2c0f79e2011-10-24 19:15:31 +0000837 CONFIG_OF_SEPARATE
838 If this variable is defined, U-Boot will build a device tree
839 binary. It will be called u-boot.dtb. Architecture-specific
840 code will locate it at run-time. Generally this works by:
841
842 cat u-boot.bin u-boot.dtb >image.bin
843
844 and in fact, U-Boot does this for you, creating a file called
845 u-boot-dtb.bin which is useful in the common case. You can
846 still use the individual files if you need something more
847 exotic.
848
wdenkc6097192002-11-03 00:24:07 +0000849- Watchdog:
850 CONFIG_WATCHDOG
851 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000852 support for the SoC. There must be support in the SoC
853 specific code for a watchdog. For the 8xx and 8260
854 CPUs, the SIU Watchdog feature is enabled in the SYPCR
855 register. When supported for a specific SoC is
856 available, then no further board specific code should
857 be needed to use it.
858
859 CONFIG_HW_WATCHDOG
860 When using a watchdog circuitry external to the used
861 SoC, then define this variable and provide board
862 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000863
stroesec1551ea2003-04-04 15:53:41 +0000864- U-Boot Version:
865 CONFIG_VERSION_VARIABLE
866 If this variable is defined, an environment variable
867 named "ver" is created by U-Boot showing the U-Boot
868 version as printed by the "version" command.
869 This variable is readonly.
870
wdenkc6097192002-11-03 00:24:07 +0000871- Real-Time Clock:
872
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500873 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000874 has to be selected, too. Define exactly one of the
875 following options:
876
877 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
878 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000879 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000880 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000881 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000882 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000883 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000884 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100885 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000886 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200887 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200888 CONFIG_SYS_RV3029_TCR - enable trickle charger on
889 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000890
wdenkb37c7e52003-06-30 16:24:52 +0000891 Note that if the RTC uses I2C, then the I2C interface
892 must also be configured. See I2C Support, below.
893
Peter Tysere92739d2008-12-17 16:36:21 -0600894- GPIO Support:
895 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
896 CONFIG_PCA953X_INFO - enable pca953x info command
897
Chris Packham5dec49c2010-12-19 10:12:13 +0000898 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
899 chip-ngpio pairs that tell the PCA953X driver the number of
900 pins supported by a particular chip.
901
Peter Tysere92739d2008-12-17 16:36:21 -0600902 Note that if the GPIO device uses I2C, then the I2C interface
903 must also be configured. See I2C Support, below.
904
wdenkc6097192002-11-03 00:24:07 +0000905- Timestamp Support:
906
wdenk43d96162003-03-06 00:02:04 +0000907 When CONFIG_TIMESTAMP is selected, the timestamp
908 (date and time) of an image is printed by image
909 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500910 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000911
912- Partition Support:
913 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400914 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000915
Wolfgang Denk218ca722008-03-26 10:40:12 +0100916 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
917 CONFIG_CMD_SCSI) you must configure support for at
918 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000919
920- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000921 CONFIG_IDE_RESET_ROUTINE - this is defined in several
922 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000923
wdenk4d13cba2004-03-14 14:09:05 +0000924 CONFIG_IDE_RESET - is this is defined, IDE Reset will
925 be performed by calling the function
926 ide_set_reset(int reset)
927 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000928
929- ATAPI Support:
930 CONFIG_ATAPI
931
932 Set this to enable ATAPI support.
933
wdenkc40b2952004-03-13 23:29:43 +0000934- LBA48 Support
935 CONFIG_LBA48
936
937 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100938 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000939 Whithout these , LBA48 support uses 32bit variables and will 'only'
940 support disks up to 2.1TB.
941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200942 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000943 When enabled, makes the IDE subsystem use 64bit sector addresses.
944 Default is 32bit.
945
wdenkc6097192002-11-03 00:24:07 +0000946- SCSI Support:
947 At the moment only there is only support for the
948 SYM53C8XX SCSI controller; define
949 CONFIG_SCSI_SYM53C8XX to enable it.
950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200951 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
952 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
953 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000954 maximum numbers of LUNs, SCSI ID's and target
955 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200956 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000957
958- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000959 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000960 Support for Intel 8254x/8257x gigabit chips.
961
962 CONFIG_E1000_SPI
963 Utility code for direct access to the SPI bus on Intel 8257x.
964 This does not do anything useful unless you set at least one
965 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
966
967 CONFIG_E1000_SPI_GENERIC
968 Allow generic access to the SPI bus on the Intel 8257x, for
969 example with the "sspi" command.
970
971 CONFIG_CMD_E1000
972 Management command for E1000 devices. When used on devices
973 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +0000974
Andre Schwarzac3315c2008-03-06 16:45:44 +0100975 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200976 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100977
wdenkc6097192002-11-03 00:24:07 +0000978 CONFIG_EEPRO100
979 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200980 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000981 write routine for first time initialisation.
982
983 CONFIG_TULIP
984 Support for Digital 2114x chips.
985 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
986 modem chip initialisation (KS8761/QS6611).
987
988 CONFIG_NATSEMI
989 Support for National dp83815 chips.
990
991 CONFIG_NS8382X
992 Support for National dp8382[01] gigabit chips.
993
wdenk45219c42003-05-12 21:50:16 +0000994- NETWORK Support (other):
995
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100996 CONFIG_DRIVER_AT91EMAC
997 Support for AT91RM9200 EMAC.
998
999 CONFIG_RMII
1000 Define this to use reduced MII inteface
1001
1002 CONFIG_DRIVER_AT91EMAC_QUIET
1003 If this defined, the driver is quiet.
1004 The driver doen't show link status messages.
1005
wdenk45219c42003-05-12 21:50:16 +00001006 CONFIG_DRIVER_LAN91C96
1007 Support for SMSC's LAN91C96 chips.
1008
1009 CONFIG_LAN91C96_BASE
1010 Define this to hold the physical address
1011 of the LAN91C96's I/O space
1012
1013 CONFIG_LAN91C96_USE_32_BIT
1014 Define this to enable 32 bit addressing
1015
wdenkf39748a2004-06-09 13:37:52 +00001016 CONFIG_DRIVER_SMC91111
1017 Support for SMSC's LAN91C111 chip
1018
1019 CONFIG_SMC91111_BASE
1020 Define this to hold the physical address
1021 of the device (I/O space)
1022
1023 CONFIG_SMC_USE_32_BIT
1024 Define this if data bus is 32 bits
1025
1026 CONFIG_SMC_USE_IOFUNCS
1027 Define this to use i/o functions instead of macros
1028 (some hardware wont work with macros)
1029
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001030 CONFIG_DRIVER_TI_EMAC
1031 Support for davinci emac
1032
1033 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1034 Define this if you have more then 3 PHYs.
1035
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001036 CONFIG_FTGMAC100
1037 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1038
1039 CONFIG_FTGMAC100_EGIGA
1040 Define this to use GE link update with gigabit PHY.
1041 Define this if FTGMAC100 is connected to gigabit PHY.
1042 If your system has 10/100 PHY only, it might not occur
1043 wrong behavior. Because PHY usually return timeout or
1044 useless data when polling gigabit status and gigabit
1045 control registers. This behavior won't affect the
1046 correctnessof 10/100 link speed update.
1047
Mike Rapoportc2fff332009-11-11 10:03:03 +02001048 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001049 Support for SMSC's LAN911x and LAN921x chips
1050
Mike Rapoportc2fff332009-11-11 10:03:03 +02001051 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001052 Define this to hold the physical address
1053 of the device (I/O space)
1054
Mike Rapoportc2fff332009-11-11 10:03:03 +02001055 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001056 Define this if data bus is 32 bits
1057
Mike Rapoportc2fff332009-11-11 10:03:03 +02001058 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001059 Define this if data bus is 16 bits. If your processor
1060 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001061 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001062
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001063 CONFIG_SH_ETHER
1064 Support for Renesas on-chip Ethernet controller
1065
1066 CONFIG_SH_ETHER_USE_PORT
1067 Define the number of ports to be used
1068
1069 CONFIG_SH_ETHER_PHY_ADDR
1070 Define the ETH PHY's address
1071
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001072 CONFIG_SH_ETHER_CACHE_WRITEBACK
1073 If this option is set, the driver enables cache flush.
1074
Vadim Bendebury5e124722011-10-17 08:36:14 +00001075- TPM Support:
1076 CONFIG_GENERIC_LPC_TPM
1077 Support for generic parallel port TPM devices. Only one device
1078 per system is supported at this time.
1079
1080 CONFIG_TPM_TIS_BASE_ADDRESS
1081 Base address where the generic TPM device is mapped
1082 to. Contemporary x86 systems usually map it at
1083 0xfed40000.
1084
wdenkc6097192002-11-03 00:24:07 +00001085- USB Support:
1086 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001087 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001088 CONFIG_USB_UHCI to enable it.
1089 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001090 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001091 storage devices.
1092 Note:
1093 Supported are USB Keyboards and USB Floppy drives
1094 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001095 MPC5200 USB requires additional defines:
1096 CONFIG_USB_CLOCK
1097 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001098 CONFIG_PSC3_USB
1099 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001100 CONFIG_USB_CONFIG
1101 for differential drivers: 0x00001000
1102 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001103 for differential drivers on PSC3: 0x00000100
1104 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001105 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001106 May be defined to allow interrupt polling
1107 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001108
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001109- USB Device:
1110 Define the below if you wish to use the USB console.
1111 Once firmware is rebuilt from a serial console issue the
1112 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001113 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001114 it has found a new device. The environment variable usbtty
1115 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001116 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001117 Common Device Class Abstract Control Model serial device.
1118 If you select usbtty = gserial you should be able to enumerate
1119 a Linux host by
1120 # modprobe usbserial vendor=0xVendorID product=0xProductID
1121 else if using cdc_acm, simply setting the environment
1122 variable usbtty to be cdc_acm should suffice. The following
1123 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001124
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001125 CONFIG_USB_DEVICE
1126 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001127
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001128 CONFIG_USB_TTY
1129 Define this to have a tty type of device available to
1130 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001132 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001133 Define this if you want stdin, stdout &/or stderr to
1134 be set to usbtty.
1135
1136 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001137 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001138 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001139 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001140
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001141 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001142 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001143 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001144
Wolfgang Denk386eda02006-06-14 18:14:56 +02001145 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001146 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001147 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001148 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1149 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1150 should pretend to be a Linux device to it's target host.
1151
1152 CONFIG_USBD_MANUFACTURER
1153 Define this string as the name of your company for
1154 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001155
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001156 CONFIG_USBD_PRODUCT_NAME
1157 Define this string as the name of your product
1158 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1159
1160 CONFIG_USBD_VENDORID
1161 Define this as your assigned Vendor ID from the USB
1162 Implementors Forum. This *must* be a genuine Vendor ID
1163 to avoid polluting the USB namespace.
1164 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001165
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001166 CONFIG_USBD_PRODUCTID
1167 Define this as the unique Product ID
1168 for your device
1169 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001170
1171
1172- MMC Support:
1173 The MMC controller on the Intel PXA is supported. To
1174 enable this define CONFIG_MMC. The MMC can be
1175 accessed from the boot prompt by mapping the device
1176 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001177 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1178 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001179
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001180 CONFIG_SH_MMCIF
1181 Support for Renesas on-chip MMCIF controller
1182
1183 CONFIG_SH_MMCIF_ADDR
1184 Define the base address of MMCIF registers
1185
1186 CONFIG_SH_MMCIF_CLK
1187 Define the clock frequency for MMCIF
1188
wdenk6705d812004-08-02 23:22:59 +00001189- Journaling Flash filesystem support:
1190 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1191 CONFIG_JFFS2_NAND_DEV
1192 Define these for a default partition on a NAND device
1193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001194 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1195 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001196 Define these for a default partition on a NOR device
1197
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001198 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001199 Define this to create an own partition. You have to provide a
1200 function struct part_info* jffs2_part_info(int part_num)
1201
1202 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001203 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001204 to disable the command chpart. This is the default when you
1205 have not defined a custom partition
1206
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001207- FAT(File Allocation Table) filesystem write function support:
1208 CONFIG_FAT_WRITE
1209 Support for saving memory data as a file
1210 in FAT formatted partition
1211
wdenkc6097192002-11-03 00:24:07 +00001212- Keyboard Support:
1213 CONFIG_ISA_KEYBOARD
1214
1215 Define this to enable standard (PC-Style) keyboard
1216 support
1217
1218 CONFIG_I8042_KBD
1219 Standard PC keyboard driver with US (is default) and
1220 GERMAN key layout (switch via environment 'keymap=de') support.
1221 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1222 for cfb_console. Supports cursor blinking.
1223
1224- Video support:
1225 CONFIG_VIDEO
1226
1227 Define this to enable video support (for output to
1228 video).
1229
1230 CONFIG_VIDEO_CT69000
1231
1232 Enable Chips & Technologies 69000 Video chip
1233
1234 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001235 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001236 video output is selected via environment 'videoout'
1237 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1238 assumed.
wdenkc6097192002-11-03 00:24:07 +00001239
wdenkb79a11c2004-03-25 15:14:43 +00001240 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001241 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001242 are possible:
1243 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001244 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001245
1246 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1247 -------------+---------------------------------------------
1248 8 bits | 0x301* 0x303 0x305 0x161 0x307
1249 15 bits | 0x310 0x313 0x316 0x162 0x319
1250 16 bits | 0x311 0x314 0x317 0x163 0x31A
1251 24 bits | 0x312 0x315 0x318 ? 0x31B
1252 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001253 (i.e. setenv videomode 317; saveenv; reset;)
1254
wdenkb79a11c2004-03-25 15:14:43 +00001255 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001256 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001257
1258
stroesec1551ea2003-04-04 15:53:41 +00001259 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001260 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001261 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1262 or CONFIG_VIDEO_SED13806_16BPP
1263
Timur Tabi7d3053f2011-02-15 17:09:19 -06001264 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001265 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001266 SOCs that have a DIU should define this macro to enable DIU
1267 support, and should also define these other macros:
1268
1269 CONFIG_SYS_DIU_ADDR
1270 CONFIG_VIDEO
1271 CONFIG_CMD_BMP
1272 CONFIG_CFB_CONSOLE
1273 CONFIG_VIDEO_SW_CURSOR
1274 CONFIG_VGA_AS_SINGLE_DEVICE
1275 CONFIG_VIDEO_LOGO
1276 CONFIG_VIDEO_BMP_LOGO
1277
Timur Tabiba8e76b2011-04-11 14:18:22 -05001278 The DIU driver will look for the 'video-mode' environment
1279 variable, and if defined, enable the DIU as a console during
1280 boot. See the documentation file README.video for a
1281 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001282
wdenk682011f2003-06-03 23:54:09 +00001283- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001284 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001285
wdenk8bde7f72003-06-27 21:31:46 +00001286 Define this to enable a custom keyboard support.
1287 This simply calls drv_keyboard_init() which must be
1288 defined in your board-specific files.
1289 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001290
wdenkc6097192002-11-03 00:24:07 +00001291- LCD Support: CONFIG_LCD
1292
1293 Define this to enable LCD support (for output to LCD
1294 display); also select one of the supported displays
1295 by defining one of these:
1296
Stelian Pop39cf4802008-05-09 21:57:18 +02001297 CONFIG_ATMEL_LCD:
1298
1299 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1300
wdenkfd3103b2003-11-25 16:55:19 +00001301 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001302
wdenkfd3103b2003-11-25 16:55:19 +00001303 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001304
wdenkfd3103b2003-11-25 16:55:19 +00001305 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001306
wdenkfd3103b2003-11-25 16:55:19 +00001307 NEC NL6448BC20-08. 6.5", 640x480.
1308 Active, color, single scan.
1309
1310 CONFIG_NEC_NL6448BC33_54
1311
1312 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001313 Active, color, single scan.
1314
1315 CONFIG_SHARP_16x9
1316
1317 Sharp 320x240. Active, color, single scan.
1318 It isn't 16x9, and I am not sure what it is.
1319
1320 CONFIG_SHARP_LQ64D341
1321
1322 Sharp LQ64D341 display, 640x480.
1323 Active, color, single scan.
1324
1325 CONFIG_HLD1045
1326
1327 HLD1045 display, 640x480.
1328 Active, color, single scan.
1329
1330 CONFIG_OPTREX_BW
1331
1332 Optrex CBL50840-2 NF-FW 99 22 M5
1333 or
1334 Hitachi LMG6912RPFC-00T
1335 or
1336 Hitachi SP14Q002
1337
1338 320x240. Black & white.
1339
1340 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001341 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001342
wdenk7152b1d2003-09-05 23:19:14 +00001343- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001344
wdenk8bde7f72003-06-27 21:31:46 +00001345 If this option is set, the environment is checked for
1346 a variable "splashimage". If found, the usual display
1347 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001348 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001349 specified in "splashimage" is loaded instead. The
1350 console is redirected to the "nulldev", too. This
1351 allows for a "silent" boot where a splash screen is
1352 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001353
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001354 CONFIG_SPLASH_SCREEN_ALIGN
1355
1356 If this option is set the splash image can be freely positioned
1357 on the screen. Environment variable "splashpos" specifies the
1358 position as "x,y". If a positive number is given it is used as
1359 number of pixel from left/top. If a negative number is given it
1360 is used as number of pixel from right/bottom. You can also
1361 specify 'm' for centering the image.
1362
1363 Example:
1364 setenv splashpos m,m
1365 => image at center of screen
1366
1367 setenv splashpos 30,20
1368 => image at x = 30 and y = 20
1369
1370 setenv splashpos -10,m
1371 => vertically centered image
1372 at x = dspWidth - bmpWidth - 9
1373
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001374- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1375
1376 If this option is set, additionally to standard BMP
1377 images, gzipped BMP images can be displayed via the
1378 splashscreen support or the bmp command.
1379
Anatolij Gustschind5011762010-03-15 14:50:25 +01001380- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1381
1382 If this option is set, 8-bit RLE compressed BMP images
1383 can be displayed via the splashscreen support or the
1384 bmp command.
1385
wdenkc29fdfc2003-08-29 20:57:53 +00001386- Compression support:
1387 CONFIG_BZIP2
1388
1389 If this option is set, support for bzip2 compressed
1390 images is included. If not, only uncompressed and gzip
1391 compressed images are supported.
1392
wdenk42d1f032003-10-15 23:53:47 +00001393 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001394 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001395 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001396
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001397 CONFIG_LZMA
1398
1399 If this option is set, support for lzma compressed
1400 images is included.
1401
1402 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1403 requires an amount of dynamic memory that is given by the
1404 formula:
1405
1406 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1407
1408 Where lc and lp stand for, respectively, Literal context bits
1409 and Literal pos bits.
1410
1411 This value is upper-bounded by 14MB in the worst case. Anyway,
1412 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1413 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1414 a very small buffer.
1415
1416 Use the lzmainfo tool to determinate the lc and lp values and
1417 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001418 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001419
wdenk17ea1172004-06-06 21:51:03 +00001420- MII/PHY support:
1421 CONFIG_PHY_ADDR
1422
1423 The address of PHY on MII bus.
1424
1425 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1426
1427 The clock frequency of the MII bus
1428
1429 CONFIG_PHY_GIGE
1430
1431 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001432 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001433
1434 CONFIG_PHY_RESET_DELAY
1435
1436 Some PHY like Intel LXT971A need extra delay after
1437 reset before any MII register access is possible.
1438 For such PHY, set this option to the usec delay
1439 required. (minimum 300usec for LXT971A)
1440
1441 CONFIG_PHY_CMD_DELAY (ppc4xx)
1442
1443 Some PHY like Intel LXT971A need extra delay after
1444 command issued before MII status register can be read
1445
wdenkc6097192002-11-03 00:24:07 +00001446- Ethernet address:
1447 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001448 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001449 CONFIG_ETH2ADDR
1450 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001451 CONFIG_ETH4ADDR
1452 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001453
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001454 Define a default value for Ethernet address to use
1455 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001456 is not determined automatically.
1457
1458- IP address:
1459 CONFIG_IPADDR
1460
1461 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001462 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001463 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001464 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001465
1466- Server IP address:
1467 CONFIG_SERVERIP
1468
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001469 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001470 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001471 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001472
Robin Getz97cfe862009-07-21 12:15:28 -04001473 CONFIG_KEEP_SERVERADDR
1474
1475 Keeps the server's MAC address, in the env 'serveraddr'
1476 for passing to bootargs (like Linux's netconsole option)
1477
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001478- Gateway IP address:
1479 CONFIG_GATEWAYIP
1480
1481 Defines a default value for the IP address of the
1482 default router where packets to other networks are
1483 sent to.
1484 (Environment variable "gatewayip")
1485
1486- Subnet mask:
1487 CONFIG_NETMASK
1488
1489 Defines a default value for the subnet mask (or
1490 routing prefix) which is used to determine if an IP
1491 address belongs to the local subnet or needs to be
1492 forwarded through a router.
1493 (Environment variable "netmask")
1494
David Updegraff53a5c422007-06-11 10:41:07 -05001495- Multicast TFTP Mode:
1496 CONFIG_MCAST_TFTP
1497
1498 Defines whether you want to support multicast TFTP as per
1499 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001500 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001501 driver in use must provide a function: mcast() to join/leave a
1502 multicast group.
1503
wdenkc6097192002-11-03 00:24:07 +00001504- BOOTP Recovery Mode:
1505 CONFIG_BOOTP_RANDOM_DELAY
1506
1507 If you have many targets in a network that try to
1508 boot using BOOTP, you may want to avoid that all
1509 systems send out BOOTP requests at precisely the same
1510 moment (which would happen for instance at recovery
1511 from a power failure, when all systems will try to
1512 boot, thus flooding the BOOTP server. Defining
1513 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1514 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001515 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001516
1517 1st BOOTP request: delay 0 ... 1 sec
1518 2nd BOOTP request: delay 0 ... 2 sec
1519 3rd BOOTP request: delay 0 ... 4 sec
1520 4th and following
1521 BOOTP requests: delay 0 ... 8 sec
1522
stroesefe389a82003-08-28 14:17:32 +00001523- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001524 You can fine tune the DHCP functionality by defining
1525 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001526
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001527 CONFIG_BOOTP_SUBNETMASK
1528 CONFIG_BOOTP_GATEWAY
1529 CONFIG_BOOTP_HOSTNAME
1530 CONFIG_BOOTP_NISDOMAIN
1531 CONFIG_BOOTP_BOOTPATH
1532 CONFIG_BOOTP_BOOTFILESIZE
1533 CONFIG_BOOTP_DNS
1534 CONFIG_BOOTP_DNS2
1535 CONFIG_BOOTP_SEND_HOSTNAME
1536 CONFIG_BOOTP_NTPSERVER
1537 CONFIG_BOOTP_TIMEOFFSET
1538 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001539
Wilson Callan5d110f02007-07-28 10:56:13 -04001540 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1541 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001542
1543 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1544 serverip from a DHCP server, it is possible that more
1545 than one DNS serverip is offered to the client.
1546 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1547 serverip will be stored in the additional environment
1548 variable "dnsip2". The first DNS serverip is always
1549 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001550 is defined.
stroesefe389a82003-08-28 14:17:32 +00001551
1552 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1553 to do a dynamic update of a DNS server. To do this, they
1554 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001555 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001556 of the "hostname" environment variable is passed as
1557 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001558
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001559 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1560
1561 A 32bit value in microseconds for a delay between
1562 receiving a "DHCP Offer" and sending the "DHCP Request".
1563 This fixes a problem with certain DHCP servers that don't
1564 respond 100% of the time to a "DHCP request". E.g. On an
1565 AT91RM9200 processor running at 180MHz, this delay needed
1566 to be *at least* 15,000 usec before a Windows Server 2003
1567 DHCP server would reply 100% of the time. I recommend at
1568 least 50,000 usec to be safe. The alternative is to hope
1569 that one of the retries will be successful but note that
1570 the DHCP timeout and retry process takes a longer than
1571 this delay.
1572
wdenka3d991b2004-04-15 21:48:45 +00001573 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001574 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001575
1576 The device id used in CDP trigger frames.
1577
1578 CONFIG_CDP_DEVICE_ID_PREFIX
1579
1580 A two character string which is prefixed to the MAC address
1581 of the device.
1582
1583 CONFIG_CDP_PORT_ID
1584
1585 A printf format string which contains the ascii name of
1586 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001587 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001588
1589 CONFIG_CDP_CAPABILITIES
1590
1591 A 32bit integer which indicates the device capabilities;
1592 0x00000010 for a normal host which does not forwards.
1593
1594 CONFIG_CDP_VERSION
1595
1596 An ascii string containing the version of the software.
1597
1598 CONFIG_CDP_PLATFORM
1599
1600 An ascii string containing the name of the platform.
1601
1602 CONFIG_CDP_TRIGGER
1603
1604 A 32bit integer sent on the trigger.
1605
1606 CONFIG_CDP_POWER_CONSUMPTION
1607
1608 A 16bit integer containing the power consumption of the
1609 device in .1 of milliwatts.
1610
1611 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1612
1613 A byte containing the id of the VLAN.
1614
wdenkc6097192002-11-03 00:24:07 +00001615- Status LED: CONFIG_STATUS_LED
1616
1617 Several configurations allow to display the current
1618 status using a LED. For instance, the LED will blink
1619 fast while running U-Boot code, stop blinking as
1620 soon as a reply to a BOOTP request was received, and
1621 start blinking slow once the Linux kernel is running
1622 (supported by a status LED driver in the Linux
1623 kernel). Defining CONFIG_STATUS_LED enables this
1624 feature in U-Boot.
1625
1626- CAN Support: CONFIG_CAN_DRIVER
1627
1628 Defining CONFIG_CAN_DRIVER enables CAN driver support
1629 on those systems that support this (optional)
1630 feature, like the TQM8xxL modules.
1631
1632- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1633
wdenkb37c7e52003-06-30 16:24:52 +00001634 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001635 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001636 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001637
wdenk945af8d2003-07-16 21:53:01 +00001638 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001639 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001640 CONFIG_COMMANDS) and communicate with i2c based realtime
1641 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001642 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001643
Ben Warrenbb99ad62006-09-07 16:50:54 -04001644 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001645
wdenk945af8d2003-07-16 21:53:01 +00001646 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001647 bit-banging) driver instead of CPM or similar hardware
1648 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001649
wdenk945af8d2003-07-16 21:53:01 +00001650 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001651 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001652
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001653 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001654 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001655 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001656 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001657
Peter Tyser8d321b82010-04-12 22:28:21 -05001658 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001659 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001660 and so its address should therefore be cleared to 0 (See,
1661 eg, MPC823e User's Manual p.16-473). So, set
1662 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001663
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001664 CONFIG_SYS_I2C_INIT_MPC5XXX
1665
1666 When a board is reset during an i2c bus transfer
1667 chips might think that the current transfer is still
1668 in progress. Reset the slave devices by sending start
1669 commands until the slave device responds.
1670
wdenk945af8d2003-07-16 21:53:01 +00001671 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001672
1673 If you use the software i2c interface (CONFIG_SOFT_I2C)
1674 then the following macros need to be defined (examples are
1675 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001676
1677 I2C_INIT
1678
wdenkb37c7e52003-06-30 16:24:52 +00001679 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001680 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001681
wdenkba56f622004-02-06 23:19:44 +00001682 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001683
wdenkc6097192002-11-03 00:24:07 +00001684 I2C_PORT
1685
wdenk43d96162003-03-06 00:02:04 +00001686 (Only for MPC8260 CPU). The I/O port to use (the code
1687 assumes both bits are on the same port). Valid values
1688 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001689
1690 I2C_ACTIVE
1691
1692 The code necessary to make the I2C data line active
1693 (driven). If the data line is open collector, this
1694 define can be null.
1695
wdenkb37c7e52003-06-30 16:24:52 +00001696 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1697
wdenkc6097192002-11-03 00:24:07 +00001698 I2C_TRISTATE
1699
1700 The code necessary to make the I2C data line tri-stated
1701 (inactive). If the data line is open collector, this
1702 define can be null.
1703
wdenkb37c7e52003-06-30 16:24:52 +00001704 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1705
wdenkc6097192002-11-03 00:24:07 +00001706 I2C_READ
1707
1708 Code that returns TRUE if the I2C data line is high,
1709 FALSE if it is low.
1710
wdenkb37c7e52003-06-30 16:24:52 +00001711 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1712
wdenkc6097192002-11-03 00:24:07 +00001713 I2C_SDA(bit)
1714
1715 If <bit> is TRUE, sets the I2C data line high. If it
1716 is FALSE, it clears it (low).
1717
wdenkb37c7e52003-06-30 16:24:52 +00001718 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001719 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001720 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001721
wdenkc6097192002-11-03 00:24:07 +00001722 I2C_SCL(bit)
1723
1724 If <bit> is TRUE, sets the I2C clock line high. If it
1725 is FALSE, it clears it (low).
1726
wdenkb37c7e52003-06-30 16:24:52 +00001727 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001728 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001729 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001730
wdenkc6097192002-11-03 00:24:07 +00001731 I2C_DELAY
1732
1733 This delay is invoked four times per clock cycle so this
1734 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001735 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001736 like:
1737
wdenkb37c7e52003-06-30 16:24:52 +00001738 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001739
Mike Frysinger793b5722010-07-21 13:38:02 -04001740 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1741
1742 If your arch supports the generic GPIO framework (asm/gpio.h),
1743 then you may alternatively define the two GPIOs that are to be
1744 used as SCL / SDA. Any of the previous I2C_xxx macros will
1745 have GPIO-based defaults assigned to them as appropriate.
1746
1747 You should define these to the GPIO value as given directly to
1748 the generic GPIO functions.
1749
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001750 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001751
wdenk8bde7f72003-06-27 21:31:46 +00001752 When a board is reset during an i2c bus transfer
1753 chips might think that the current transfer is still
1754 in progress. On some boards it is possible to access
1755 the i2c SCLK line directly, either by using the
1756 processor pin as a GPIO or by having a second pin
1757 connected to the bus. If this option is defined a
1758 custom i2c_init_board() routine in boards/xxx/board.c
1759 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001760
Richard Retanubun26a33502010-04-12 15:08:17 -04001761 CONFIG_SYS_I2C_BOARD_LATE_INIT
1762
1763 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1764 defined a custom i2c_board_late_init() routine in
1765 boards/xxx/board.c is run AFTER the operations in i2c_init()
1766 is completed. This callpoint can be used to unreset i2c bus
1767 using CPU i2c controller register accesses for CPUs whose i2c
1768 controller provide such a method. It is called at the end of
1769 i2c_init() to allow i2c_init operations to setup the i2c bus
1770 controller on the CPU (e.g. setting bus speed & slave address).
1771
wdenk17ea1172004-06-06 21:51:03 +00001772 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1773
1774 This option enables configuration of bi_iic_fast[] flags
1775 in u-boot bd_info structure based on u-boot environment
1776 variable "i2cfast". (see also i2cfast)
1777
Ben Warrenbb99ad62006-09-07 16:50:54 -04001778 CONFIG_I2C_MULTI_BUS
1779
1780 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001781 must have a controller. At any point in time, only one bus is
1782 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001783 Note that bus numbering is zero-based.
1784
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001785 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001786
1787 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001788 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001789 is set, specify a list of bus-device pairs. Otherwise, specify
1790 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001791
1792 e.g.
1793 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001794 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001795
1796 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1797
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001798 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001799 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001800
1801 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001803 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001804
1805 If defined, then this indicates the I2C bus number for DDR SPD.
1806 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001808 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001809
1810 If defined, then this indicates the I2C bus number for the RTC.
1811 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001813 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001814
1815 If defined, then this indicates the I2C bus number for the DTT.
1816 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001818 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001819
1820 If defined, specifies the I2C address of the DTT device.
1821 If not defined, then U-Boot uses predefined value for
1822 specified DTT device.
1823
Timur Tabibe5e6182006-11-03 19:15:00 -06001824 CONFIG_FSL_I2C
1825
1826 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001827 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001828
Heiko Schocher67b23a32008-10-15 09:39:47 +02001829 CONFIG_I2C_MUX
1830
1831 Define this option if you have I2C devices reached over 1 .. n
1832 I2C Muxes like the pca9544a. This option addes a new I2C
1833 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1834 new I2C Bus to the existing I2C Busses. If you select the
1835 new Bus with "i2c dev", u-bbot sends first the commandos for
1836 the muxes to activate this new "bus".
1837
1838 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1839 feature!
1840
1841 Example:
1842 Adding a new I2C Bus reached over 2 pca9544a muxes
1843 The First mux with address 70 and channel 6
1844 The Second mux with address 71 and channel 4
1845
1846 => i2c bus pca9544a:70:6:pca9544a:71:4
1847
1848 Use the "i2c bus" command without parameter, to get a list
1849 of I2C Busses with muxes:
1850
1851 => i2c bus
1852 Busses reached over muxes:
1853 Bus ID: 2
1854 reached over Mux(es):
1855 pca9544a@70 ch: 4
1856 Bus ID: 3
1857 reached over Mux(es):
1858 pca9544a@70 ch: 6
1859 pca9544a@71 ch: 4
1860 =>
1861
1862 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001863 u-boot first sends the command to the mux@70 to enable
1864 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001865 the channel 4.
1866
1867 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001868 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001869 the 2 muxes.
1870
1871 This option is actually implemented for the bitbanging
1872 algorithm in common/soft_i2c.c and for the Hardware I2C
1873 Bus on the MPC8260. But it should be not so difficult
1874 to add this option to other architectures.
1875
Andrew Dyer2ac69852008-12-29 17:36:01 -06001876 CONFIG_SOFT_I2C_READ_REPEATED_START
1877
1878 defining this will force the i2c_read() function in
1879 the soft_i2c driver to perform an I2C repeated start
1880 between writing the address pointer and reading the
1881 data. If this define is omitted the default behaviour
1882 of doing a stop-start sequence will be used. Most I2C
1883 devices can use either method, but some require one or
1884 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001885
wdenkc6097192002-11-03 00:24:07 +00001886- SPI Support: CONFIG_SPI
1887
1888 Enables SPI driver (so far only tested with
1889 SPI EEPROM, also an instance works with Crystal A/D and
1890 D/As on the SACSng board)
1891
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001892 CONFIG_SH_SPI
1893
1894 Enables the driver for SPI controller on SuperH. Currently
1895 only SH7757 is supported.
1896
wdenkc6097192002-11-03 00:24:07 +00001897 CONFIG_SPI_X
1898
1899 Enables extended (16-bit) SPI EEPROM addressing.
1900 (symmetrical to CONFIG_I2C_X)
1901
1902 CONFIG_SOFT_SPI
1903
wdenk43d96162003-03-06 00:02:04 +00001904 Enables a software (bit-bang) SPI driver rather than
1905 using hardware support. This is a general purpose
1906 driver that only requires three general I/O port pins
1907 (two outputs, one input) to function. If this is
1908 defined, the board configuration must define several
1909 SPI configuration items (port pins to use, etc). For
1910 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001911
Ben Warren04a9e112008-01-16 22:37:35 -05001912 CONFIG_HARD_SPI
1913
1914 Enables a hardware SPI driver for general-purpose reads
1915 and writes. As with CONFIG_SOFT_SPI, the board configuration
1916 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001917 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05001918 example, see include/configs/mpc8349emds.h.
1919
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001920 CONFIG_MXC_SPI
1921
1922 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00001923 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001924
Matthias Fuchs01335022007-12-27 17:12:34 +01001925- FPGA Support: CONFIG_FPGA
1926
1927 Enables FPGA subsystem.
1928
1929 CONFIG_FPGA_<vendor>
1930
1931 Enables support for specific chip vendors.
1932 (ALTERA, XILINX)
1933
1934 CONFIG_FPGA_<family>
1935
1936 Enables support for FPGA family.
1937 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1938
1939 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001940
wdenk43d96162003-03-06 00:02:04 +00001941 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001942
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001943 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001944
wdenk8bde7f72003-06-27 21:31:46 +00001945 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001947 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001948
wdenk43d96162003-03-06 00:02:04 +00001949 Enable checks on FPGA configuration interface busy
1950 status by the configuration function. This option
1951 will require a board or device specific function to
1952 be written.
wdenkc6097192002-11-03 00:24:07 +00001953
1954 CONFIG_FPGA_DELAY
1955
1956 If defined, a function that provides delays in the FPGA
1957 configuration driver.
1958
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001959 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001960 Allow Control-C to interrupt FPGA configuration
1961
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001962 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001963
wdenk43d96162003-03-06 00:02:04 +00001964 Check for configuration errors during FPGA bitfile
1965 loading. For example, abort during Virtex II
1966 configuration if the INIT_B line goes low (which
1967 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001968
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001969 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001970
wdenk43d96162003-03-06 00:02:04 +00001971 Maximum time to wait for the INIT_B line to deassert
1972 after PROB_B has been deasserted during a Virtex II
1973 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001974 ms.
wdenkc6097192002-11-03 00:24:07 +00001975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001976 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001977
wdenk43d96162003-03-06 00:02:04 +00001978 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001979 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001980
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001981 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001982
wdenk43d96162003-03-06 00:02:04 +00001983 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001984 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001985
1986- Configuration Management:
1987 CONFIG_IDENT_STRING
1988
wdenk43d96162003-03-06 00:02:04 +00001989 If defined, this string will be added to the U-Boot
1990 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001991
1992- Vendor Parameter Protection:
1993
wdenk43d96162003-03-06 00:02:04 +00001994 U-Boot considers the values of the environment
1995 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001996 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001997 are set once by the board vendor / manufacturer, and
1998 protects these variables from casual modification by
1999 the user. Once set, these variables are read-only,
2000 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002001 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002002
2003 If CONFIG_ENV_OVERWRITE is #defined in your config
2004 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002005 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002006 these parameters.
2007
2008 Alternatively, if you #define _both_ CONFIG_ETHADDR
2009 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002010 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002011 which can be changed exactly ONCE by the user. [The
2012 serial# is unaffected by this, i. e. it remains
2013 read-only.]
2014
2015- Protected RAM:
2016 CONFIG_PRAM
2017
2018 Define this variable to enable the reservation of
2019 "protected RAM", i. e. RAM which is not overwritten
2020 by U-Boot. Define CONFIG_PRAM to hold the number of
2021 kB you want to reserve for pRAM. You can overwrite
2022 this default value by defining an environment
2023 variable "pram" to the number of kB you want to
2024 reserve. Note that the board info structure will
2025 still show the full amount of RAM. If pRAM is
2026 reserved, a new environment variable "mem" will
2027 automatically be defined to hold the amount of
2028 remaining RAM in a form that can be passed as boot
2029 argument to Linux, for instance like that:
2030
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002031 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002032 saveenv
2033
2034 This way you can tell Linux not to use this memory,
2035 either, which results in a memory region that will
2036 not be affected by reboots.
2037
2038 *WARNING* If your board configuration uses automatic
2039 detection of the RAM size, you must make sure that
2040 this memory test is non-destructive. So far, the
2041 following board configurations are known to be
2042 "pRAM-clean":
2043
2044 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2045 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002046 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002047
2048- Error Recovery:
2049 CONFIG_PANIC_HANG
2050
2051 Define this variable to stop the system in case of a
2052 fatal error, so that you have to reset it manually.
2053 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002054 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002055 automatically as fast as possible, but it may be
2056 useful during development since you can try to debug
2057 the conditions that lead to the situation.
2058
2059 CONFIG_NET_RETRY_COUNT
2060
wdenk43d96162003-03-06 00:02:04 +00002061 This variable defines the number of retries for
2062 network operations like ARP, RARP, TFTP, or BOOTP
2063 before giving up the operation. If not defined, a
2064 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002065
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002066 CONFIG_ARP_TIMEOUT
2067
2068 Timeout waiting for an ARP reply in milliseconds.
2069
wdenkc6097192002-11-03 00:24:07 +00002070- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002071 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002072
2073 Enable auto completion of commands using TAB.
2074
Wolfgang Denka9398e02006-11-27 15:32:42 +01002075 Note that this feature has NOT been implemented yet
2076 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002077
2078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002079 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002080
2081 Define this variable to enable the "hush" shell (from
2082 Busybox) as command line interpreter, thus enabling
2083 powerful command line syntax like
2084 if...then...else...fi conditionals or `&&' and '||'
2085 constructs ("shell scripts").
2086
2087 If undefined, you get the old, much simpler behaviour
2088 with a somewhat smaller memory footprint.
2089
2090
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002091 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002092
2093 This defines the secondary prompt string, which is
2094 printed when the command interpreter needs more input
2095 to complete a command. Usually "> ".
2096
2097 Note:
2098
wdenk8bde7f72003-06-27 21:31:46 +00002099 In the current implementation, the local variables
2100 space and global environment variables space are
2101 separated. Local variables are those you define by
2102 simply typing `name=value'. To access a local
2103 variable later on, you have write `$name' or
2104 `${name}'; to execute the contents of a variable
2105 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002106
wdenk43d96162003-03-06 00:02:04 +00002107 Global environment variables are those you use
2108 setenv/printenv to work with. To run a command stored
2109 in such a variable, you need to use the run command,
2110 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002111
2112 To store commands and special characters in a
2113 variable, please use double quotation marks
2114 surrounding the whole text of the variable, instead
2115 of the backslashes before semicolons and special
2116 symbols.
2117
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002118- Commandline Editing and History:
2119 CONFIG_CMDLINE_EDITING
2120
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002121 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002122 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002123
wdenka8c7c702003-12-06 19:49:23 +00002124- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002125 CONFIG_EXTRA_ENV_SETTINGS
2126
wdenk43d96162003-03-06 00:02:04 +00002127 Define this to contain any number of null terminated
2128 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002129 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002130
wdenk43d96162003-03-06 00:02:04 +00002131 For example, place something like this in your
2132 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002133
2134 #define CONFIG_EXTRA_ENV_SETTINGS \
2135 "myvar1=value1\0" \
2136 "myvar2=value2\0"
2137
wdenk43d96162003-03-06 00:02:04 +00002138 Warning: This method is based on knowledge about the
2139 internal format how the environment is stored by the
2140 U-Boot code. This is NOT an official, exported
2141 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002142 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002143 You better know what you are doing here.
2144
wdenk43d96162003-03-06 00:02:04 +00002145 Note: overly (ab)use of the default environment is
2146 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002147 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002148 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002149
wdenka8c7c702003-12-06 19:49:23 +00002150- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002151 CONFIG_HAS_DATAFLASH
2152
wdenk8bde7f72003-06-27 21:31:46 +00002153 Defining this option enables DataFlash features and
2154 allows to read/write in Dataflash via the standard
2155 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002156
wdenk3f85ce22004-02-23 16:11:30 +00002157- SystemACE Support:
2158 CONFIG_SYSTEMACE
2159
2160 Adding this option adds support for Xilinx SystemACE
2161 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002162 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002163 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002164
2165 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002166 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002167
2168 When SystemACE support is added, the "ace" device type
2169 becomes available to the fat commands, i.e. fatls.
2170
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002171- TFTP Fixed UDP Port:
2172 CONFIG_TFTP_PORT
2173
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002174 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002175 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002176 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002177 number generator is used.
2178
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002179 Also, the environment variable tftpdstp is used to supply
2180 the TFTP UDP destination port value. If tftpdstp isn't
2181 defined, the normal port 69 is used.
2182
2183 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002184 blindly start the TFTP transfer using the pre-configured
2185 target IP address and UDP port. This has the effect of
2186 "punching through" the (Windows XP) firewall, allowing
2187 the remainder of the TFTP transfer to proceed normally.
2188 A better solution is to properly configure the firewall,
2189 but sometimes that is not allowed.
2190
wdenka8c7c702003-12-06 19:49:23 +00002191- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002192 CONFIG_SHOW_BOOT_PROGRESS
2193
wdenk43d96162003-03-06 00:02:04 +00002194 Defining this option allows to add some board-
2195 specific code (calling a user-provided function
2196 "show_boot_progress(int)") that enables you to show
2197 the system's boot progress on some display (for
2198 example, some LED's) on your board. At the moment,
2199 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002200
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002201Legacy uImage format:
2202
wdenkc6097192002-11-03 00:24:07 +00002203 Arg Where When
2204 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002205 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002206 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002207 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002208 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002209 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002210 4 common/cmd_bootm.c Image data has correct checksum
2211 -4 common/cmd_bootm.c Image is for unsupported architecture
2212 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002213 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002214 6 common/cmd_bootm.c Image Type check OK
2215 -6 common/cmd_bootm.c gunzip uncompression error
2216 -7 common/cmd_bootm.c Unimplemented compression type
2217 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002218 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002219 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002220
2221 9 common/image.c Start initial ramdisk verification
2222 -10 common/image.c Ramdisk header has bad magic number
2223 -11 common/image.c Ramdisk header has bad checksum
2224 10 common/image.c Ramdisk header is OK
2225 -12 common/image.c Ramdisk data has bad checksum
2226 11 common/image.c Ramdisk data has correct checksum
2227 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002228 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002229 13 common/image.c Start multifile image verification
2230 14 common/image.c No initial ramdisk, no multifile, continue.
2231
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002232 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002233
Stefan Roesea47a12b2010-04-15 16:07:28 +02002234 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002235 -31 post/post.c POST test failed, detected by post_output_backlog()
2236 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002237
Heiko Schocher566a4942007-06-22 19:11:54 +02002238 34 common/cmd_doc.c before loading a Image from a DOC device
2239 -35 common/cmd_doc.c Bad usage of "doc" command
2240 35 common/cmd_doc.c correct usage of "doc" command
2241 -36 common/cmd_doc.c No boot device
2242 36 common/cmd_doc.c correct boot device
2243 -37 common/cmd_doc.c Unknown Chip ID on boot device
2244 37 common/cmd_doc.c correct chip ID found, device available
2245 -38 common/cmd_doc.c Read Error on boot device
2246 38 common/cmd_doc.c reading Image header from DOC device OK
2247 -39 common/cmd_doc.c Image header has bad magic number
2248 39 common/cmd_doc.c Image header has correct magic number
2249 -40 common/cmd_doc.c Error reading Image from DOC device
2250 40 common/cmd_doc.c Image header has correct magic number
2251 41 common/cmd_ide.c before loading a Image from a IDE device
2252 -42 common/cmd_ide.c Bad usage of "ide" command
2253 42 common/cmd_ide.c correct usage of "ide" command
2254 -43 common/cmd_ide.c No boot device
2255 43 common/cmd_ide.c boot device found
2256 -44 common/cmd_ide.c Device not available
2257 44 common/cmd_ide.c Device available
2258 -45 common/cmd_ide.c wrong partition selected
2259 45 common/cmd_ide.c partition selected
2260 -46 common/cmd_ide.c Unknown partition table
2261 46 common/cmd_ide.c valid partition table found
2262 -47 common/cmd_ide.c Invalid partition type
2263 47 common/cmd_ide.c correct partition type
2264 -48 common/cmd_ide.c Error reading Image Header on boot device
2265 48 common/cmd_ide.c reading Image Header from IDE device OK
2266 -49 common/cmd_ide.c Image header has bad magic number
2267 49 common/cmd_ide.c Image header has correct magic number
2268 -50 common/cmd_ide.c Image header has bad checksum
2269 50 common/cmd_ide.c Image header has correct checksum
2270 -51 common/cmd_ide.c Error reading Image from IDE device
2271 51 common/cmd_ide.c reading Image from IDE device OK
2272 52 common/cmd_nand.c before loading a Image from a NAND device
2273 -53 common/cmd_nand.c Bad usage of "nand" command
2274 53 common/cmd_nand.c correct usage of "nand" command
2275 -54 common/cmd_nand.c No boot device
2276 54 common/cmd_nand.c boot device found
2277 -55 common/cmd_nand.c Unknown Chip ID on boot device
2278 55 common/cmd_nand.c correct chip ID found, device available
2279 -56 common/cmd_nand.c Error reading Image Header on boot device
2280 56 common/cmd_nand.c reading Image Header from NAND device OK
2281 -57 common/cmd_nand.c Image header has bad magic number
2282 57 common/cmd_nand.c Image header has correct magic number
2283 -58 common/cmd_nand.c Error reading Image from NAND device
2284 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002285
Heiko Schocher566a4942007-06-22 19:11:54 +02002286 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002287
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002288 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002289 -64 net/eth.c no Ethernet found.
2290 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002291
Heiko Schocher566a4942007-06-22 19:11:54 +02002292 -80 common/cmd_net.c usage wrong
2293 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002294 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002295 81 common/cmd_net.c NetLoop() back without error
2296 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2297 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002298 83 common/cmd_net.c running "source" command
2299 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002300 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002301
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002302FIT uImage format:
2303
2304 Arg Where When
2305 100 common/cmd_bootm.c Kernel FIT Image has correct format
2306 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2307 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2308 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2309 102 common/cmd_bootm.c Kernel unit name specified
2310 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002311 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002312 104 common/cmd_bootm.c Got kernel subimage node offset
2313 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2314 105 common/cmd_bootm.c Kernel subimage hash verification OK
2315 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2316 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002317 -106 common/cmd_bootm.c Kernel subimage has wrong type
2318 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002319 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2320 108 common/cmd_bootm.c Got kernel subimage data/size
2321 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2322 -109 common/cmd_bootm.c Can't get kernel subimage type
2323 -110 common/cmd_bootm.c Can't get kernel subimage comp
2324 -111 common/cmd_bootm.c Can't get kernel subimage os
2325 -112 common/cmd_bootm.c Can't get kernel subimage load address
2326 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2327
2328 120 common/image.c Start initial ramdisk verification
2329 -120 common/image.c Ramdisk FIT image has incorrect format
2330 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002331 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002332 -122 common/image.c Can't get configuration for ramdisk subimage
2333 123 common/image.c Ramdisk unit name specified
2334 -124 common/image.c Can't get ramdisk subimage node offset
2335 125 common/image.c Got ramdisk subimage node offset
2336 -125 common/image.c Ramdisk subimage hash verification failed
2337 126 common/image.c Ramdisk subimage hash verification OK
2338 -126 common/image.c Ramdisk subimage for unsupported architecture
2339 127 common/image.c Architecture check OK
2340 -127 common/image.c Can't get ramdisk subimage data/size
2341 128 common/image.c Got ramdisk subimage data/size
2342 129 common/image.c Can't get ramdisk load address
2343 -129 common/image.c Got ramdisk load address
2344
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002345 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002346 131 common/cmd_doc.c FIT image format OK
2347
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002348 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002349 141 common/cmd_ide.c FIT image format OK
2350
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002351 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002352 151 common/cmd_nand.c FIT image format OK
2353
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002354- Standalone program support:
2355 CONFIG_STANDALONE_LOAD_ADDR
2356
Wolfgang Denk6feff892011-10-09 21:06:34 +02002357 This option defines a board specific value for the
2358 address where standalone program gets loaded, thus
2359 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002360 settings.
2361
2362- Frame Buffer Address:
2363 CONFIG_FB_ADDR
2364
2365 Define CONFIG_FB_ADDR if you want to use specific
2366 address for frame buffer.
2367 Then system will reserve the frame buffer address to
2368 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002369 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002370
2371 Please see board_init_f function.
2372
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002373- Automatic software updates via TFTP server
2374 CONFIG_UPDATE_TFTP
2375 CONFIG_UPDATE_TFTP_CNT_MAX
2376 CONFIG_UPDATE_TFTP_MSEC_MAX
2377
2378 These options enable and control the auto-update feature;
2379 for a more detailed description refer to doc/README.update.
2380
2381- MTD Support (mtdparts command, UBI support)
2382 CONFIG_MTD_DEVICE
2383
2384 Adds the MTD device infrastructure from the Linux kernel.
2385 Needed for mtdparts command support.
2386
2387 CONFIG_MTD_PARTITIONS
2388
2389 Adds the MTD partitioning infrastructure from the Linux
2390 kernel. Needed for UBI support.
2391
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002392- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002393 CONFIG_SPL
2394 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002395
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002396 CONFIG_SPL_TEXT_BASE
2397 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002398
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002399 CONFIG_SPL_LDSCRIPT
2400 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002401
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002402 CONFIG_SPL_LIBCOMMON_SUPPORT
2403 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002404
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002405 CONFIG_SPL_LIBDISK_SUPPORT
2406 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002407
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002408 CONFIG_SPL_I2C_SUPPORT
2409 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002410
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002411 CONFIG_SPL_GPIO_SUPPORT
2412 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002413
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002414 CONFIG_SPL_MMC_SUPPORT
2415 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002416
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002417 CONFIG_SPL_SERIAL_SUPPORT
2418 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002419
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002420 CONFIG_SPL_SPI_FLASH_SUPPORT
2421 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002422
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002423 CONFIG_SPL_SPI_SUPPORT
2424 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002425
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002426 CONFIG_SPL_FAT_SUPPORT
2427 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002428
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002429 CONFIG_SPL_LIBGENERIC_SUPPORT
2430 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002431
wdenkc6097192002-11-03 00:24:07 +00002432Modem Support:
2433--------------
2434
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002435[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002436
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002437- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002438 CONFIG_MODEM_SUPPORT
2439
2440- RTS/CTS Flow control enable:
2441 CONFIG_HWFLOW
2442
2443- Modem debug support:
2444 CONFIG_MODEM_SUPPORT_DEBUG
2445
wdenk43d96162003-03-06 00:02:04 +00002446 Enables debugging stuff (char screen[1024], dbg())
2447 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002448
wdenka8c7c702003-12-06 19:49:23 +00002449- Interrupt support (PPC):
2450
wdenkd4ca31c2004-01-02 14:00:00 +00002451 There are common interrupt_init() and timer_interrupt()
2452 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002453 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002454 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002455 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002456 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002457 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002458 specific handling. If board has watchdog / status_led
2459 / other_activity_monitor it works automatically from
2460 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002461
wdenkc6097192002-11-03 00:24:07 +00002462- General:
2463
wdenk43d96162003-03-06 00:02:04 +00002464 In the target system modem support is enabled when a
2465 specific key (key combination) is pressed during
2466 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002467 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002468 board_init(). Currently key_pressed() is a dummy
2469 function, returning 1 and thus enabling modem
2470 initialization.
wdenkc6097192002-11-03 00:24:07 +00002471
wdenk43d96162003-03-06 00:02:04 +00002472 If there are no modem init strings in the
2473 environment, U-Boot proceed to autoboot; the
2474 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002475 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002476
2477 See also: doc/README.Modem
2478
Helmut Raiger9660e442011-10-20 04:19:47 +00002479Board initialization settings:
2480------------------------------
2481
2482During Initialization u-boot calls a number of board specific functions
2483to allow the preparation of board specific prerequisites, e.g. pin setup
2484before drivers are initialized. To enable these callbacks the
2485following configuration macros have to be defined. Currently this is
2486architecture specific, so please check arch/your_architecture/lib/board.c
2487typically in board_init_f() and board_init_r().
2488
2489- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2490- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2491- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2492- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002493
wdenkc6097192002-11-03 00:24:07 +00002494Configuration Settings:
2495-----------------------
2496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002497- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002498 undefine this when you're short of memory.
2499
Peter Tyser2fb26042009-01-27 18:03:12 -06002500- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2501 width of the commands listed in the 'help' command output.
2502
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002503- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002504 prompt for user input.
2505
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002506- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002507
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002508- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002509
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002510- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002511
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002512- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002513 the application (usually a Linux kernel) when it is
2514 booted
2515
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002516- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002517 List of legal baudrate settings for this board.
2518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002519- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002520 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002521
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002522- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002523 If the board specific function
2524 extern int overwrite_console (void);
2525 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002526 serial port, else the settings in the environment are used.
2527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002528- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002529 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002531- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002532 Enable overwrite of previous console environment settings.
2533
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002534- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002535 Begin and End addresses of the area used by the
2536 simple memory test.
2537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002538- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002539 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002540
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002541- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002542 Scratch address used by the alternate memory test
2543 You only need to set this if address zero isn't writeable
2544
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002545- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2546 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002547 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002548 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002549 fixing up gd->ram_size the Linux kernel should gets passed
2550 the now "corrected" memory size and won't touch it either.
2551 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002552 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002553 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002554 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002555
2556 This option can be used as a workaround for the 440EPx/GRx
2557 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2558 be touched.
2559
2560 WARNING: Please make sure that this value is a multiple of
2561 the Linux page size (normally 4k). If this is not the case,
2562 then the end address of the Linux memory will be located at a
2563 non page size aligned address and this could cause major
2564 problems.
2565
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002566- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002567 Default load address for network file downloads
2568
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002569- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002570 Enable temporary baudrate change while serial download
2571
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002572- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002573 Physical start address of SDRAM. _Must_ be 0 here.
2574
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002575- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002576 Physical start address of Motherboard I/O (if using a
2577 Cogent motherboard)
2578
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002579- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002580 Physical start address of Flash memory.
2581
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002582- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002583 Physical start address of boot monitor code (set by
2584 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002585 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002586 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002588- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002589 Size of memory reserved for monitor code, used to
2590 determine _at_compile_time_ (!) if the environment is
2591 embedded within the U-Boot image, or in a separate
2592 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002594- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002595 Size of DRAM reserved for malloc() use.
2596
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002597- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002598 Normally compressed uImages are limited to an
2599 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002600 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002601 to adjust this setting to your needs.
2602
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002603- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002604 Maximum size of memory mapped by the startup code of
2605 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002606 the Linux kernel (bd_info, boot arguments, FDT blob if
2607 used) must be put below this limit, unless "bootm_low"
2608 enviroment variable is defined and non-zero. In such case
2609 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002610 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002611 variable "bootm_mapsize" will override the value of
2612 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2613 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002614
John Rigbyfca43cc2010-10-13 13:57:35 -06002615- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2616 Enable initrd_high functionality. If defined then the
2617 initrd_high feature is enabled and the bootm ramdisk subcommand
2618 is enabled.
2619
2620- CONFIG_SYS_BOOT_GET_CMDLINE:
2621 Enables allocating and saving kernel cmdline in space between
2622 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2623
2624- CONFIG_SYS_BOOT_GET_KBD:
2625 Enables allocating and saving a kernel copy of the bd_info in
2626 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2627
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002628- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002629 Max number of Flash memory banks
2630
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002631- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002632 Max number of sectors on a Flash chip
2633
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002634- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002635 Timeout for Flash erase operations (in ms)
2636
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002637- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002638 Timeout for Flash write operations (in ms)
2639
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002640- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002641 Timeout for Flash set sector lock bit operation (in ms)
2642
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002643- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002644 Timeout for Flash clear lock bits operation (in ms)
2645
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002646- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002647 If defined, hardware flash sectors protection is used
2648 instead of U-Boot software protection.
2649
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002650- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002651
2652 Enable TFTP transfers directly to flash memory;
2653 without this option such a download has to be
2654 performed in two steps: (1) download to RAM, and (2)
2655 copy from RAM to flash.
2656
2657 The two-step approach is usually more reliable, since
2658 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002659 the flash, but in some situations (when system RAM is
2660 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002661 downloaded image) this option may be very useful.
2662
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002663- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002664 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002665 common flash structure for storing flash geometry.
2666
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002667- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002668 This option also enables the building of the cfi_flash driver
2669 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002670
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002671- CONFIG_FLASH_CFI_MTD
2672 This option enables the building of the cfi_mtd driver
2673 in the drivers directory. The driver exports CFI flash
2674 to the MTD layer.
2675
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002676- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002677 Use buffered writes to flash.
2678
2679- CONFIG_FLASH_SPANSION_S29WS_N
2680 s29ws-n MirrorBit flash has non-standard addresses for buffered
2681 write commands.
2682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002683- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002684 If this option is defined, the common CFI flash doesn't
2685 print it's warning upon not recognized FLASH banks. This
2686 is useful, if some of the configured banks are only
2687 optionally available.
2688
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002689- CONFIG_FLASH_SHOW_PROGRESS
2690 If defined (must be an integer), print out countdown
2691 digits and dots. Recommended value: 45 (9..1) for 80
2692 column displays, 15 (3..1) for 40 column displays.
2693
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002694- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002695 Defines the number of Ethernet receive buffers. On some
2696 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002697 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2698 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002699 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002700 Defaults to 4 if not defined.
2701
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002702- CONFIG_ENV_MAX_ENTRIES
2703
Wolfgang Denk071bc922010-10-27 22:48:30 +02002704 Maximum number of entries in the hash table that is used
2705 internally to store the environment settings. The default
2706 setting is supposed to be generous and should work in most
2707 cases. This setting can be used to tune behaviour; see
2708 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002709
wdenkc6097192002-11-03 00:24:07 +00002710The following definitions that deal with the placement and management
2711of environment data (variable area); in general, we support the
2712following configurations:
2713
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002714- CONFIG_BUILD_ENVCRC:
2715
2716 Builds up envcrc with the target environment so that external utils
2717 may easily extract it and embed it in final U-Boot images.
2718
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002719- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002720
2721 Define this if the environment is in flash memory.
2722
2723 a) The environment occupies one whole flash sector, which is
2724 "embedded" in the text segment with the U-Boot code. This
2725 happens usually with "bottom boot sector" or "top boot
2726 sector" type flash chips, which have several smaller
2727 sectors at the start or the end. For instance, such a
2728 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2729 such a case you would place the environment in one of the
2730 4 kB sectors - with U-Boot code before and after it. With
2731 "top boot sector" type flash chips, you would put the
2732 environment in one of the last sectors, leaving a gap
2733 between U-Boot and the environment.
2734
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002735 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002736
2737 Offset of environment data (variable area) to the
2738 beginning of flash memory; for instance, with bottom boot
2739 type flash chips the second sector can be used: the offset
2740 for this sector is given here.
2741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002742 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002743
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002744 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002745
2746 This is just another way to specify the start address of
2747 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002748 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002749
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002750 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002751
2752 Size of the sector containing the environment.
2753
2754
2755 b) Sometimes flash chips have few, equal sized, BIG sectors.
2756 In such a case you don't want to spend a whole sector for
2757 the environment.
2758
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002759 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002760
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002761 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002762 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002763 of this flash sector for the environment. This saves
2764 memory for the RAM copy of the environment.
2765
2766 It may also save flash memory if you decide to use this
2767 when your environment is "embedded" within U-Boot code,
2768 since then the remainder of the flash sector could be used
2769 for U-Boot code. It should be pointed out that this is
2770 STRONGLY DISCOURAGED from a robustness point of view:
2771 updating the environment in flash makes it always
2772 necessary to erase the WHOLE sector. If something goes
2773 wrong before the contents has been restored from a copy in
2774 RAM, your target system will be dead.
2775
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002776 - CONFIG_ENV_ADDR_REDUND
2777 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002778
wdenk43d96162003-03-06 00:02:04 +00002779 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002780 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002781 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002782 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002783
2784BE CAREFUL! Any changes to the flash layout, and some changes to the
2785source code will make it necessary to adapt <board>/u-boot.lds*
2786accordingly!
2787
2788
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002789- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002790
2791 Define this if you have some non-volatile memory device
2792 (NVRAM, battery buffered SRAM) which you want to use for the
2793 environment.
2794
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002795 - CONFIG_ENV_ADDR:
2796 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002797
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002798 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002799 want to use for environment. It is assumed that this memory
2800 can just be read and written to, without any special
2801 provision.
2802
2803BE CAREFUL! The first access to the environment happens quite early
2804in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002805console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002806U-Boot will hang.
2807
2808Please note that even with NVRAM we still use a copy of the
2809environment in RAM: we could work on NVRAM directly, but we want to
2810keep settings there always unmodified except somebody uses "saveenv"
2811to save the current settings.
2812
2813
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002814- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002815
2816 Use this if you have an EEPROM or similar serial access
2817 device and a driver for it.
2818
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002819 - CONFIG_ENV_OFFSET:
2820 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002821
2822 These two #defines specify the offset and size of the
2823 environment area within the total memory of your EEPROM.
2824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002825 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002826 If defined, specified the chip address of the EEPROM device.
2827 The default address is zero.
2828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002829 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002830 If defined, the number of bits used to address bytes in a
2831 single page in the EEPROM device. A 64 byte page, for example
2832 would require six bits.
2833
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002834 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002835 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002836 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002837
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002838 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002839 The length in bytes of the EEPROM memory array address. Note
2840 that this is NOT the chip address length!
2841
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002842 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002843 EEPROM chips that implement "address overflow" are ones
2844 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2845 address and the extra bits end up in the "chip address" bit
2846 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2847 byte chips.
2848
2849 Note that we consider the length of the address field to
2850 still be one byte because the extra address bits are hidden
2851 in the chip address.
2852
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002853 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002854 The size in bytes of the EEPROM device.
2855
Heiko Schocher548738b2010-01-07 08:55:40 +01002856 - CONFIG_ENV_EEPROM_IS_ON_I2C
2857 define this, if you have I2C and SPI activated, and your
2858 EEPROM, which holds the environment, is on the I2C bus.
2859
2860 - CONFIG_I2C_ENV_EEPROM_BUS
2861 if you have an Environment on an EEPROM reached over
2862 I2C muxes, you can define here, how to reach this
2863 EEPROM. For example:
2864
Wolfgang Denka9046b92010-06-13 17:48:15 +02002865 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002866
2867 EEPROM which holds the environment, is reached over
2868 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002869
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002870- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002871
wdenkd4ca31c2004-01-02 14:00:00 +00002872 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002873 want to use for the environment.
2874
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002875 - CONFIG_ENV_OFFSET:
2876 - CONFIG_ENV_ADDR:
2877 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002878
2879 These three #defines specify the offset and size of the
2880 environment area within the total memory of your DataFlash placed
2881 at the specified address.
2882
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002883- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002884
2885 Define this if you have a NAND device which you want to use
2886 for the environment.
2887
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002888 - CONFIG_ENV_OFFSET:
2889 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002890
2891 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002892 area within the first NAND device. CONFIG_ENV_OFFSET must be
2893 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002894
Scott Woodfdd813d2010-09-17 14:38:37 -05002895 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002896
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002897 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002898 size used to hold a redundant copy of the environment data, so
2899 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002900 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05002901 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002902
Scott Woodfdd813d2010-09-17 14:38:37 -05002903 - CONFIG_ENV_RANGE (optional):
2904
2905 Specifies the length of the region in which the environment
2906 can be written. This should be a multiple of the NAND device's
2907 block size. Specifying a range with more erase blocks than
2908 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2909 the range to be avoided.
2910
2911 - CONFIG_ENV_OFFSET_OOB (optional):
2912
2913 Enables support for dynamically retrieving the offset of the
2914 environment from block zero's out-of-band data. The
2915 "nand env.oob" command can be used to record this offset.
2916 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2917 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002918
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002919- CONFIG_NAND_ENV_DST
2920
2921 Defines address in RAM to which the nand_spl code should copy the
2922 environment. If redundant environment is used, it will be copied to
2923 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2924
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002925- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002926
2927 Defines offset to the initial SPI buffer area in DPRAM. The
2928 area is used at an early stage (ROM part) if the environment
2929 is configured to reside in the SPI EEPROM: We need a 520 byte
2930 scratch DPRAM area. It is used between the two initialization
2931 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2932 to be a good choice since it makes it far enough from the
2933 start of the data area as well as from the stack pointer.
2934
Bruce Adlere881cb52007-11-02 13:15:42 -07002935Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002936has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02002937created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00002938until then to read environment variables.
2939
wdenk85ec0bc2003-03-31 16:34:49 +00002940The environment is protected by a CRC32 checksum. Before the monitor
2941is relocated into RAM, as a result of a bad CRC you will be working
2942with the compiled-in default environment - *silently*!!! [This is
2943necessary, because the first environment variable we need is the
2944"baudrate" setting for the console - if we have a bad CRC, we don't
2945have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002946
2947Note: once the monitor has been relocated, then it will complain if
2948the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002949use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002951- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002952 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002953
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002954 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002955 also needs to be defined.
2956
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002957- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002958 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002959
Ron Madridf5675aa2009-02-18 14:30:44 -08002960- CONFIG_NS16550_MIN_FUNCTIONS:
2961 Define this if you desire to only have use of the NS16550_init
2962 and NS16550_putc functions for the serial driver located at
2963 drivers/serial/ns16550.c. This option is useful for saving
2964 space for already greatly restricted images, including but not
2965 limited to NAND_SPL configurations.
2966
wdenkc6097192002-11-03 00:24:07 +00002967Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002968---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002969
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002970- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002971 Cache Line Size of the CPU.
2972
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002973- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002974 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002975
wdenk42d1f032003-10-15 23:53:47 +00002976 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2977 and RPXsuper) to be able to adjust the position of
2978 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002979
Timur Tabie46fedf2011-08-04 18:03:41 -05002980- CONFIG_SYS_CCSRBAR_DEFAULT:
2981 Default (power-on reset) physical address of CCSR on Freescale
2982 PowerPC SOCs.
2983
2984- CONFIG_SYS_CCSRBAR:
2985 Virtual address of CCSR. On a 32-bit build, this is typically
2986 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2987
2988 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2989 for cross-platform code that uses that macro instead.
2990
2991- CONFIG_SYS_CCSRBAR_PHYS:
2992 Physical address of CCSR. CCSR can be relocated to a new
2993 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002994 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05002995 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2996 is typically relocated on 36-bit builds. It is recommended
2997 that this macro be defined via the _HIGH and _LOW macros:
2998
2999 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3000 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3001
3002- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003003 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3004 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003005 used in assembly code, so it must not contain typecasts or
3006 integer size suffixes (e.g. "ULL").
3007
3008- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3009 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3010 used in assembly code, so it must not contain typecasts or
3011 integer size suffixes (e.g. "ULL").
3012
3013- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3014 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3015 forced to a value that ensures that CCSR is not relocated.
3016
wdenk7f6c2cb2002-11-10 22:06:23 +00003017- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003018 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003019
3020 the default drive number (default value 0)
3021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003022 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003023
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003024 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003025 (default value 1)
3026
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003027 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003028
wdenk43d96162003-03-06 00:02:04 +00003029 defines the offset of register from address. It
3030 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003031 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003033 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3034 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003035 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003036
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003037 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003038 fdc_hw_init() is called at the beginning of the FDC
3039 setup. fdc_hw_init() must be provided by the board
3040 source code. It is used to make hardware dependant
3041 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003042
Macpaul Lin0abddf82011-04-11 20:45:32 +00003043- CONFIG_IDE_AHB:
3044 Most IDE controllers were designed to be connected with PCI
3045 interface. Only few of them were designed for AHB interface.
3046 When software is doing ATA command and data transfer to
3047 IDE devices through IDE-AHB controller, some additional
3048 registers accessing to these kind of IDE-AHB controller
3049 is requierd.
3050
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003051- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003052 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003053 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003054
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003055- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003056
wdenk7152b1d2003-09-05 23:19:14 +00003057 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003058 initial data and stack; please note that this must be
3059 writable memory that is working WITHOUT special
3060 initialization, i. e. you CANNOT use normal RAM which
3061 will become available only after programming the
3062 memory controller and running certain initialization
3063 sequences.
3064
3065 U-Boot uses the following memory types:
3066 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3067 - MPC824X: data cache
3068 - PPC4xx: data cache
3069
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003070- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003071
3072 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003073 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3074 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003075 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003076 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003077 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3078 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3079 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003080
3081 Note:
3082 On the MPC824X (or other systems that use the data
3083 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003084 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003085 point to an otherwise UNUSED address space between
3086 the top of RAM and the start of the PCI space.
3087
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003088- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003089
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003090- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003091
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003092- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003093
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003094- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003095
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003096- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003097
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003098- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003099
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003100- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003101 SDRAM timing
3102
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003103- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003104 periodic timer for refresh
3105
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003106- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003107
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003108- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3109 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3110 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3111 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003112 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3113
3114- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003115 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3116 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003117 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3120 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003121 Machine Mode Register and Memory Periodic Timer
3122 Prescaler definitions (SDRAM timing)
3123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003124- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003125 enable I2C microcode relocation patch (MPC8xx);
3126 define relocation offset in DPRAM [DSP2]
3127
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003128- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003129 enable SMC microcode relocation patch (MPC8xx);
3130 define relocation offset in DPRAM [SMC1]
3131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003132- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003133 enable SPI microcode relocation patch (MPC8xx);
3134 define relocation offset in DPRAM [SCC4]
3135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003136- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003137 Use OSCM clock mode on MBX8xx board. Be careful,
3138 wrong setting might damage your board. Read
3139 doc/README.MBX before setting this variable!
3140
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003141- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003142 Offset of the bootmode word in DPRAM used by post
3143 (Power On Self Tests). This definition overrides
3144 #define'd default value in commproc.h resp.
3145 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003146
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003147- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3148 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3149 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3150 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3151 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3152 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3153 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3154 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003155 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003156
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003157- CONFIG_PCI_DISABLE_PCIE:
3158 Disable PCI-Express on systems where it is supported but not
3159 required.
3160
Kumar Galaa09b9b62010-12-30 12:09:53 -06003161- CONFIG_SYS_SRIO:
3162 Chip has SRIO or not
3163
3164- CONFIG_SRIO1:
3165 Board has SRIO 1 port available
3166
3167- CONFIG_SRIO2:
3168 Board has SRIO 2 port available
3169
3170- CONFIG_SYS_SRIOn_MEM_VIRT:
3171 Virtual Address of SRIO port 'n' memory region
3172
3173- CONFIG_SYS_SRIOn_MEM_PHYS:
3174 Physical Address of SRIO port 'n' memory region
3175
3176- CONFIG_SYS_SRIOn_MEM_SIZE:
3177 Size of SRIO port 'n' memory region
3178
Alex Watermaneced4622011-05-19 15:08:36 -04003179- CONFIG_SYS_NDFC_16
3180 Defined to tell the NDFC that the NAND chip is using a
3181 16 bit bus.
3182
3183- CONFIG_SYS_NDFC_EBC0_CFG
3184 Sets the EBC0_CFG register for the NDFC. If not defined
3185 a default value will be used.
3186
Ben Warrenbb99ad62006-09-07 16:50:54 -04003187- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003188 Get DDR timing information from an I2C EEPROM. Common
3189 with pluggable memory modules such as SODIMMs
3190
Ben Warrenbb99ad62006-09-07 16:50:54 -04003191 SPD_EEPROM_ADDRESS
3192 I2C address of the SPD EEPROM
3193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003194- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003195 If SPD EEPROM is on an I2C bus other than the first
3196 one, specify here. Note that the value must resolve
3197 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003198
York Sun1b3e3c42011-06-07 09:42:16 +08003199- CONFIG_SYS_DDR_RAW_TIMING
3200 Get DDR timing information from other than SPD. Common with
3201 soldered DDR chips onboard without SPD. DDR raw timing
3202 parameters are extracted from datasheet and hard-coded into
3203 header files or board specific files.
3204
York Sun6f5e1dc2011-09-16 13:21:35 -07003205- CONFIG_FSL_DDR_INTERACTIVE
3206 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3207
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003208- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003209 Only for 83xx systems. If specified, then DDR should
3210 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003211
wdenkc26e4542004-04-18 10:13:26 +00003212- CONFIG_ETHER_ON_FEC[12]
3213 Define to enable FEC[12] on a 8xx series processor.
3214
3215- CONFIG_FEC[12]_PHY
3216 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003217 to the given FEC; i. e.
3218 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003219 means that the PHY with address 4 is connected to FEC1
3220
3221 When set to -1, means to probe for first available.
3222
3223- CONFIG_FEC[12]_PHY_NORXERR
3224 The PHY does not have a RXERR line (RMII only).
3225 (so program the FEC to ignore it).
3226
3227- CONFIG_RMII
3228 Enable RMII mode for all FECs.
3229 Note that this is a global option, we can't
3230 have one FEC in standard MII mode and another in RMII mode.
3231
wdenk5cf91d62004-04-23 20:32:05 +00003232- CONFIG_CRC32_VERIFY
3233 Add a verify option to the crc32 command.
3234 The syntax is:
3235
3236 => crc32 -v <address> <count> <crc32>
3237
3238 Where address/count indicate a memory area
3239 and crc32 is the correct crc32 which the
3240 area should have.
3241
wdenk56523f12004-07-11 17:40:54 +00003242- CONFIG_LOOPW
3243 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003244 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003245
stroese7b466642004-12-16 18:46:55 +00003246- CONFIG_MX_CYCLIC
3247 Add the "mdc" and "mwc" memory commands. These are cyclic
3248 "md/mw" commands.
3249 Examples:
3250
wdenkefe2a4d2004-12-16 21:44:03 +00003251 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003252 This command will print 4 bytes (10,11,12,13) each 500 ms.
3253
wdenkefe2a4d2004-12-16 21:44:03 +00003254 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003255 This command will write 12345678 to address 100 all 10 ms.
3256
wdenkefe2a4d2004-12-16 21:44:03 +00003257 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003258 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003259
wdenk8aa1a2d2005-04-04 12:44:11 +00003260- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003261 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003262 low level initializations (like setting up the memory
3263 controller) are omitted and/or U-Boot does not
3264 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003265
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003266 Normally this variable MUST NOT be defined. The only
3267 exception is when U-Boot is loaded (to RAM) by some
3268 other boot loader or by a debugger which performs
3269 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003270
Aneesh V401bb302011-07-13 05:11:07 +00003271- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003272 Modifies the behaviour of start.S when compiling a loader
3273 that is executed before the actual U-Boot. E.g. when
3274 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003275
Heiko Schocher68bb8292011-11-01 20:00:30 +00003276- CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3277 define this, if you want to read first the oob data
3278 and then the data. This is used for example on
3279 davinci plattforms.
3280
Matthias Weisserd8834a12011-03-10 21:36:32 +00003281- CONFIG_USE_ARCH_MEMCPY
3282 CONFIG_USE_ARCH_MEMSET
3283 If these options are used a optimized version of memcpy/memset will
3284 be used if available. These functions may be faster under some
3285 conditions but may increase the binary size.
3286
Timur Tabif2717b42011-11-22 09:21:25 -06003287Freescale QE/FMAN Firmware Support:
3288-----------------------------------
3289
3290The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3291loading of "firmware", which is encoded in the QE firmware binary format.
3292This firmware often needs to be loaded during U-Boot booting, so macros
3293are used to identify the storage device (NOR flash, SPI, etc) and the address
3294within that device.
3295
3296- CONFIG_SYS_QE_FMAN_FW_ADDR
3297 The address in the storage device where the firmware is located. The
3298 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3299 is also specified.
3300
3301- CONFIG_SYS_QE_FMAN_FW_LENGTH
3302 The maximum possible size of the firmware. The firmware binary format
3303 has a field that specifies the actual size of the firmware, but it
3304 might not be possible to read any part of the firmware unless some
3305 local storage is allocated to hold the entire firmware first.
3306
3307- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3308 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3309 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3310 virtual address in NOR flash.
3311
3312- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3313 Specifies that QE/FMAN firmware is located in NAND flash.
3314 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3315
3316- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3317 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3318 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3319
3320- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3321 Specifies that QE/FMAN firmware is located on the primary SPI
3322 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3323
3324
wdenkc6097192002-11-03 00:24:07 +00003325Building the Software:
3326======================
3327
Wolfgang Denk218ca722008-03-26 10:40:12 +01003328Building U-Boot has been tested in several native build environments
3329and in many different cross environments. Of course we cannot support
3330all possibly existing versions of cross development tools in all
3331(potentially obsolete) versions. In case of tool chain problems we
3332recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3333which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003334
Wolfgang Denk218ca722008-03-26 10:40:12 +01003335If you are not using a native environment, it is assumed that you
3336have GNU cross compiling tools available in your path. In this case,
3337you must set the environment variable CROSS_COMPILE in your shell.
3338Note that no changes to the Makefile or any other source files are
3339necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003340
Wolfgang Denk218ca722008-03-26 10:40:12 +01003341 $ CROSS_COMPILE=ppc_4xx-
3342 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003343
Peter Tyser2f8d3962009-03-13 18:54:51 -05003344Note: If you wish to generate Windows versions of the utilities in
3345 the tools directory you can use the MinGW toolchain
3346 (http://www.mingw.org). Set your HOST tools to the MinGW
3347 toolchain and execute 'make tools'. For example:
3348
3349 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3350
3351 Binaries such as tools/mkimage.exe will be created which can
3352 be executed on computers running Windows.
3353
Wolfgang Denk218ca722008-03-26 10:40:12 +01003354U-Boot is intended to be simple to build. After installing the
3355sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003356is done by typing:
3357
3358 make NAME_config
3359
Wolfgang Denk218ca722008-03-26 10:40:12 +01003360where "NAME_config" is the name of one of the existing configu-
3361rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003362
wdenk2729af92004-05-03 20:45:30 +00003363Note: for some board special configuration names may exist; check if
3364 additional information is available from the board vendor; for
3365 instance, the TQM823L systems are available without (standard)
3366 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003367 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003368
wdenk2729af92004-05-03 20:45:30 +00003369 make TQM823L_config
3370 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003371
wdenk2729af92004-05-03 20:45:30 +00003372 make TQM823L_LCD_config
3373 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003374
wdenk2729af92004-05-03 20:45:30 +00003375 etc.
wdenkc6097192002-11-03 00:24:07 +00003376
wdenkc6097192002-11-03 00:24:07 +00003377
wdenk2729af92004-05-03 20:45:30 +00003378Finally, type "make all", and you should get some working U-Boot
3379images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003380
wdenk2729af92004-05-03 20:45:30 +00003381- "u-boot.bin" is a raw binary image
3382- "u-boot" is an image in ELF binary format
3383- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003384
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003385By default the build is performed locally and the objects are saved
3386in the source directory. One of the two methods can be used to change
3387this behavior and build U-Boot to some external directory:
3388
33891. Add O= to the make command line invocations:
3390
3391 make O=/tmp/build distclean
3392 make O=/tmp/build NAME_config
3393 make O=/tmp/build all
3394
33952. Set environment variable BUILD_DIR to point to the desired location:
3396
3397 export BUILD_DIR=/tmp/build
3398 make distclean
3399 make NAME_config
3400 make all
3401
3402Note that the command line "O=" setting overrides the BUILD_DIR environment
3403variable.
3404
wdenkc6097192002-11-03 00:24:07 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406Please be aware that the Makefiles assume you are using GNU make, so
3407for instance on NetBSD you might need to use "gmake" instead of
3408native "make".
wdenkc6097192002-11-03 00:24:07 +00003409
wdenkc6097192002-11-03 00:24:07 +00003410
wdenk2729af92004-05-03 20:45:30 +00003411If the system board that you have is not listed, then you will need
3412to port U-Boot to your hardware platform. To do this, follow these
3413steps:
wdenkc6097192002-11-03 00:24:07 +00003414
wdenk2729af92004-05-03 20:45:30 +000034151. Add a new configuration option for your board to the toplevel
3416 "Makefile" and to the "MAKEALL" script, using the existing
3417 entries as examples. Note that here and at many other places
3418 boards and other names are listed in alphabetical sort order. Please
3419 keep this order.
34202. Create a new directory to hold your board specific code. Add any
3421 files you need. In your board directory, you will need at least
3422 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
34233. Create a new configuration file "include/configs/<board>.h" for
3424 your board
34253. If you're porting U-Boot to a new CPU, then also create a new
3426 directory to hold your CPU specific code. Add any files you need.
34274. Run "make <board>_config" with your new name.
34285. Type "make", and you should get a working "u-boot.srec" file
3429 to be installed on your target system.
34306. Debug and solve any problems that might arise.
3431 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003432
wdenkc6097192002-11-03 00:24:07 +00003433
wdenk2729af92004-05-03 20:45:30 +00003434Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3435==============================================================
wdenkc6097192002-11-03 00:24:07 +00003436
Wolfgang Denk218ca722008-03-26 10:40:12 +01003437If you have modified U-Boot sources (for instance added a new board
3438or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003439provide feedback to the other developers. The feedback normally takes
3440the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003441official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003442
Wolfgang Denk218ca722008-03-26 10:40:12 +01003443But before you submit such a patch, please verify that your modifi-
3444cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003445the supported boards compile WITHOUT ANY compiler warnings. To do so,
3446just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003447for ALL supported system. Be warned, this will take a while. You can
3448select which (cross) compiler to use by passing a `CROSS_COMPILE'
3449environment variable to the script, i. e. to use the ELDK cross tools
3450you can type
wdenkc6097192002-11-03 00:24:07 +00003451
wdenk2729af92004-05-03 20:45:30 +00003452 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003453
wdenk2729af92004-05-03 20:45:30 +00003454or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk2729af92004-05-03 20:45:30 +00003456 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003457
Wolfgang Denk218ca722008-03-26 10:40:12 +01003458When using the MAKEALL script, the default behaviour is to build
3459U-Boot in the source directory. This location can be changed by
3460setting the BUILD_DIR environment variable. Also, for each target
3461built, the MAKEALL script saves two log files (<target>.ERR and
3462<target>.MAKEALL) in the <source dir>/LOG directory. This default
3463location can be changed by setting the MAKEALL_LOGDIR environment
3464variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003465
3466 export BUILD_DIR=/tmp/build
3467 export MAKEALL_LOGDIR=/tmp/log
3468 CROSS_COMPILE=ppc_8xx- MAKEALL
3469
Wolfgang Denk218ca722008-03-26 10:40:12 +01003470With the above settings build objects are saved in the /tmp/build,
3471log files are saved in the /tmp/log and the source tree remains clean
3472during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003473
3474
wdenk2729af92004-05-03 20:45:30 +00003475See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003476
wdenkc6097192002-11-03 00:24:07 +00003477
wdenk2729af92004-05-03 20:45:30 +00003478Monitor Commands - Overview:
3479============================
wdenkc6097192002-11-03 00:24:07 +00003480
wdenk2729af92004-05-03 20:45:30 +00003481go - start application at address 'addr'
3482run - run commands in an environment variable
3483bootm - boot application image from memory
3484bootp - boot image via network using BootP/TFTP protocol
3485tftpboot- boot image via network using TFTP protocol
3486 and env variables "ipaddr" and "serverip"
3487 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003488tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003489rarpboot- boot image via network using RARP/TFTP protocol
3490diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3491loads - load S-Record file over serial line
3492loadb - load binary file over serial line (kermit mode)
3493md - memory display
3494mm - memory modify (auto-incrementing)
3495nm - memory modify (constant address)
3496mw - memory write (fill)
3497cp - memory copy
3498cmp - memory compare
3499crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003500i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003501sspi - SPI utility commands
3502base - print or set address offset
3503printenv- print environment variables
3504setenv - set environment variables
3505saveenv - save environment variables to persistent storage
3506protect - enable or disable FLASH write protection
3507erase - erase FLASH memory
3508flinfo - print FLASH memory information
3509bdinfo - print Board Info structure
3510iminfo - print header information for application image
3511coninfo - print console devices and informations
3512ide - IDE sub-system
3513loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003514loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003515mtest - simple RAM test
3516icache - enable or disable instruction cache
3517dcache - enable or disable data cache
3518reset - Perform RESET of the CPU
3519echo - echo args to console
3520version - print monitor version
3521help - print online help
3522? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003523
wdenkc6097192002-11-03 00:24:07 +00003524
wdenk2729af92004-05-03 20:45:30 +00003525Monitor Commands - Detailed Description:
3526========================================
wdenkc6097192002-11-03 00:24:07 +00003527
wdenk2729af92004-05-03 20:45:30 +00003528TODO.
wdenkc6097192002-11-03 00:24:07 +00003529
wdenk2729af92004-05-03 20:45:30 +00003530For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003531
3532
wdenk2729af92004-05-03 20:45:30 +00003533Environment Variables:
3534======================
wdenkc6097192002-11-03 00:24:07 +00003535
wdenk2729af92004-05-03 20:45:30 +00003536U-Boot supports user configuration using Environment Variables which
3537can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003538
wdenk2729af92004-05-03 20:45:30 +00003539Environment Variables are set using "setenv", printed using
3540"printenv", and saved to Flash using "saveenv". Using "setenv"
3541without a value can be used to delete a variable from the
3542environment. As long as you don't save the environment you are
3543working with an in-memory copy. In case the Flash area containing the
3544environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003545
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003546Some configuration options can be set using Environment Variables.
3547
3548List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003549
wdenk2729af92004-05-03 20:45:30 +00003550 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003551
wdenk2729af92004-05-03 20:45:30 +00003552 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003553
wdenk2729af92004-05-03 20:45:30 +00003554 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003555
wdenk2729af92004-05-03 20:45:30 +00003556 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk2729af92004-05-03 20:45:30 +00003558 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003559
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003560 bootm_low - Memory range available for image processing in the bootm
3561 command can be restricted. This variable is given as
3562 a hexadecimal number and defines lowest address allowed
3563 for use by the bootm command. See also "bootm_size"
3564 environment variable. Address defined by "bootm_low" is
3565 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003566 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3567 bootm_mapsize.
3568
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003569 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003570 This variable is given as a hexadecimal number and it
3571 defines the size of the memory region starting at base
3572 address bootm_low that is accessible by the Linux kernel
3573 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3574 as the default value if it is defined, and bootm_size is
3575 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003576
3577 bootm_size - Memory range available for image processing in the bootm
3578 command can be restricted. This variable is given as
3579 a hexadecimal number and defines the size of the region
3580 allowed for use by the bootm command. See also "bootm_low"
3581 environment variable.
3582
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003583 updatefile - Location of the software update file on a TFTP server, used
3584 by the automatic software update feature. Please refer to
3585 documentation in doc/README.update for more details.
3586
wdenk2729af92004-05-03 20:45:30 +00003587 autoload - if set to "no" (any string beginning with 'n'),
3588 "bootp" will just load perform a lookup of the
3589 configuration from the BOOTP server, but not try to
3590 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk2729af92004-05-03 20:45:30 +00003592 autostart - if set to "yes", an image loaded using the "bootp",
3593 "rarpboot", "tftpboot" or "diskboot" commands will
3594 be automatically started (by internally calling
3595 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003596
wdenk2729af92004-05-03 20:45:30 +00003597 If set to "no", a standalone image passed to the
3598 "bootm" command will be copied to the load address
3599 (and eventually uncompressed), but NOT be started.
3600 This can be used to load and uncompress arbitrary
3601 data.
wdenkc6097192002-11-03 00:24:07 +00003602
David A. Longa28afca2011-07-09 16:40:19 -04003603 fdt_high - if set this restricts the maximum address that the
3604 flattened device tree will be copied into upon boot.
3605 If this is set to the special value 0xFFFFFFFF then
3606 the fdt will not be copied at all on boot. For this
3607 to work it must reside in writable memory, have
3608 sufficient padding on the end of it for u-boot to
3609 add the information it needs into it, and the memory
3610 must be accessible by the kernel.
3611
Simon Glasseea63e02011-10-24 19:15:34 +00003612 fdtcontroladdr- if set this is the address of the control flattened
3613 device tree used by U-Boot when CONFIG_OF_CONTROL is
3614 defined.
3615
wdenk17ea1172004-06-06 21:51:03 +00003616 i2cfast - (PPC405GP|PPC405EP only)
3617 if set to 'y' configures Linux I2C driver for fast
3618 mode (400kHZ). This environment variable is used in
3619 initialization code. So, for changes to be effective
3620 it must be saved and board must be reset.
3621
wdenk2729af92004-05-03 20:45:30 +00003622 initrd_high - restrict positioning of initrd images:
3623 If this variable is not set, initrd images will be
3624 copied to the highest possible address in RAM; this
3625 is usually what you want since it allows for
3626 maximum initrd size. If for some reason you want to
3627 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003628 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003629 variable to a value of "no" or "off" or "0".
3630 Alternatively, you can set it to a maximum upper
3631 address to use (U-Boot will still check that it
3632 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003633
wdenk2729af92004-05-03 20:45:30 +00003634 For instance, when you have a system with 16 MB
3635 RAM, and want to reserve 4 MB from use by Linux,
3636 you can do this by adding "mem=12M" to the value of
3637 the "bootargs" variable. However, now you must make
3638 sure that the initrd image is placed in the first
3639 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003640
wdenk2729af92004-05-03 20:45:30 +00003641 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003642
wdenk2729af92004-05-03 20:45:30 +00003643 If you set initrd_high to 0xFFFFFFFF, this is an
3644 indication to U-Boot that all addresses are legal
3645 for the Linux kernel, including addresses in flash
3646 memory. In this case U-Boot will NOT COPY the
3647 ramdisk at all. This may be useful to reduce the
3648 boot time on your system, but requires that this
3649 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003650
wdenk2729af92004-05-03 20:45:30 +00003651 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003652
wdenk2729af92004-05-03 20:45:30 +00003653 loadaddr - Default load address for commands like "bootp",
3654 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003655
wdenk2729af92004-05-03 20:45:30 +00003656 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003657
wdenk2729af92004-05-03 20:45:30 +00003658 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003659
wdenk2729af92004-05-03 20:45:30 +00003660 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003661
wdenk2729af92004-05-03 20:45:30 +00003662 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk2729af92004-05-03 20:45:30 +00003664 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003665
Mike Frysingere2a53452011-10-02 10:01:27 +00003666 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003667
Mike Frysingere2a53452011-10-02 10:01:27 +00003668 ethact - controls which interface is currently active.
3669 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003670
Heiko Schocher48690d82010-07-20 17:45:02 +02003671 => setenv ethact FEC
3672 => ping 192.168.0.1 # traffic sent on FEC
3673 => setenv ethact SCC
3674 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003675
Matthias Fuchse1692572008-01-17 07:45:05 +01003676 ethrotate - When set to "no" U-Boot does not go through all
3677 available network interfaces.
3678 It just stays at the currently selected interface.
3679
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003680 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003681 either succeed or fail without retrying.
3682 When set to "once" the network operation will
3683 fail when all the available network interfaces
3684 are tried once without success.
3685 Useful on scripts which control the retry operation
3686 themselves.
wdenkc6097192002-11-03 00:24:07 +00003687
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003688 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003689
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003690 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003691 UDP source port.
3692
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003693 tftpdstport - If this is set, the value is used for TFTP's UDP
3694 destination port instead of the Well Know Port 69.
3695
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003696 tftpblocksize - Block size to use for TFTP transfers; if not set,
3697 we use the TFTP server's default block size
3698
3699 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3700 seconds, minimum value is 1000 = 1 second). Defines
3701 when a packet is considered to be lost so it has to
3702 be retransmitted. The default is 5000 = 5 seconds.
3703 Lowering this value may make downloads succeed
3704 faster in networks with high packet loss rates or
3705 with unreliable TFTP servers.
3706
3707 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003708 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003709 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003710
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003711The following image location variables contain the location of images
3712used in booting. The "Image" column gives the role of the image and is
3713not an environment variable name. The other columns are environment
3714variable names. "File Name" gives the name of the file on a TFTP
3715server, "RAM Address" gives the location in RAM the image will be
3716loaded to, and "Flash Location" gives the image's address in NOR
3717flash or offset in NAND flash.
3718
3719*Note* - these variables don't have to be defined for all boards, some
3720boards currenlty use other variables for these purposes, and some
3721boards use these variables for other purposes.
3722
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003723Image File Name RAM Address Flash Location
3724----- --------- ----------- --------------
3725u-boot u-boot u-boot_addr_r u-boot_addr
3726Linux kernel bootfile kernel_addr_r kernel_addr
3727device tree blob fdtfile fdt_addr_r fdt_addr
3728ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003729
wdenk2729af92004-05-03 20:45:30 +00003730The following environment variables may be used and automatically
3731updated by the network boot commands ("bootp" and "rarpboot"),
3732depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003733
wdenk2729af92004-05-03 20:45:30 +00003734 bootfile - see above
3735 dnsip - IP address of your Domain Name Server
3736 dnsip2 - IP address of your secondary Domain Name Server
3737 gatewayip - IP address of the Gateway (Router) to use
3738 hostname - Target hostname
3739 ipaddr - see above
3740 netmask - Subnet Mask
3741 rootpath - Pathname of the root filesystem on the NFS server
3742 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003743
wdenka3d991b2004-04-15 21:48:45 +00003744
wdenk2729af92004-05-03 20:45:30 +00003745There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003746
wdenk2729af92004-05-03 20:45:30 +00003747 serial# - contains hardware identification information such
3748 as type string and/or serial number
3749 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003750
wdenk2729af92004-05-03 20:45:30 +00003751These variables can be set only once (usually during manufacturing of
3752the board). U-Boot refuses to delete or overwrite these variables
3753once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003754
3755
wdenk2729af92004-05-03 20:45:30 +00003756Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003757
wdenk2729af92004-05-03 20:45:30 +00003758 ver - Contains the U-Boot version string as printed
3759 with the "version" command. This variable is
3760 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003761
wdenkc6097192002-11-03 00:24:07 +00003762
wdenk2729af92004-05-03 20:45:30 +00003763Please note that changes to some configuration parameters may take
3764only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003765
stroesec1551ea2003-04-04 15:53:41 +00003766
wdenk2729af92004-05-03 20:45:30 +00003767Command Line Parsing:
3768=====================
stroesec1551ea2003-04-04 15:53:41 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770There are two different command line parsers available with U-Boot:
3771the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003772
wdenk2729af92004-05-03 20:45:30 +00003773Old, simple command line parser:
3774--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776- supports environment variables (through setenv / saveenv commands)
3777- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003778- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003779- special characters ('$', ';') can be escaped by prefixing with '\',
3780 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003781 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003782- You can also escape text by enclosing in single apostrophes, for example:
3783 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003784
wdenk2729af92004-05-03 20:45:30 +00003785Hush shell:
3786-----------
wdenkf07771c2003-05-28 08:06:31 +00003787
wdenk2729af92004-05-03 20:45:30 +00003788- similar to Bourne shell, with control structures like
3789 if...then...else...fi, for...do...done; while...do...done,
3790 until...do...done, ...
3791- supports environment ("global") variables (through setenv / saveenv
3792 commands) and local shell variables (through standard shell syntax
3793 "name=value"); only environment variables can be used with "run"
3794 command
wdenkf07771c2003-05-28 08:06:31 +00003795
wdenk2729af92004-05-03 20:45:30 +00003796General rules:
3797--------------
wdenkf07771c2003-05-28 08:06:31 +00003798
wdenk2729af92004-05-03 20:45:30 +00003799(1) If a command line (or an environment variable executed by a "run"
3800 command) contains several commands separated by semicolon, and
3801 one of these commands fails, then the remaining commands will be
3802 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003805 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003806 command will cause "run" to terminate, i. e. the remaining
3807 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003808
wdenk2729af92004-05-03 20:45:30 +00003809Note for Redundant Ethernet Interfaces:
3810=======================================
wdenkf07771c2003-05-28 08:06:31 +00003811
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003812Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003813such configurations and is capable of automatic selection of a
3814"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003815
wdenk2729af92004-05-03 20:45:30 +00003816Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3817MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3818"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003819
wdenk2729af92004-05-03 20:45:30 +00003820If the network interface stores some valid MAC address (for instance
3821in SROM), this is used as default address if there is NO correspon-
3822ding setting in the environment; if the corresponding environment
3823variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003824
wdenk2729af92004-05-03 20:45:30 +00003825o If the SROM has a valid MAC address, and there is no address in the
3826 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828o If there is no valid address in the SROM, and a definition in the
3829 environment exists, then the value from the environment variable is
3830 used.
wdenkc6097192002-11-03 00:24:07 +00003831
wdenk2729af92004-05-03 20:45:30 +00003832o If both the SROM and the environment contain a MAC address, and
3833 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003834
wdenk2729af92004-05-03 20:45:30 +00003835o If both the SROM and the environment contain a MAC address, and the
3836 addresses differ, the value from the environment is used and a
3837 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003838
wdenk2729af92004-05-03 20:45:30 +00003839o If neither SROM nor the environment contain a MAC address, an error
3840 is raised.
wdenkc6097192002-11-03 00:24:07 +00003841
Ben Warrenecee9322010-04-26 11:11:46 -07003842If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003843will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07003844may be skipped by setting the appropriate 'ethmacskip' environment variable.
3845The naming convention is as follows:
3846"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003847
wdenk2729af92004-05-03 20:45:30 +00003848Image Formats:
3849==============
wdenkc6097192002-11-03 00:24:07 +00003850
Marian Balakowicz3310c542008-03-12 12:13:13 +01003851U-Boot is capable of booting (and performing other auxiliary operations on)
3852images in two formats:
3853
3854New uImage format (FIT)
3855-----------------------
3856
3857Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3858to Flattened Device Tree). It allows the use of images with multiple
3859components (several kernels, ramdisks, etc.), with contents protected by
3860SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3861
3862
3863Old uImage format
3864-----------------
3865
3866Old image format is based on binary files which can be basically anything,
3867preceded by a special header; see the definitions in include/image.h for
3868details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003869
wdenk2729af92004-05-03 20:45:30 +00003870* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3871 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003872 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3873 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3874 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003875* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003876 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3877 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003878* Compression Type (uncompressed, gzip, bzip2)
3879* Load Address
3880* Entry Point
3881* Image Name
3882* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884The header is marked by a special Magic Number, and both the header
3885and the data portions of the image are secured against corruption by
3886CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003887
wdenkc6097192002-11-03 00:24:07 +00003888
wdenk2729af92004-05-03 20:45:30 +00003889Linux Support:
3890==============
wdenkc6097192002-11-03 00:24:07 +00003891
wdenk2729af92004-05-03 20:45:30 +00003892Although U-Boot should support any OS or standalone application
3893easily, the main focus has always been on Linux during the design of
3894U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896U-Boot includes many features that so far have been part of some
3897special "boot loader" code within the Linux kernel. Also, any
3898"initrd" images to be used are no longer part of one big Linux image;
3899instead, kernel and "initrd" are separate images. This implementation
3900serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003901
wdenk2729af92004-05-03 20:45:30 +00003902- the same features can be used for other OS or standalone
3903 applications (for instance: using compressed images to reduce the
3904 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003905
wdenk2729af92004-05-03 20:45:30 +00003906- it becomes much easier to port new Linux kernel versions because
3907 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003908
wdenk2729af92004-05-03 20:45:30 +00003909- the same Linux kernel image can now be used with different "initrd"
3910 images; of course this also means that different kernel images can
3911 be run with the same "initrd". This makes testing easier (you don't
3912 have to build a new "zImage.initrd" Linux image when you just
3913 change a file in your "initrd"). Also, a field-upgrade of the
3914 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003915
wdenkc6097192002-11-03 00:24:07 +00003916
wdenk2729af92004-05-03 20:45:30 +00003917Linux HOWTO:
3918============
wdenkc6097192002-11-03 00:24:07 +00003919
wdenk2729af92004-05-03 20:45:30 +00003920Porting Linux to U-Boot based systems:
3921---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003922
wdenk2729af92004-05-03 20:45:30 +00003923U-Boot cannot save you from doing all the necessary modifications to
3924configure the Linux device drivers for use with your target hardware
3925(no, we don't intend to provide a full virtual machine interface to
3926Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003927
Stefan Roesea47a12b2010-04-15 16:07:28 +02003928But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003929
wdenk2729af92004-05-03 20:45:30 +00003930Just make sure your machine specific header file (for instance
3931include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003932Information structure as we define in include/asm-<arch>/u-boot.h,
3933and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003934as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003935
wdenkc6097192002-11-03 00:24:07 +00003936
wdenk2729af92004-05-03 20:45:30 +00003937Configuring the Linux kernel:
3938-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003939
wdenk2729af92004-05-03 20:45:30 +00003940No specific requirements for U-Boot. Make sure you have some root
3941device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003942
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk2729af92004-05-03 20:45:30 +00003944Building a Linux Image:
3945-----------------------
wdenkc6097192002-11-03 00:24:07 +00003946
wdenk2729af92004-05-03 20:45:30 +00003947With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3948not used. If you use recent kernel source, a new build target
3949"uImage" will exist which automatically builds an image usable by
3950U-Boot. Most older kernels also have support for a "pImage" target,
3951which was introduced for our predecessor project PPCBoot and uses a
3952100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003953
wdenk2729af92004-05-03 20:45:30 +00003954Example:
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk2729af92004-05-03 20:45:30 +00003956 make TQM850L_config
3957 make oldconfig
3958 make dep
3959 make uImage
wdenkc6097192002-11-03 00:24:07 +00003960
wdenk2729af92004-05-03 20:45:30 +00003961The "uImage" build target uses a special tool (in 'tools/mkimage') to
3962encapsulate a compressed Linux kernel image with header information,
3963CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk2729af92004-05-03 20:45:30 +00003965* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003966
wdenk2729af92004-05-03 20:45:30 +00003967* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003968
wdenk2729af92004-05-03 20:45:30 +00003969 ${CROSS_COMPILE}-objcopy -O binary \
3970 -R .note -R .comment \
3971 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003974
wdenk2729af92004-05-03 20:45:30 +00003975 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003976
wdenk2729af92004-05-03 20:45:30 +00003977* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003978
wdenk2729af92004-05-03 20:45:30 +00003979 mkimage -A ppc -O linux -T kernel -C gzip \
3980 -a 0 -e 0 -n "Linux Kernel Image" \
3981 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003982
wdenk24ee89b2002-11-03 17:56:27 +00003983
wdenk2729af92004-05-03 20:45:30 +00003984The "mkimage" tool can also be used to create ramdisk images for use
3985with U-Boot, either separated from the Linux kernel image, or
3986combined into one file. "mkimage" encapsulates the images with a 64
3987byte header containing information about target architecture,
3988operating system, image type, compression method, entry points, time
3989stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003990
wdenk2729af92004-05-03 20:45:30 +00003991"mkimage" can be called in two ways: to verify existing images and
3992print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003993
wdenk2729af92004-05-03 20:45:30 +00003994In the first form (with "-l" option) mkimage lists the information
3995contained in the header of an existing U-Boot image; this includes
3996checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003997
wdenk2729af92004-05-03 20:45:30 +00003998 tools/mkimage -l image
3999 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004000
wdenk2729af92004-05-03 20:45:30 +00004001The second form (with "-d" option) is used to build a U-Boot image
4002from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004003
wdenk2729af92004-05-03 20:45:30 +00004004 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4005 -n name -d data_file image
4006 -A ==> set architecture to 'arch'
4007 -O ==> set operating system to 'os'
4008 -T ==> set image type to 'type'
4009 -C ==> set compression type 'comp'
4010 -a ==> set load address to 'addr' (hex)
4011 -e ==> set entry point to 'ep' (hex)
4012 -n ==> set image name to 'name'
4013 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004014
wdenk69459792004-05-29 16:53:29 +00004015Right now, all Linux kernels for PowerPC systems use the same load
4016address (0x00000000), but the entry point address depends on the
4017kernel version:
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk2729af92004-05-03 20:45:30 +00004019- 2.2.x kernels have the entry point at 0x0000000C,
4020- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004023
wdenk2729af92004-05-03 20:45:30 +00004024 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4025 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004026 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004027 > examples/uImage.TQM850L
4028 Image Name: 2.4.4 kernel for TQM850L
4029 Created: Wed Jul 19 02:34:59 2000
4030 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4031 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4032 Load Address: 0x00000000
4033 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk2729af92004-05-03 20:45:30 +00004035To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004036
wdenk2729af92004-05-03 20:45:30 +00004037 -> tools/mkimage -l examples/uImage.TQM850L
4038 Image Name: 2.4.4 kernel for TQM850L
4039 Created: Wed Jul 19 02:34:59 2000
4040 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4041 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4042 Load Address: 0x00000000
4043 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004044
wdenk2729af92004-05-03 20:45:30 +00004045NOTE: for embedded systems where boot time is critical you can trade
4046speed for memory and install an UNCOMPRESSED image instead: this
4047needs more space in Flash, but boots much faster since it does not
4048need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004049
Stefan Roesea47a12b2010-04-15 16:07:28 +02004050 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004051 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4052 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004053 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004054 > examples/uImage.TQM850L-uncompressed
4055 Image Name: 2.4.4 kernel for TQM850L
4056 Created: Wed Jul 19 02:34:59 2000
4057 Image Type: PowerPC Linux Kernel Image (uncompressed)
4058 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4059 Load Address: 0x00000000
4060 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004061
wdenkc6097192002-11-03 00:24:07 +00004062
wdenk2729af92004-05-03 20:45:30 +00004063Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4064when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004065
wdenk2729af92004-05-03 20:45:30 +00004066 -> tools/mkimage -n 'Simple Ramdisk Image' \
4067 > -A ppc -O linux -T ramdisk -C gzip \
4068 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4069 Image Name: Simple Ramdisk Image
4070 Created: Wed Jan 12 14:01:50 2000
4071 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4072 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4073 Load Address: 0x00000000
4074 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004075
wdenkdb01a2e2004-04-15 23:14:49 +00004076
wdenk2729af92004-05-03 20:45:30 +00004077Installing a Linux Image:
4078-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004079
wdenk2729af92004-05-03 20:45:30 +00004080To downloading a U-Boot image over the serial (console) interface,
4081you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004082
wdenk2729af92004-05-03 20:45:30 +00004083 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004084
wdenk2729af92004-05-03 20:45:30 +00004085The 'objcopy' does not understand the information in the U-Boot
4086image header, so the resulting S-Record file will be relative to
4087address 0x00000000. To load it to a given address, you need to
4088specify the target address as 'offset' parameter with the 'loads'
4089command.
wdenkc6097192002-11-03 00:24:07 +00004090
wdenk2729af92004-05-03 20:45:30 +00004091Example: install the image to address 0x40100000 (which on the
4092TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004093
wdenk2729af92004-05-03 20:45:30 +00004094 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004095
wdenk2729af92004-05-03 20:45:30 +00004096 .......... done
4097 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004098
wdenk2729af92004-05-03 20:45:30 +00004099 => loads 40100000
4100 ## Ready for S-Record download ...
4101 ~>examples/image.srec
4102 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4103 ...
4104 15989 15990 15991 15992
4105 [file transfer complete]
4106 [connected]
4107 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004108
4109
wdenk2729af92004-05-03 20:45:30 +00004110You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004111this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004112corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004113
wdenk2729af92004-05-03 20:45:30 +00004114 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004115
wdenk2729af92004-05-03 20:45:30 +00004116 ## Checking Image at 40100000 ...
4117 Image Name: 2.2.13 for initrd on TQM850L
4118 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4119 Data Size: 335725 Bytes = 327 kB = 0 MB
4120 Load Address: 00000000
4121 Entry Point: 0000000c
4122 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004123
4124
wdenk2729af92004-05-03 20:45:30 +00004125Boot Linux:
4126-----------
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128The "bootm" command is used to boot an application that is stored in
4129memory (RAM or Flash). In case of a Linux kernel image, the contents
4130of the "bootargs" environment variable is passed to the kernel as
4131parameters. You can check and modify this variable using the
4132"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004133
4134
wdenk2729af92004-05-03 20:45:30 +00004135 => printenv bootargs
4136 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004137
wdenk2729af92004-05-03 20:45:30 +00004138 => 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 +00004139
wdenk2729af92004-05-03 20:45:30 +00004140 => printenv bootargs
4141 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 +00004142
wdenk2729af92004-05-03 20:45:30 +00004143 => bootm 40020000
4144 ## Booting Linux kernel at 40020000 ...
4145 Image Name: 2.2.13 for NFS on TQM850L
4146 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4147 Data Size: 381681 Bytes = 372 kB = 0 MB
4148 Load Address: 00000000
4149 Entry Point: 0000000c
4150 Verifying Checksum ... OK
4151 Uncompressing Kernel Image ... OK
4152 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
4153 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4154 time_init: decrementer frequency = 187500000/60
4155 Calibrating delay loop... 49.77 BogoMIPS
4156 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4157 ...
wdenkc6097192002-11-03 00:24:07 +00004158
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004159If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004160the memory addresses of both the kernel and the initrd image (PPBCOOT
4161format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004162
wdenk2729af92004-05-03 20:45:30 +00004163 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004164
wdenk2729af92004-05-03 20:45:30 +00004165 ## Checking Image at 40100000 ...
4166 Image Name: 2.2.13 for initrd on TQM850L
4167 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4168 Data Size: 335725 Bytes = 327 kB = 0 MB
4169 Load Address: 00000000
4170 Entry Point: 0000000c
4171 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004172
wdenk2729af92004-05-03 20:45:30 +00004173 ## Checking Image at 40200000 ...
4174 Image Name: Simple Ramdisk Image
4175 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4176 Data Size: 566530 Bytes = 553 kB = 0 MB
4177 Load Address: 00000000
4178 Entry Point: 00000000
4179 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004180
wdenk2729af92004-05-03 20:45:30 +00004181 => bootm 40100000 40200000
4182 ## Booting Linux kernel at 40100000 ...
4183 Image Name: 2.2.13 for initrd on TQM850L
4184 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4185 Data Size: 335725 Bytes = 327 kB = 0 MB
4186 Load Address: 00000000
4187 Entry Point: 0000000c
4188 Verifying Checksum ... OK
4189 Uncompressing Kernel Image ... OK
4190 ## Loading RAMDisk Image at 40200000 ...
4191 Image Name: Simple Ramdisk Image
4192 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4193 Data Size: 566530 Bytes = 553 kB = 0 MB
4194 Load Address: 00000000
4195 Entry Point: 00000000
4196 Verifying Checksum ... OK
4197 Loading Ramdisk ... OK
4198 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
4199 Boot arguments: root=/dev/ram
4200 time_init: decrementer frequency = 187500000/60
4201 Calibrating delay loop... 49.77 BogoMIPS
4202 ...
4203 RAMDISK: Compressed image found at block 0
4204 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk2729af92004-05-03 20:45:30 +00004206 bash#
wdenkc6097192002-11-03 00:24:07 +00004207
Matthew McClintock02677682006-06-28 10:41:37 -05004208Boot Linux and pass a flat device tree:
4209-----------
4210
4211First, U-Boot must be compiled with the appropriate defines. See the section
4212titled "Linux Kernel Interface" above for a more in depth explanation. The
4213following is an example of how to start a kernel and pass an updated
4214flat device tree:
4215
4216=> print oftaddr
4217oftaddr=0x300000
4218=> print oft
4219oft=oftrees/mpc8540ads.dtb
4220=> tftp $oftaddr $oft
4221Speed: 1000, full duplex
4222Using TSEC0 device
4223TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4224Filename 'oftrees/mpc8540ads.dtb'.
4225Load address: 0x300000
4226Loading: #
4227done
4228Bytes transferred = 4106 (100a hex)
4229=> tftp $loadaddr $bootfile
4230Speed: 1000, full duplex
4231Using TSEC0 device
4232TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4233Filename 'uImage'.
4234Load address: 0x200000
4235Loading:############
4236done
4237Bytes transferred = 1029407 (fb51f hex)
4238=> print loadaddr
4239loadaddr=200000
4240=> print oftaddr
4241oftaddr=0x300000
4242=> bootm $loadaddr - $oftaddr
4243## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004244 Image Name: Linux-2.6.17-dirty
4245 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4246 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004247 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004248 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004249 Verifying Checksum ... OK
4250 Uncompressing Kernel Image ... OK
4251Booting using flat device tree at 0x300000
4252Using MPC85xx ADS machine description
4253Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4254[snip]
4255
4256
wdenk2729af92004-05-03 20:45:30 +00004257More About U-Boot Image Types:
4258------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004259
wdenk2729af92004-05-03 20:45:30 +00004260U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004261
wdenk2729af92004-05-03 20:45:30 +00004262 "Standalone Programs" are directly runnable in the environment
4263 provided by U-Boot; it is expected that (if they behave
4264 well) you can continue to work in U-Boot after return from
4265 the Standalone Program.
4266 "OS Kernel Images" are usually images of some Embedded OS which
4267 will take over control completely. Usually these programs
4268 will install their own set of exception handlers, device
4269 drivers, set up the MMU, etc. - this means, that you cannot
4270 expect to re-enter U-Boot except by resetting the CPU.
4271 "RAMDisk Images" are more or less just data blocks, and their
4272 parameters (address, size) are passed to an OS kernel that is
4273 being started.
4274 "Multi-File Images" contain several images, typically an OS
4275 (Linux) kernel image and one or more data images like
4276 RAMDisks. This construct is useful for instance when you want
4277 to boot over the network using BOOTP etc., where the boot
4278 server provides just a single image file, but you want to get
4279 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004280
wdenk2729af92004-05-03 20:45:30 +00004281 "Multi-File Images" start with a list of image sizes, each
4282 image size (in bytes) specified by an "uint32_t" in network
4283 byte order. This list is terminated by an "(uint32_t)0".
4284 Immediately after the terminating 0 follow the images, one by
4285 one, all aligned on "uint32_t" boundaries (size rounded up to
4286 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004287
wdenk2729af92004-05-03 20:45:30 +00004288 "Firmware Images" are binary images containing firmware (like
4289 U-Boot or FPGA images) which usually will be programmed to
4290 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004291
wdenk2729af92004-05-03 20:45:30 +00004292 "Script files" are command sequences that will be executed by
4293 U-Boot's command interpreter; this feature is especially
4294 useful when you configure U-Boot to use a real shell (hush)
4295 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004296
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk2729af92004-05-03 20:45:30 +00004298Standalone HOWTO:
4299=================
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk2729af92004-05-03 20:45:30 +00004301One of the features of U-Boot is that you can dynamically load and
4302run "standalone" applications, which can use some resources of
4303U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004304
wdenk2729af92004-05-03 20:45:30 +00004305Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004306
wdenk2729af92004-05-03 20:45:30 +00004307"Hello World" Demo:
4308-------------------
wdenkc6097192002-11-03 00:24:07 +00004309
wdenk2729af92004-05-03 20:45:30 +00004310'examples/hello_world.c' contains a small "Hello World" Demo
4311application; it is automatically compiled when you build U-Boot.
4312It's configured to run at address 0x00040004, so you can play with it
4313like that:
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk2729af92004-05-03 20:45:30 +00004315 => loads
4316 ## Ready for S-Record download ...
4317 ~>examples/hello_world.srec
4318 1 2 3 4 5 6 7 8 9 10 11 ...
4319 [file transfer complete]
4320 [connected]
4321 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004322
wdenk2729af92004-05-03 20:45:30 +00004323 => go 40004 Hello World! This is a test.
4324 ## Starting application at 0x00040004 ...
4325 Hello World
4326 argc = 7
4327 argv[0] = "40004"
4328 argv[1] = "Hello"
4329 argv[2] = "World!"
4330 argv[3] = "This"
4331 argv[4] = "is"
4332 argv[5] = "a"
4333 argv[6] = "test."
4334 argv[7] = "<NULL>"
4335 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004336
wdenk2729af92004-05-03 20:45:30 +00004337 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004338
wdenk2729af92004-05-03 20:45:30 +00004339Another example, which demonstrates how to register a CPM interrupt
4340handler with the U-Boot code, can be found in 'examples/timer.c'.
4341Here, a CPM timer is set up to generate an interrupt every second.
4342The interrupt service routine is trivial, just printing a '.'
4343character, but this is just a demo program. The application can be
4344controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004345
wdenk2729af92004-05-03 20:45:30 +00004346 ? - print current values og the CPM Timer registers
4347 b - enable interrupts and start timer
4348 e - stop timer and disable interrupts
4349 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004350
wdenk2729af92004-05-03 20:45:30 +00004351 => loads
4352 ## Ready for S-Record download ...
4353 ~>examples/timer.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
4360 ## Starting application at 0x00040004 ...
4361 TIMERS=0xfff00980
4362 Using timer 1
4363 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004364
wdenk2729af92004-05-03 20:45:30 +00004365Hit 'b':
4366 [q, b, e, ?] Set interval 1000000 us
4367 Enabling timer
4368Hit '?':
4369 [q, b, e, ?] ........
4370 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4371Hit '?':
4372 [q, b, e, ?] .
4373 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4374Hit '?':
4375 [q, b, e, ?] .
4376 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4377Hit '?':
4378 [q, b, e, ?] .
4379 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4380Hit 'e':
4381 [q, b, e, ?] ...Stopping timer
4382Hit 'q':
4383 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004384
4385
wdenk2729af92004-05-03 20:45:30 +00004386Minicom warning:
4387================
wdenk85ec0bc2003-03-31 16:34:49 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389Over time, many people have reported problems when trying to use the
4390"minicom" terminal emulation program for serial download. I (wd)
4391consider minicom to be broken, and recommend not to use it. Under
4392Unix, I recommend to use C-Kermit for general purpose use (and
4393especially for kermit binary protocol download ("loadb" command), and
4394use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004395
wdenk2729af92004-05-03 20:45:30 +00004396Nevertheless, if you absolutely want to use it try adding this
4397configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004398
wdenk2729af92004-05-03 20:45:30 +00004399 Name Program Name U/D FullScr IO-Red. Multi
4400 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4401 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004402
4403
wdenk2729af92004-05-03 20:45:30 +00004404NetBSD Notes:
4405=============
wdenkc6097192002-11-03 00:24:07 +00004406
wdenk2729af92004-05-03 20:45:30 +00004407Starting at version 0.9.2, U-Boot supports NetBSD both as host
4408(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004409
wdenk2729af92004-05-03 20:45:30 +00004410Building requires a cross environment; it is known to work on
4411NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4412need gmake since the Makefiles are not compatible with BSD make).
4413Note that the cross-powerpc package does not install include files;
4414attempting to build U-Boot will fail because <machine/ansi.h> is
4415missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004416
wdenk2729af92004-05-03 20:45:30 +00004417 # cd /usr/pkg/cross/powerpc-netbsd/include
4418 # mkdir powerpc
4419 # ln -s powerpc machine
4420 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4421 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004422
wdenk2729af92004-05-03 20:45:30 +00004423Native builds *don't* work due to incompatibilities between native
4424and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004425
wdenk2729af92004-05-03 20:45:30 +00004426Booting assumes that (the first part of) the image booted is a
4427stage-2 loader which in turn loads and then invokes the kernel
4428proper. Loader sources will eventually appear in the NetBSD source
4429tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004430meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004431
4432
wdenk2729af92004-05-03 20:45:30 +00004433Implementation Internals:
4434=========================
wdenkc6097192002-11-03 00:24:07 +00004435
wdenk2729af92004-05-03 20:45:30 +00004436The following is not intended to be a complete description of every
4437implementation detail. However, it should help to understand the
4438inner workings of U-Boot and make it easier to port it to custom
4439hardware.
wdenkc6097192002-11-03 00:24:07 +00004440
4441
wdenk2729af92004-05-03 20:45:30 +00004442Initial Stack, Global Data:
4443---------------------------
wdenkc6097192002-11-03 00:24:07 +00004444
wdenk2729af92004-05-03 20:45:30 +00004445The implementation of U-Boot is complicated by the fact that U-Boot
4446starts running out of ROM (flash memory), usually without access to
4447system RAM (because the memory controller is not initialized yet).
4448This means that we don't have writable Data or BSS segments, and BSS
4449is not initialized as zero. To be able to get a C environment working
4450at all, we have to allocate at least a minimal stack. Implementation
4451options for this are defined and restricted by the CPU used: Some CPU
4452models provide on-chip memory (like the IMMR area on MPC8xx and
4453MPC826x processors), on others (parts of) the data cache can be
4454locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004455
Wolfgang Denk218ca722008-03-26 10:40:12 +01004456 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004457 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004458
wdenk2729af92004-05-03 20:45:30 +00004459 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4460 From: "Chris Hallinan" <clh@net1plus.com>
4461 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4462 ...
wdenk43d96162003-03-06 00:02:04 +00004463
wdenk2729af92004-05-03 20:45:30 +00004464 Correct me if I'm wrong, folks, but the way I understand it
4465 is this: Using DCACHE as initial RAM for Stack, etc, does not
4466 require any physical RAM backing up the cache. The cleverness
4467 is that the cache is being used as a temporary supply of
4468 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004469 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004470 can see how this works by studying the cache architecture and
4471 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004472
wdenk2729af92004-05-03 20:45:30 +00004473 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4474 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004475 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004476 option should work for you. Using CS 4 should be fine if your
4477 board designers haven't used it for something that would
4478 cause you grief during the initial boot! It is frequently not
4479 used.
wdenk43d96162003-03-06 00:02:04 +00004480
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004481 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004482 with your processor/board/system design. The default value
4483 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004484 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004485 than your SDRAM module. If you have a 64MB SDRAM module, set
4486 it above 400_0000. Just make sure your board has no resources
4487 that are supposed to respond to that address! That code in
4488 start.S has been around a while and should work as is when
4489 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004490
wdenk2729af92004-05-03 20:45:30 +00004491 -Chris Hallinan
4492 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004493
wdenk2729af92004-05-03 20:45:30 +00004494It is essential to remember this, since it has some impact on the C
4495code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004496
wdenk2729af92004-05-03 20:45:30 +00004497* Initialized global data (data segment) is read-only. Do not attempt
4498 to write it.
wdenkc6097192002-11-03 00:24:07 +00004499
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004500* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004501 as zero data - BSS segment) at all - this is undefined, initiali-
4502 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004503
wdenk2729af92004-05-03 20:45:30 +00004504* Stack space is very limited. Avoid big data buffers or things like
4505 that.
wdenkc6097192002-11-03 00:24:07 +00004506
wdenk2729af92004-05-03 20:45:30 +00004507Having only the stack as writable memory limits means we cannot use
4508normal global data to share information beween the code. But it
4509turned out that the implementation of U-Boot can be greatly
4510simplified by making a global data structure (gd_t) available to all
4511functions. We could pass a pointer to this data as argument to _all_
4512functions, but this would bloat the code. Instead we use a feature of
4513the GCC compiler (Global Register Variables) to share the data: we
4514place a pointer (gd) to the global data into a register which we
4515reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk2729af92004-05-03 20:45:30 +00004517When choosing a register for such a purpose we are restricted by the
4518relevant (E)ABI specifications for the current architecture, and by
4519GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004520
wdenk2729af92004-05-03 20:45:30 +00004521For PowerPC, the following registers have specific use:
4522 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004523 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004524 R3-R4: parameter passing and return values
4525 R5-R10: parameter passing
4526 R13: small data area pointer
4527 R30: GOT pointer
4528 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004529
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004530 (U-Boot also uses R12 as internal GOT pointer. r12
4531 is a volatile register so r12 needs to be reset when
4532 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004533
Wolfgang Denke7670f62008-02-14 22:43:22 +01004534 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk2729af92004-05-03 20:45:30 +00004536 Note: on PPC, we could use a static initializer (since the
4537 address of the global data structure is known at compile time),
4538 but it turned out that reserving a register results in somewhat
4539 smaller code - although the code savings are not that big (on
4540 average for all boards 752 bytes for the whole U-Boot image,
4541 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004542
Robin Getzc4db3352009-08-17 15:23:02 +00004543On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004544 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4545
Robin Getzc4db3352009-08-17 15:23:02 +00004546 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004547
wdenk2729af92004-05-03 20:45:30 +00004548On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk2729af92004-05-03 20:45:30 +00004550 R0: function argument word/integer result
4551 R1-R3: function argument word
4552 R9: GOT pointer
4553 R10: stack limit (used only if stack checking if enabled)
4554 R11: argument (frame) pointer
4555 R12: temporary workspace
4556 R13: stack pointer
4557 R14: link register
4558 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004559
wdenk2729af92004-05-03 20:45:30 +00004560 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004561
Thomas Chou0df01fd2010-05-21 11:08:03 +08004562On Nios II, the ABI is documented here:
4563 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4564
4565 ==> U-Boot will use gp to hold a pointer to the global data
4566
4567 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4568 to access small data sections, so gp is free.
4569
Macpaul Linafc1ce82011-10-19 20:41:11 +00004570On NDS32, the following registers are used:
4571
4572 R0-R1: argument/return
4573 R2-R5: argument
4574 R15: temporary register for assembler
4575 R16: trampoline register
4576 R28: frame pointer (FP)
4577 R29: global pointer (GP)
4578 R30: link register (LP)
4579 R31: stack pointer (SP)
4580 PC: program counter (PC)
4581
4582 ==> U-Boot will use R10 to hold a pointer to the global data
4583
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004584NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4585or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk2729af92004-05-03 20:45:30 +00004587Memory Management:
4588------------------
wdenkc6097192002-11-03 00:24:07 +00004589
wdenk2729af92004-05-03 20:45:30 +00004590U-Boot runs in system state and uses physical addresses, i.e. the
4591MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk2729af92004-05-03 20:45:30 +00004593The available memory is mapped to fixed addresses using the memory
4594controller. In this process, a contiguous block is formed for each
4595memory type (Flash, SDRAM, SRAM), even when it consists of several
4596physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598U-Boot is installed in the first 128 kB of the first Flash bank (on
4599TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4600booting and sizing and initializing DRAM, the code relocates itself
4601to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004602memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004603configuration setting]. Below that, a structure with global Board
4604Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004605
wdenk2729af92004-05-03 20:45:30 +00004606Additionally, some exception handler code is copied to the low 8 kB
4607of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004608
wdenk2729af92004-05-03 20:45:30 +00004609So a typical memory configuration with 16 MB of DRAM could look like
4610this:
wdenkc6097192002-11-03 00:24:07 +00004611
wdenk2729af92004-05-03 20:45:30 +00004612 0x0000 0000 Exception Vector code
4613 :
4614 0x0000 1FFF
4615 0x0000 2000 Free for Application Use
4616 :
4617 :
wdenkc6097192002-11-03 00:24:07 +00004618
wdenk2729af92004-05-03 20:45:30 +00004619 :
4620 :
4621 0x00FB FF20 Monitor Stack (Growing downward)
4622 0x00FB FFAC Board Info Data and permanent copy of global data
4623 0x00FC 0000 Malloc Arena
4624 :
4625 0x00FD FFFF
4626 0x00FE 0000 RAM Copy of Monitor Code
4627 ... eventually: LCD or video framebuffer
4628 ... eventually: pRAM (Protected RAM - unchanged by reset)
4629 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004630
4631
wdenk2729af92004-05-03 20:45:30 +00004632System Initialization:
4633----------------------
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk2729af92004-05-03 20:45:30 +00004635In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004636(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004637configuration for CS0# this is a mirror of the onboard Flash memory.
4638To be able to re-map memory U-Boot then jumps to its link address.
4639To be able to implement the initialization code in C, a (small!)
4640initial stack is set up in the internal Dual Ported RAM (in case CPUs
4641which provide such a feature like MPC8xx or MPC8260), or in a locked
4642part of the data cache. After that, U-Boot initializes the CPU core,
4643the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk2729af92004-05-03 20:45:30 +00004645Next, all (potentially) available memory banks are mapped using a
4646preliminary mapping. For example, we put them on 512 MB boundaries
4647(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4648on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4649programmed for SDRAM access. Using the temporary configuration, a
4650simple memory test is run that determines the size of the SDRAM
4651banks.
wdenkc6097192002-11-03 00:24:07 +00004652
wdenk2729af92004-05-03 20:45:30 +00004653When there is more than one SDRAM bank, and the banks are of
4654different size, the largest is mapped first. For equal size, the first
4655bank (CS2#) is mapped first. The first mapping is always for address
46560x00000000, with any additional banks following immediately to create
4657contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004658
wdenk2729af92004-05-03 20:45:30 +00004659Then, the monitor installs itself at the upper end of the SDRAM area
4660and allocates memory for use by malloc() and for the global Board
4661Info data; also, the exception vector code is copied to the low RAM
4662pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk2729af92004-05-03 20:45:30 +00004664Only after this relocation will you have a "normal" C environment;
4665until that you are restricted in several ways, mostly because you are
4666running from ROM, and because the code will have to be relocated to a
4667new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004668
4669
wdenk2729af92004-05-03 20:45:30 +00004670U-Boot Porting Guide:
4671----------------------
wdenkc6097192002-11-03 00:24:07 +00004672
wdenk2729af92004-05-03 20:45:30 +00004673[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4674list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004675
4676
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004677int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004678{
4679 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004680
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004681 signal(SIGALRM, no_more_time);
4682 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004683
wdenk2729af92004-05-03 20:45:30 +00004684 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004685 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004686 return 0;
4687 }
4688
wdenk2729af92004-05-03 20:45:30 +00004689 Download latest U-Boot source;
4690
Wolfgang Denk06682362008-12-30 22:56:11 +01004691 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004692
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004693 if (clueless)
4694 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk2729af92004-05-03 20:45:30 +00004696 while (learning) {
4697 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004698 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4699 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004700 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004701 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004702 }
wdenkc6097192002-11-03 00:24:07 +00004703
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004704 if (available_money > toLocalCurrency ($2500))
4705 Buy a BDI3000;
4706 else
wdenk2729af92004-05-03 20:45:30 +00004707 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004708
4709 if (a similar board exists) { /* hopefully... */
4710 cp -a board/<similar> board/<myboard>
4711 cp include/configs/<similar>.h include/configs/<myboard>.h
4712 } else {
4713 Create your own board support subdirectory;
4714 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004715 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004716 Edit new board/<myboard> files
4717 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004718
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004719 while (!accepted) {
4720 while (!running) {
4721 do {
4722 Add / modify source code;
4723 } until (compiles);
4724 Debug;
4725 if (clueless)
4726 email("Hi, I am having problems...");
4727 }
4728 Send patch file to the U-Boot email list;
4729 if (reasonable critiques)
4730 Incorporate improvements from email list code review;
4731 else
4732 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004733 }
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk2729af92004-05-03 20:45:30 +00004735 return 0;
4736}
4737
4738void no_more_time (int sig)
4739{
4740 hire_a_guru();
4741}
wdenkc6097192002-11-03 00:24:07 +00004742
4743
wdenk2729af92004-05-03 20:45:30 +00004744Coding Standards:
4745-----------------
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk2729af92004-05-03 20:45:30 +00004747All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004748coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004749"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004750
Detlev Zundel2c051652006-09-01 15:39:02 +02004751Source files originating from a different project (for example the
4752MTD subsystem) are generally exempt from these guidelines and are not
4753reformated to ease subsequent migration to newer versions of those
4754sources.
4755
4756Please note that U-Boot is implemented in C (and to some small parts in
4757Assembler); no C++ is used, so please do not use C++ style comments (//)
4758in your code.
wdenk2729af92004-05-03 20:45:30 +00004759
4760Please also stick to the following formatting rules:
4761- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004762- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004763- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004764- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004765- do not add trailing empty lines to source files
4766
4767Submissions which do not conform to the standards may be returned
4768with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004769
4770
wdenk2729af92004-05-03 20:45:30 +00004771Submitting Patches:
4772-------------------
wdenkc6097192002-11-03 00:24:07 +00004773
wdenk2729af92004-05-03 20:45:30 +00004774Since the number of patches for U-Boot is growing, we need to
4775establish some rules. Submissions which do not conform to these rules
4776may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004777
Magnus Lilja0d28f342008-08-06 19:32:33 +02004778Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004779
Wolfgang Denk06682362008-12-30 22:56:11 +01004780Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4781see http://lists.denx.de/mailman/listinfo/u-boot
4782
wdenk2729af92004-05-03 20:45:30 +00004783When you send a patch, please include the following information with
4784it:
wdenkc6097192002-11-03 00:24:07 +00004785
wdenk2729af92004-05-03 20:45:30 +00004786* For bug fixes: a description of the bug and how your patch fixes
4787 this bug. Please try to include a way of demonstrating that the
4788 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004789
wdenk2729af92004-05-03 20:45:30 +00004790* For new features: a description of the feature and your
4791 implementation.
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk2729af92004-05-03 20:45:30 +00004793* A CHANGELOG entry as plaintext (separate from the patch)
4794
4795* For major contributions, your entry to the CREDITS file
4796
4797* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004798 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004799
4800* If your patch adds new configuration options, don't forget to
4801 document these in the README file.
4802
Wolfgang Denk218ca722008-03-26 10:40:12 +01004803* The patch itself. If you are using git (which is *strongly*
4804 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004805 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004806 the U-Boot mailing list, you will avoid most of the common problems
4807 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004808
Wolfgang Denk218ca722008-03-26 10:40:12 +01004809 If you cannot use git, use "diff -purN OLD NEW". If your version of
4810 diff does not support these options, then get the latest version of
4811 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004812
Wolfgang Denk218ca722008-03-26 10:40:12 +01004813 The current directory when running this command shall be the parent
4814 directory of the U-Boot source tree (i. e. please make sure that
4815 your patch includes sufficient directory information for the
4816 affected files).
4817
4818 We prefer patches as plain text. MIME attachments are discouraged,
4819 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004820
4821* If one logical set of modifications affects or creates several
4822 files, all these changes shall be submitted in a SINGLE patch file.
4823
4824* Changesets that contain different, unrelated modifications shall be
4825 submitted as SEPARATE patches, one patch per changeset.
4826
4827
4828Notes:
4829
4830* Before sending the patch, run the MAKEALL script on your patched
4831 source tree and make sure that no errors or warnings are reported
4832 for any of the boards.
4833
4834* Keep your modifications to the necessary minimum: A patch
4835 containing several unrelated changes or arbitrary reformats will be
4836 returned with a request to re-formatting / split it.
4837
4838* If you modify existing code, make sure that your new code does not
4839 add to the memory footprint of the code ;-) Small is beautiful!
4840 When adding new features, these should compile conditionally only
4841 (using #ifdef), and the resulting code with the new feature
4842 disabled must not need more memory than the old code without your
4843 modification.
wdenk90dc6702005-05-03 14:12:25 +00004844
Wolfgang Denk06682362008-12-30 22:56:11 +01004845* Remember that there is a size limit of 100 kB per message on the
4846 u-boot mailing list. Bigger patches will be moderated. If they are
4847 reasonable and not too big, they will be acknowledged. But patches
4848 bigger than the size limit should be avoided.