blob: 1f8bd204955c0c920a0c390459ea50beb7984bcf [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
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
Christian Rieschb67d8812012-02-02 00:44:39 +0000423- ARM options:
424 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
425
426 Select high exception vectors of the ARM core, e.g., do not
427 clear the V bit of the c1 register of CP15.
428
wdenk5da627a2003-10-09 20:09:04 +0000429- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000430 CONFIG_CLOCKS_IN_MHZ
431
432 U-Boot stores all clock information in Hz
433 internally. For binary compatibility with older Linux
434 kernels (which expect the clocks passed in the
435 bd_info data to be in MHz) the environment variable
436 "clocks_in_mhz" can be defined so that U-Boot
437 converts clock data to MHZ before passing it to the
438 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000439 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100440 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000441 default environment.
442
wdenk5da627a2003-10-09 20:09:04 +0000443 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
444
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200445 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000446 expect it to be in bytes, others in MB.
447 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
448
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400449 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200450
451 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400452 passed using flattened device trees (based on open firmware
453 concepts).
454
455 CONFIG_OF_LIBFDT
456 * New libfdt-based support
457 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500458 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400459
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200460 OF_CPU - The proper name of the cpus node (only required for
461 MPC512X and MPC5xxx based boards).
462 OF_SOC - The proper name of the soc node (only required for
463 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200464 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600465 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200466
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200467 boards with QUICC Engines require OF_QE to set UCC MAC
468 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500469
Kumar Gala4e253132006-01-11 13:54:17 -0600470 CONFIG_OF_BOARD_SETUP
471
472 Board code has addition modification that it wants to make
473 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000474
Matthew McClintock02677682006-06-28 10:41:37 -0500475 CONFIG_OF_BOOT_CPU
476
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200477 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500478 param header, the default value is zero if undefined.
479
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200480 CONFIG_OF_IDE_FIXUP
481
482 U-Boot can detect if an IDE device is present or not.
483 If not, and this new config option is activated, U-Boot
484 removes the ATA node from the DTS before booting Linux,
485 so the Linux IDE driver does not probe the device and
486 crash. This is needed for buggy hardware (uc101) where
487 no pull down resistor is connected to the signal IDE5V_DD7.
488
Igor Grinberg7eb29392011-07-14 05:45:07 +0000489 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
490
491 This setting is mandatory for all boards that have only one
492 machine type and must be used to specify the machine type
493 number as it appears in the ARM machine registry
494 (see http://www.arm.linux.org.uk/developer/machines/).
495 Only boards that have multiple machine types supported
496 in a single configuration file and the machine type is
497 runtime discoverable, do not have to use this setting.
498
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100499- vxWorks boot parameters:
500
501 bootvx constructs a valid bootline using the following
502 environments variables: bootfile, ipaddr, serverip, hostname.
503 It loads the vxWorks image pointed bootfile.
504
505 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
506 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
507 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
508 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
509
510 CONFIG_SYS_VXWORKS_ADD_PARAMS
511
512 Add it at the end of the bootline. E.g "u=username pw=secret"
513
514 Note: If a "bootargs" environment is defined, it will overwride
515 the defaults discussed just above.
516
Aneesh V2c451f72011-06-16 23:30:47 +0000517- Cache Configuration:
518 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
519 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
520 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
521
Aneesh V93bc2192011-06-16 23:30:51 +0000522- Cache Configuration for ARM:
523 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
524 controller
525 CONFIG_SYS_PL310_BASE - Physical base address of PL310
526 controller register space
527
wdenk6705d812004-08-02 23:22:59 +0000528- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200529 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000530
531 Define this if you want support for Amba PrimeCell PL010 UARTs.
532
Andreas Engel48d01922008-09-08 14:30:53 +0200533 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000534
535 Define this if you want support for Amba PrimeCell PL011 UARTs.
536
537 CONFIG_PL011_CLOCK
538
539 If you have Amba PrimeCell PL011 UARTs, set this variable to
540 the clock speed of the UARTs.
541
542 CONFIG_PL01x_PORTS
543
544 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
545 define this to a list of base addresses for each (supported)
546 port. See e.g. include/configs/versatile.h
547
John Rigby910f1ae2011-04-19 10:42:39 +0000548 CONFIG_PL011_SERIAL_RLCR
549
550 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
551 have separate receive and transmit line control registers. Set
552 this variable to initialize the extra register.
553
554 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
555
556 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
557 boot loader that has already initialized the UART. Define this
558 variable to flush the UART at init time.
559
wdenk6705d812004-08-02 23:22:59 +0000560
wdenkc6097192002-11-03 00:24:07 +0000561- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000562 Depending on board, define exactly one serial port
563 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
564 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
565 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000566
567 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
568 port routines must be defined elsewhere
569 (i.e. serial_init(), serial_getc(), ...)
570
571 CONFIG_CFB_CONSOLE
572 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000573 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000574 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
575 (default big endian)
576 VIDEO_HW_RECTFILL graphic chip supports
577 rectangle fill
578 (cf. smiLynxEM)
579 VIDEO_HW_BITBLT graphic chip supports
580 bit-blit (cf. smiLynxEM)
581 VIDEO_VISIBLE_COLS visible pixel columns
582 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000583 VIDEO_VISIBLE_ROWS visible pixel rows
584 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000585 VIDEO_DATA_FORMAT graphic data format
586 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000587 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000588 VIDEO_KBD_INIT_FCT keyboard int fct
589 (i.e. i8042_kbd_init())
590 VIDEO_TSTC_FCT test char fct
591 (i.e. i8042_tstc)
592 VIDEO_GETC_FCT get char fct
593 (i.e. i8042_getc)
594 CONFIG_CONSOLE_CURSOR cursor drawing on/off
595 (requires blink timer
596 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200597 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000598 CONFIG_CONSOLE_TIME display time/date info in
599 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500600 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000601 CONFIG_VIDEO_LOGO display Linux logo in
602 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000603 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
604 linux_logo.h for logo.
605 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000606 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200607 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000608 the logo
609
wdenk43d96162003-03-06 00:02:04 +0000610 When CONFIG_CFB_CONSOLE is defined, video console is
611 default i/o. Serial console can be forced with
612 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000613
wdenkd4ca31c2004-01-02 14:00:00 +0000614 When CONFIG_SILENT_CONSOLE is defined, all console
615 messages (by U-Boot and Linux!) can be silenced with
616 the "silent" environment variable. See
617 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000618
wdenkc6097192002-11-03 00:24:07 +0000619- Console Baudrate:
620 CONFIG_BAUDRATE - in bps
621 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200622 CONFIG_SYS_BAUDRATE_TABLE, see below.
623 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000624
Heiko Schocherc92fac92009-01-30 12:55:38 +0100625- Console Rx buffer length
626 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
627 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100628 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100629 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
630 must be defined, to setup the maximum idle timeout for
631 the SMC.
632
Graeme Russ9558b482011-09-01 00:48:27 +0000633- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200634 Prior to the console being initialised (i.e. serial UART
635 initialised etc) all console output is silently discarded.
636 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
637 buffer any console messages prior to the console being
638 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
639 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
640 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200641 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200642 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000643
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200644 'Sane' compilers will generate smaller code if
645 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000646
Simon Glass295d3942011-10-18 13:43:20 +0000647- Pre-console putc():
648 Prior to the console being initialised, console output is
649 normally silently discarded. This can be annoying if a
650 panic() happens in this time.
651
652 If the CONFIG_PRE_CONSOLE_PUTC option is defined, then
653 U-Boot will call board_pre_console_putc() for each output
654 character in this case, This function should try to output
655 the character if possible, perhaps on all available UARTs
656 (it will need to do this directly, since the console code
657 is not functional yet). Note that if the panic happens
658 early enough, then it is possible that board_init_f()
659 (or even arch_cpu_init() on ARM) has not been called yet.
660 You should init all clocks, GPIOs, etc. that are needed
661 to get the character out. Baud rates will need to default
662 to something sensible.
663
Sonny Rao046a37b2011-11-02 09:52:08 +0000664- Safe printf() functions
665 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
666 the printf() functions. These are defined in
667 include/vsprintf.h and include snprintf(), vsnprintf() and
668 so on. Code size increase is approximately 300-500 bytes.
669 If this option is not given then these functions will
670 silently discard their buffer size argument - this means
671 you are not getting any overflow checking in this case.
672
wdenkc6097192002-11-03 00:24:07 +0000673- Boot Delay: CONFIG_BOOTDELAY - in seconds
674 Delay before automatically booting the default image;
675 set to -1 to disable autoboot.
676
677 See doc/README.autoboot for these options that
678 work with CONFIG_BOOTDELAY. None are required.
679 CONFIG_BOOT_RETRY_TIME
680 CONFIG_BOOT_RETRY_MIN
681 CONFIG_AUTOBOOT_KEYED
682 CONFIG_AUTOBOOT_PROMPT
683 CONFIG_AUTOBOOT_DELAY_STR
684 CONFIG_AUTOBOOT_STOP_STR
685 CONFIG_AUTOBOOT_DELAY_STR2
686 CONFIG_AUTOBOOT_STOP_STR2
687 CONFIG_ZERO_BOOTDELAY_CHECK
688 CONFIG_RESET_TO_RETRY
689
690- Autoboot Command:
691 CONFIG_BOOTCOMMAND
692 Only needed when CONFIG_BOOTDELAY is enabled;
693 define a command string that is automatically executed
694 when no character is read on the console interface
695 within "Boot Delay" after reset.
696
697 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000698 This can be used to pass arguments to the bootm
699 command. The value of CONFIG_BOOTARGS goes into the
700 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000701
702 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000703 The value of these goes into the environment as
704 "ramboot" and "nfsboot" respectively, and can be used
705 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200706 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000707
708- Pre-Boot Commands:
709 CONFIG_PREBOOT
710
711 When this option is #defined, the existence of the
712 environment variable "preboot" will be checked
713 immediately before starting the CONFIG_BOOTDELAY
714 countdown and/or running the auto-boot command resp.
715 entering interactive mode.
716
717 This feature is especially useful when "preboot" is
718 automatically generated or modified. For an example
719 see the LWMON board specific code: here "preboot" is
720 modified when the user holds down a certain
721 combination of keys on the (special) keyboard when
722 booting the systems
723
724- Serial Download Echo Mode:
725 CONFIG_LOADS_ECHO
726 If defined to 1, all characters received during a
727 serial download (using the "loads" command) are
728 echoed back. This might be needed by some terminal
729 emulations (like "cu"), but may as well just take
730 time on others. This setting #define's the initial
731 value of the "loads_echo" environment variable.
732
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500733- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000734 CONFIG_KGDB_BAUDRATE
735 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200736 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000737
738- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500739 Monitor commands can be included or excluded
740 from the build by using the #include files
741 "config_cmd_all.h" and #undef'ing unwanted
742 commands, or using "config_cmd_default.h"
743 and augmenting with additional #define's
744 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000745
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500746 The default command configuration includes all commands
747 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000748
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500749 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500750 CONFIG_CMD_BDI bdinfo
751 CONFIG_CMD_BEDBUG * Include BedBug Debugger
752 CONFIG_CMD_BMP * BMP support
753 CONFIG_CMD_BSP * Board specific commands
754 CONFIG_CMD_BOOTD bootd
755 CONFIG_CMD_CACHE * icache, dcache
756 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500757 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500758 CONFIG_CMD_DATE * support for RTC, date/time...
759 CONFIG_CMD_DHCP * DHCP support
760 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600761 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
762 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
763 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
764 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500765 CONFIG_CMD_DTT * Digital Therm and Thermostat
766 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500767 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500768 CONFIG_CMD_EEPROM * EEPROM read/write support
769 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500770 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500771 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500772 CONFIG_CMD_FDC * Floppy Disk Support
773 CONFIG_CMD_FAT * FAT partition support
774 CONFIG_CMD_FDOS * Dos diskette Support
775 CONFIG_CMD_FLASH flinfo, erase, protect
776 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500777 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000778 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500779 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
780 CONFIG_CMD_I2C * I2C serial bus support
781 CONFIG_CMD_IDE * IDE harddisk support
782 CONFIG_CMD_IMI iminfo
783 CONFIG_CMD_IMLS List all found images
784 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500785 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500786 CONFIG_CMD_IRQ * irqinfo
787 CONFIG_CMD_ITEST Integer/string test of 2 values
788 CONFIG_CMD_JFFS2 * JFFS2 Support
789 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500790 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500791 CONFIG_CMD_LOADB loadb
792 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400793 CONFIG_CMD_MD5SUM print md5 message digest
794 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500795 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
796 loop, loopw, mtest
797 CONFIG_CMD_MISC Misc functions like sleep etc
798 CONFIG_CMD_MMC * MMC memory mapped support
799 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100800 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500801 CONFIG_CMD_NAND * NAND support
802 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600803 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000804 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500805 CONFIG_CMD_PCI * pciinfo
806 CONFIG_CMD_PCMCIA * PCMCIA support
807 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
808 host
809 CONFIG_CMD_PORTIO * Port I/O
810 CONFIG_CMD_REGINFO * Register dump
811 CONFIG_CMD_RUN run command in env variable
812 CONFIG_CMD_SAVES * save S record dump
813 CONFIG_CMD_SCSI * SCSI Support
814 CONFIG_CMD_SDRAM * print SDRAM configuration information
815 (requires CONFIG_CMD_I2C)
816 CONFIG_CMD_SETGETDCR Support for DCR Register access
817 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700818 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100819 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400820 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200821 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500822 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000823 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000824 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000825 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500826 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500827 CONFIG_CMD_CDP * Cisco Discover Protocol support
828 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000829
wdenkc6097192002-11-03 00:24:07 +0000830
831 EXAMPLE: If you want all functions except of network
832 support you can write:
833
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500834 #include "config_cmd_all.h"
835 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000836
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400837 Other Commands:
838 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000839
840 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500841 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000842 what you (and your U-Boot users) are doing. Data
843 cache cannot be enabled on systems like the 8xx or
844 8260 (where accesses to the IMMR region must be
845 uncached), and it cannot be disabled on all other
846 systems where we (mis-) use the data cache to hold an
847 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000848
849
850 XXX - this list needs to get updated!
851
Simon Glass45ba8072011-10-15 05:48:20 +0000852- Device tree:
853 CONFIG_OF_CONTROL
854 If this variable is defined, U-Boot will use a device tree
855 to configure its devices, instead of relying on statically
856 compiled #defines in the board file. This option is
857 experimental and only available on a few boards. The device
858 tree is available in the global data as gd->fdt_blob.
859
Simon Glass2c0f79e2011-10-24 19:15:31 +0000860 U-Boot needs to get its device tree from somewhere. This can
861 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000862
863 CONFIG_OF_EMBED
864 If this variable is defined, U-Boot will embed a device tree
865 binary in its image. This device tree file should be in the
866 board directory and called <soc>-<board>.dts. The binary file
867 is then picked up in board_init_f() and made available through
868 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000869
Simon Glass2c0f79e2011-10-24 19:15:31 +0000870 CONFIG_OF_SEPARATE
871 If this variable is defined, U-Boot will build a device tree
872 binary. It will be called u-boot.dtb. Architecture-specific
873 code will locate it at run-time. Generally this works by:
874
875 cat u-boot.bin u-boot.dtb >image.bin
876
877 and in fact, U-Boot does this for you, creating a file called
878 u-boot-dtb.bin which is useful in the common case. You can
879 still use the individual files if you need something more
880 exotic.
881
wdenkc6097192002-11-03 00:24:07 +0000882- Watchdog:
883 CONFIG_WATCHDOG
884 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000885 support for the SoC. There must be support in the SoC
886 specific code for a watchdog. For the 8xx and 8260
887 CPUs, the SIU Watchdog feature is enabled in the SYPCR
888 register. When supported for a specific SoC is
889 available, then no further board specific code should
890 be needed to use it.
891
892 CONFIG_HW_WATCHDOG
893 When using a watchdog circuitry external to the used
894 SoC, then define this variable and provide board
895 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000896
stroesec1551ea2003-04-04 15:53:41 +0000897- U-Boot Version:
898 CONFIG_VERSION_VARIABLE
899 If this variable is defined, an environment variable
900 named "ver" is created by U-Boot showing the U-Boot
901 version as printed by the "version" command.
902 This variable is readonly.
903
wdenkc6097192002-11-03 00:24:07 +0000904- Real-Time Clock:
905
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500906 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000907 has to be selected, too. Define exactly one of the
908 following options:
909
910 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
911 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000912 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000913 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000914 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000915 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000916 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000917 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100918 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000919 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200920 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200921 CONFIG_SYS_RV3029_TCR - enable trickle charger on
922 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000923
wdenkb37c7e52003-06-30 16:24:52 +0000924 Note that if the RTC uses I2C, then the I2C interface
925 must also be configured. See I2C Support, below.
926
Peter Tysere92739d2008-12-17 16:36:21 -0600927- GPIO Support:
928 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
929 CONFIG_PCA953X_INFO - enable pca953x info command
930
Chris Packham5dec49c2010-12-19 10:12:13 +0000931 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
932 chip-ngpio pairs that tell the PCA953X driver the number of
933 pins supported by a particular chip.
934
Peter Tysere92739d2008-12-17 16:36:21 -0600935 Note that if the GPIO device uses I2C, then the I2C interface
936 must also be configured. See I2C Support, below.
937
wdenkc6097192002-11-03 00:24:07 +0000938- Timestamp Support:
939
wdenk43d96162003-03-06 00:02:04 +0000940 When CONFIG_TIMESTAMP is selected, the timestamp
941 (date and time) of an image is printed by image
942 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500943 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000944
945- Partition Support:
946 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400947 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000948
Wolfgang Denk218ca722008-03-26 10:40:12 +0100949 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
950 CONFIG_CMD_SCSI) you must configure support for at
951 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000952
953- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000954 CONFIG_IDE_RESET_ROUTINE - this is defined in several
955 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000956
wdenk4d13cba2004-03-14 14:09:05 +0000957 CONFIG_IDE_RESET - is this is defined, IDE Reset will
958 be performed by calling the function
959 ide_set_reset(int reset)
960 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000961
962- ATAPI Support:
963 CONFIG_ATAPI
964
965 Set this to enable ATAPI support.
966
wdenkc40b2952004-03-13 23:29:43 +0000967- LBA48 Support
968 CONFIG_LBA48
969
970 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100971 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000972 Whithout these , LBA48 support uses 32bit variables and will 'only'
973 support disks up to 2.1TB.
974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200975 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000976 When enabled, makes the IDE subsystem use 64bit sector addresses.
977 Default is 32bit.
978
wdenkc6097192002-11-03 00:24:07 +0000979- SCSI Support:
980 At the moment only there is only support for the
981 SYM53C8XX SCSI controller; define
982 CONFIG_SCSI_SYM53C8XX to enable it.
983
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200984 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
985 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
986 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000987 maximum numbers of LUNs, SCSI ID's and target
988 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200989 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000990
991- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000992 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000993 Support for Intel 8254x/8257x gigabit chips.
994
995 CONFIG_E1000_SPI
996 Utility code for direct access to the SPI bus on Intel 8257x.
997 This does not do anything useful unless you set at least one
998 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
999
1000 CONFIG_E1000_SPI_GENERIC
1001 Allow generic access to the SPI bus on the Intel 8257x, for
1002 example with the "sspi" command.
1003
1004 CONFIG_CMD_E1000
1005 Management command for E1000 devices. When used on devices
1006 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001007
Andre Schwarzac3315c2008-03-06 16:45:44 +01001008 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001009 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001010
wdenkc6097192002-11-03 00:24:07 +00001011 CONFIG_EEPRO100
1012 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001013 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001014 write routine for first time initialisation.
1015
1016 CONFIG_TULIP
1017 Support for Digital 2114x chips.
1018 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1019 modem chip initialisation (KS8761/QS6611).
1020
1021 CONFIG_NATSEMI
1022 Support for National dp83815 chips.
1023
1024 CONFIG_NS8382X
1025 Support for National dp8382[01] gigabit chips.
1026
wdenk45219c42003-05-12 21:50:16 +00001027- NETWORK Support (other):
1028
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001029 CONFIG_DRIVER_AT91EMAC
1030 Support for AT91RM9200 EMAC.
1031
1032 CONFIG_RMII
1033 Define this to use reduced MII inteface
1034
1035 CONFIG_DRIVER_AT91EMAC_QUIET
1036 If this defined, the driver is quiet.
1037 The driver doen't show link status messages.
1038
Rob Herringefdd7312011-12-15 11:15:49 +00001039 CONFIG_CALXEDA_XGMAC
1040 Support for the Calxeda XGMAC device
1041
wdenk45219c42003-05-12 21:50:16 +00001042 CONFIG_DRIVER_LAN91C96
1043 Support for SMSC's LAN91C96 chips.
1044
1045 CONFIG_LAN91C96_BASE
1046 Define this to hold the physical address
1047 of the LAN91C96's I/O space
1048
1049 CONFIG_LAN91C96_USE_32_BIT
1050 Define this to enable 32 bit addressing
1051
wdenkf39748a2004-06-09 13:37:52 +00001052 CONFIG_DRIVER_SMC91111
1053 Support for SMSC's LAN91C111 chip
1054
1055 CONFIG_SMC91111_BASE
1056 Define this to hold the physical address
1057 of the device (I/O space)
1058
1059 CONFIG_SMC_USE_32_BIT
1060 Define this if data bus is 32 bits
1061
1062 CONFIG_SMC_USE_IOFUNCS
1063 Define this to use i/o functions instead of macros
1064 (some hardware wont work with macros)
1065
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001066 CONFIG_DRIVER_TI_EMAC
1067 Support for davinci emac
1068
1069 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1070 Define this if you have more then 3 PHYs.
1071
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001072 CONFIG_FTGMAC100
1073 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1074
1075 CONFIG_FTGMAC100_EGIGA
1076 Define this to use GE link update with gigabit PHY.
1077 Define this if FTGMAC100 is connected to gigabit PHY.
1078 If your system has 10/100 PHY only, it might not occur
1079 wrong behavior. Because PHY usually return timeout or
1080 useless data when polling gigabit status and gigabit
1081 control registers. This behavior won't affect the
1082 correctnessof 10/100 link speed update.
1083
Mike Rapoportc2fff332009-11-11 10:03:03 +02001084 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001085 Support for SMSC's LAN911x and LAN921x chips
1086
Mike Rapoportc2fff332009-11-11 10:03:03 +02001087 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001088 Define this to hold the physical address
1089 of the device (I/O space)
1090
Mike Rapoportc2fff332009-11-11 10:03:03 +02001091 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001092 Define this if data bus is 32 bits
1093
Mike Rapoportc2fff332009-11-11 10:03:03 +02001094 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001095 Define this if data bus is 16 bits. If your processor
1096 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001097 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001098
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001099 CONFIG_SH_ETHER
1100 Support for Renesas on-chip Ethernet controller
1101
1102 CONFIG_SH_ETHER_USE_PORT
1103 Define the number of ports to be used
1104
1105 CONFIG_SH_ETHER_PHY_ADDR
1106 Define the ETH PHY's address
1107
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001108 CONFIG_SH_ETHER_CACHE_WRITEBACK
1109 If this option is set, the driver enables cache flush.
1110
Vadim Bendebury5e124722011-10-17 08:36:14 +00001111- TPM Support:
1112 CONFIG_GENERIC_LPC_TPM
1113 Support for generic parallel port TPM devices. Only one device
1114 per system is supported at this time.
1115
1116 CONFIG_TPM_TIS_BASE_ADDRESS
1117 Base address where the generic TPM device is mapped
1118 to. Contemporary x86 systems usually map it at
1119 0xfed40000.
1120
wdenkc6097192002-11-03 00:24:07 +00001121- USB Support:
1122 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001123 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001124 CONFIG_USB_UHCI to enable it.
1125 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001126 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001127 storage devices.
1128 Note:
1129 Supported are USB Keyboards and USB Floppy drives
1130 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001131 MPC5200 USB requires additional defines:
1132 CONFIG_USB_CLOCK
1133 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001134 CONFIG_PSC3_USB
1135 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001136 CONFIG_USB_CONFIG
1137 for differential drivers: 0x00001000
1138 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001139 for differential drivers on PSC3: 0x00000100
1140 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001141 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001142 May be defined to allow interrupt polling
1143 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001144
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001145- USB Device:
1146 Define the below if you wish to use the USB console.
1147 Once firmware is rebuilt from a serial console issue the
1148 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001149 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001150 it has found a new device. The environment variable usbtty
1151 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001152 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001153 Common Device Class Abstract Control Model serial device.
1154 If you select usbtty = gserial you should be able to enumerate
1155 a Linux host by
1156 # modprobe usbserial vendor=0xVendorID product=0xProductID
1157 else if using cdc_acm, simply setting the environment
1158 variable usbtty to be cdc_acm should suffice. The following
1159 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001160
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001161 CONFIG_USB_DEVICE
1162 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001163
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001164 CONFIG_USB_TTY
1165 Define this to have a tty type of device available to
1166 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001167
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001168 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001169 Define this if you want stdin, stdout &/or stderr to
1170 be set to usbtty.
1171
1172 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001173 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001174 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001175 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001177 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001178 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001179 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001180
Wolfgang Denk386eda02006-06-14 18:14:56 +02001181 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001182 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001183 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001184 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1185 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1186 should pretend to be a Linux device to it's target host.
1187
1188 CONFIG_USBD_MANUFACTURER
1189 Define this string as the name of your company for
1190 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001191
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001192 CONFIG_USBD_PRODUCT_NAME
1193 Define this string as the name of your product
1194 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1195
1196 CONFIG_USBD_VENDORID
1197 Define this as your assigned Vendor ID from the USB
1198 Implementors Forum. This *must* be a genuine Vendor ID
1199 to avoid polluting the USB namespace.
1200 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001201
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001202 CONFIG_USBD_PRODUCTID
1203 Define this as the unique Product ID
1204 for your device
1205 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001206
Igor Grinbergd70a5602011-12-12 12:08:35 +02001207- ULPI Layer Support:
1208 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1209 the generic ULPI layer. The generic layer accesses the ULPI PHY
1210 via the platform viewport, so you need both the genric layer and
1211 the viewport enabled. Currently only Chipidea/ARC based
1212 viewport is supported.
1213 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1214 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
wdenkc6097192002-11-03 00:24:07 +00001215
1216- MMC Support:
1217 The MMC controller on the Intel PXA is supported. To
1218 enable this define CONFIG_MMC. The MMC can be
1219 accessed from the boot prompt by mapping the device
1220 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001221 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1222 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001223
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001224 CONFIG_SH_MMCIF
1225 Support for Renesas on-chip MMCIF controller
1226
1227 CONFIG_SH_MMCIF_ADDR
1228 Define the base address of MMCIF registers
1229
1230 CONFIG_SH_MMCIF_CLK
1231 Define the clock frequency for MMCIF
1232
wdenk6705d812004-08-02 23:22:59 +00001233- Journaling Flash filesystem support:
1234 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1235 CONFIG_JFFS2_NAND_DEV
1236 Define these for a default partition on a NAND device
1237
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001238 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1239 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001240 Define these for a default partition on a NOR device
1241
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001242 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001243 Define this to create an own partition. You have to provide a
1244 function struct part_info* jffs2_part_info(int part_num)
1245
1246 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001247 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001248 to disable the command chpart. This is the default when you
1249 have not defined a custom partition
1250
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001251- FAT(File Allocation Table) filesystem write function support:
1252 CONFIG_FAT_WRITE
1253 Support for saving memory data as a file
1254 in FAT formatted partition
1255
wdenkc6097192002-11-03 00:24:07 +00001256- Keyboard Support:
1257 CONFIG_ISA_KEYBOARD
1258
1259 Define this to enable standard (PC-Style) keyboard
1260 support
1261
1262 CONFIG_I8042_KBD
1263 Standard PC keyboard driver with US (is default) and
1264 GERMAN key layout (switch via environment 'keymap=de') support.
1265 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1266 for cfb_console. Supports cursor blinking.
1267
1268- Video support:
1269 CONFIG_VIDEO
1270
1271 Define this to enable video support (for output to
1272 video).
1273
1274 CONFIG_VIDEO_CT69000
1275
1276 Enable Chips & Technologies 69000 Video chip
1277
1278 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001279 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001280 video output is selected via environment 'videoout'
1281 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1282 assumed.
wdenkc6097192002-11-03 00:24:07 +00001283
wdenkb79a11c2004-03-25 15:14:43 +00001284 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001285 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001286 are possible:
1287 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001288 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001289
1290 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1291 -------------+---------------------------------------------
1292 8 bits | 0x301* 0x303 0x305 0x161 0x307
1293 15 bits | 0x310 0x313 0x316 0x162 0x319
1294 16 bits | 0x311 0x314 0x317 0x163 0x31A
1295 24 bits | 0x312 0x315 0x318 ? 0x31B
1296 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001297 (i.e. setenv videomode 317; saveenv; reset;)
1298
wdenkb79a11c2004-03-25 15:14:43 +00001299 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001300 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001301
1302
stroesec1551ea2003-04-04 15:53:41 +00001303 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001304 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001305 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1306 or CONFIG_VIDEO_SED13806_16BPP
1307
Timur Tabi7d3053f2011-02-15 17:09:19 -06001308 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001309 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001310 SOCs that have a DIU should define this macro to enable DIU
1311 support, and should also define these other macros:
1312
1313 CONFIG_SYS_DIU_ADDR
1314 CONFIG_VIDEO
1315 CONFIG_CMD_BMP
1316 CONFIG_CFB_CONSOLE
1317 CONFIG_VIDEO_SW_CURSOR
1318 CONFIG_VGA_AS_SINGLE_DEVICE
1319 CONFIG_VIDEO_LOGO
1320 CONFIG_VIDEO_BMP_LOGO
1321
Timur Tabiba8e76b2011-04-11 14:18:22 -05001322 The DIU driver will look for the 'video-mode' environment
1323 variable, and if defined, enable the DIU as a console during
1324 boot. See the documentation file README.video for a
1325 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001326
wdenk682011f2003-06-03 23:54:09 +00001327- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001328 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001329
wdenk8bde7f72003-06-27 21:31:46 +00001330 Define this to enable a custom keyboard support.
1331 This simply calls drv_keyboard_init() which must be
1332 defined in your board-specific files.
1333 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001334
wdenkc6097192002-11-03 00:24:07 +00001335- LCD Support: CONFIG_LCD
1336
1337 Define this to enable LCD support (for output to LCD
1338 display); also select one of the supported displays
1339 by defining one of these:
1340
Stelian Pop39cf4802008-05-09 21:57:18 +02001341 CONFIG_ATMEL_LCD:
1342
1343 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1344
wdenkfd3103b2003-11-25 16:55:19 +00001345 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001346
wdenkfd3103b2003-11-25 16:55:19 +00001347 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001348
wdenkfd3103b2003-11-25 16:55:19 +00001349 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001350
wdenkfd3103b2003-11-25 16:55:19 +00001351 NEC NL6448BC20-08. 6.5", 640x480.
1352 Active, color, single scan.
1353
1354 CONFIG_NEC_NL6448BC33_54
1355
1356 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001357 Active, color, single scan.
1358
1359 CONFIG_SHARP_16x9
1360
1361 Sharp 320x240. Active, color, single scan.
1362 It isn't 16x9, and I am not sure what it is.
1363
1364 CONFIG_SHARP_LQ64D341
1365
1366 Sharp LQ64D341 display, 640x480.
1367 Active, color, single scan.
1368
1369 CONFIG_HLD1045
1370
1371 HLD1045 display, 640x480.
1372 Active, color, single scan.
1373
1374 CONFIG_OPTREX_BW
1375
1376 Optrex CBL50840-2 NF-FW 99 22 M5
1377 or
1378 Hitachi LMG6912RPFC-00T
1379 or
1380 Hitachi SP14Q002
1381
1382 320x240. Black & white.
1383
1384 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001385 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001386
wdenk7152b1d2003-09-05 23:19:14 +00001387- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001388
wdenk8bde7f72003-06-27 21:31:46 +00001389 If this option is set, the environment is checked for
1390 a variable "splashimage". If found, the usual display
1391 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001392 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001393 specified in "splashimage" is loaded instead. The
1394 console is redirected to the "nulldev", too. This
1395 allows for a "silent" boot where a splash screen is
1396 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001397
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001398 CONFIG_SPLASH_SCREEN_ALIGN
1399
1400 If this option is set the splash image can be freely positioned
1401 on the screen. Environment variable "splashpos" specifies the
1402 position as "x,y". If a positive number is given it is used as
1403 number of pixel from left/top. If a negative number is given it
1404 is used as number of pixel from right/bottom. You can also
1405 specify 'm' for centering the image.
1406
1407 Example:
1408 setenv splashpos m,m
1409 => image at center of screen
1410
1411 setenv splashpos 30,20
1412 => image at x = 30 and y = 20
1413
1414 setenv splashpos -10,m
1415 => vertically centered image
1416 at x = dspWidth - bmpWidth - 9
1417
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001418- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1419
1420 If this option is set, additionally to standard BMP
1421 images, gzipped BMP images can be displayed via the
1422 splashscreen support or the bmp command.
1423
Anatolij Gustschind5011762010-03-15 14:50:25 +01001424- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1425
1426 If this option is set, 8-bit RLE compressed BMP images
1427 can be displayed via the splashscreen support or the
1428 bmp command.
1429
wdenkc29fdfc2003-08-29 20:57:53 +00001430- Compression support:
1431 CONFIG_BZIP2
1432
1433 If this option is set, support for bzip2 compressed
1434 images is included. If not, only uncompressed and gzip
1435 compressed images are supported.
1436
wdenk42d1f032003-10-15 23:53:47 +00001437 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001438 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001439 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001440
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001441 CONFIG_LZMA
1442
1443 If this option is set, support for lzma compressed
1444 images is included.
1445
1446 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1447 requires an amount of dynamic memory that is given by the
1448 formula:
1449
1450 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1451
1452 Where lc and lp stand for, respectively, Literal context bits
1453 and Literal pos bits.
1454
1455 This value is upper-bounded by 14MB in the worst case. Anyway,
1456 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1457 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1458 a very small buffer.
1459
1460 Use the lzmainfo tool to determinate the lc and lp values and
1461 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001462 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001463
wdenk17ea1172004-06-06 21:51:03 +00001464- MII/PHY support:
1465 CONFIG_PHY_ADDR
1466
1467 The address of PHY on MII bus.
1468
1469 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1470
1471 The clock frequency of the MII bus
1472
1473 CONFIG_PHY_GIGE
1474
1475 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001476 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001477
1478 CONFIG_PHY_RESET_DELAY
1479
1480 Some PHY like Intel LXT971A need extra delay after
1481 reset before any MII register access is possible.
1482 For such PHY, set this option to the usec delay
1483 required. (minimum 300usec for LXT971A)
1484
1485 CONFIG_PHY_CMD_DELAY (ppc4xx)
1486
1487 Some PHY like Intel LXT971A need extra delay after
1488 command issued before MII status register can be read
1489
wdenkc6097192002-11-03 00:24:07 +00001490- Ethernet address:
1491 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001492 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001493 CONFIG_ETH2ADDR
1494 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001495 CONFIG_ETH4ADDR
1496 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001497
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001498 Define a default value for Ethernet address to use
1499 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001500 is not determined automatically.
1501
1502- IP address:
1503 CONFIG_IPADDR
1504
1505 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001506 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001507 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001508 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001509
1510- Server IP address:
1511 CONFIG_SERVERIP
1512
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001513 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001514 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001515 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001516
Robin Getz97cfe862009-07-21 12:15:28 -04001517 CONFIG_KEEP_SERVERADDR
1518
1519 Keeps the server's MAC address, in the env 'serveraddr'
1520 for passing to bootargs (like Linux's netconsole option)
1521
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001522- Gateway IP address:
1523 CONFIG_GATEWAYIP
1524
1525 Defines a default value for the IP address of the
1526 default router where packets to other networks are
1527 sent to.
1528 (Environment variable "gatewayip")
1529
1530- Subnet mask:
1531 CONFIG_NETMASK
1532
1533 Defines a default value for the subnet mask (or
1534 routing prefix) which is used to determine if an IP
1535 address belongs to the local subnet or needs to be
1536 forwarded through a router.
1537 (Environment variable "netmask")
1538
David Updegraff53a5c422007-06-11 10:41:07 -05001539- Multicast TFTP Mode:
1540 CONFIG_MCAST_TFTP
1541
1542 Defines whether you want to support multicast TFTP as per
1543 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001544 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001545 driver in use must provide a function: mcast() to join/leave a
1546 multicast group.
1547
wdenkc6097192002-11-03 00:24:07 +00001548- BOOTP Recovery Mode:
1549 CONFIG_BOOTP_RANDOM_DELAY
1550
1551 If you have many targets in a network that try to
1552 boot using BOOTP, you may want to avoid that all
1553 systems send out BOOTP requests at precisely the same
1554 moment (which would happen for instance at recovery
1555 from a power failure, when all systems will try to
1556 boot, thus flooding the BOOTP server. Defining
1557 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1558 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001559 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001560
1561 1st BOOTP request: delay 0 ... 1 sec
1562 2nd BOOTP request: delay 0 ... 2 sec
1563 3rd BOOTP request: delay 0 ... 4 sec
1564 4th and following
1565 BOOTP requests: delay 0 ... 8 sec
1566
stroesefe389a82003-08-28 14:17:32 +00001567- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001568 You can fine tune the DHCP functionality by defining
1569 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001570
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001571 CONFIG_BOOTP_SUBNETMASK
1572 CONFIG_BOOTP_GATEWAY
1573 CONFIG_BOOTP_HOSTNAME
1574 CONFIG_BOOTP_NISDOMAIN
1575 CONFIG_BOOTP_BOOTPATH
1576 CONFIG_BOOTP_BOOTFILESIZE
1577 CONFIG_BOOTP_DNS
1578 CONFIG_BOOTP_DNS2
1579 CONFIG_BOOTP_SEND_HOSTNAME
1580 CONFIG_BOOTP_NTPSERVER
1581 CONFIG_BOOTP_TIMEOFFSET
1582 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001583
Wilson Callan5d110f02007-07-28 10:56:13 -04001584 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1585 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001586
1587 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1588 serverip from a DHCP server, it is possible that more
1589 than one DNS serverip is offered to the client.
1590 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1591 serverip will be stored in the additional environment
1592 variable "dnsip2". The first DNS serverip is always
1593 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001594 is defined.
stroesefe389a82003-08-28 14:17:32 +00001595
1596 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1597 to do a dynamic update of a DNS server. To do this, they
1598 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001599 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001600 of the "hostname" environment variable is passed as
1601 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001602
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001603 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1604
1605 A 32bit value in microseconds for a delay between
1606 receiving a "DHCP Offer" and sending the "DHCP Request".
1607 This fixes a problem with certain DHCP servers that don't
1608 respond 100% of the time to a "DHCP request". E.g. On an
1609 AT91RM9200 processor running at 180MHz, this delay needed
1610 to be *at least* 15,000 usec before a Windows Server 2003
1611 DHCP server would reply 100% of the time. I recommend at
1612 least 50,000 usec to be safe. The alternative is to hope
1613 that one of the retries will be successful but note that
1614 the DHCP timeout and retry process takes a longer than
1615 this delay.
1616
wdenka3d991b2004-04-15 21:48:45 +00001617 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001618 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001619
1620 The device id used in CDP trigger frames.
1621
1622 CONFIG_CDP_DEVICE_ID_PREFIX
1623
1624 A two character string which is prefixed to the MAC address
1625 of the device.
1626
1627 CONFIG_CDP_PORT_ID
1628
1629 A printf format string which contains the ascii name of
1630 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001631 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001632
1633 CONFIG_CDP_CAPABILITIES
1634
1635 A 32bit integer which indicates the device capabilities;
1636 0x00000010 for a normal host which does not forwards.
1637
1638 CONFIG_CDP_VERSION
1639
1640 An ascii string containing the version of the software.
1641
1642 CONFIG_CDP_PLATFORM
1643
1644 An ascii string containing the name of the platform.
1645
1646 CONFIG_CDP_TRIGGER
1647
1648 A 32bit integer sent on the trigger.
1649
1650 CONFIG_CDP_POWER_CONSUMPTION
1651
1652 A 16bit integer containing the power consumption of the
1653 device in .1 of milliwatts.
1654
1655 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1656
1657 A byte containing the id of the VLAN.
1658
wdenkc6097192002-11-03 00:24:07 +00001659- Status LED: CONFIG_STATUS_LED
1660
1661 Several configurations allow to display the current
1662 status using a LED. For instance, the LED will blink
1663 fast while running U-Boot code, stop blinking as
1664 soon as a reply to a BOOTP request was received, and
1665 start blinking slow once the Linux kernel is running
1666 (supported by a status LED driver in the Linux
1667 kernel). Defining CONFIG_STATUS_LED enables this
1668 feature in U-Boot.
1669
1670- CAN Support: CONFIG_CAN_DRIVER
1671
1672 Defining CONFIG_CAN_DRIVER enables CAN driver support
1673 on those systems that support this (optional)
1674 feature, like the TQM8xxL modules.
1675
1676- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1677
wdenkb37c7e52003-06-30 16:24:52 +00001678 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001679 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001680 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001681
wdenk945af8d2003-07-16 21:53:01 +00001682 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001683 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001684 CONFIG_COMMANDS) and communicate with i2c based realtime
1685 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001686 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001687
Ben Warrenbb99ad62006-09-07 16:50:54 -04001688 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001689
wdenk945af8d2003-07-16 21:53:01 +00001690 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001691 bit-banging) driver instead of CPM or similar hardware
1692 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001693
wdenk945af8d2003-07-16 21:53:01 +00001694 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001695 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001696
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001697 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001698 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001699 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001700 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001701
Peter Tyser8d321b82010-04-12 22:28:21 -05001702 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001703 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001704 and so its address should therefore be cleared to 0 (See,
1705 eg, MPC823e User's Manual p.16-473). So, set
1706 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001707
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001708 CONFIG_SYS_I2C_INIT_MPC5XXX
1709
1710 When a board is reset during an i2c bus transfer
1711 chips might think that the current transfer is still
1712 in progress. Reset the slave devices by sending start
1713 commands until the slave device responds.
1714
wdenk945af8d2003-07-16 21:53:01 +00001715 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001716
1717 If you use the software i2c interface (CONFIG_SOFT_I2C)
1718 then the following macros need to be defined (examples are
1719 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001720
1721 I2C_INIT
1722
wdenkb37c7e52003-06-30 16:24:52 +00001723 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001724 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001725
wdenkba56f622004-02-06 23:19:44 +00001726 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001727
wdenkc6097192002-11-03 00:24:07 +00001728 I2C_PORT
1729
wdenk43d96162003-03-06 00:02:04 +00001730 (Only for MPC8260 CPU). The I/O port to use (the code
1731 assumes both bits are on the same port). Valid values
1732 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001733
1734 I2C_ACTIVE
1735
1736 The code necessary to make the I2C data line active
1737 (driven). If the data line is open collector, this
1738 define can be null.
1739
wdenkb37c7e52003-06-30 16:24:52 +00001740 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1741
wdenkc6097192002-11-03 00:24:07 +00001742 I2C_TRISTATE
1743
1744 The code necessary to make the I2C data line tri-stated
1745 (inactive). If the data line is open collector, this
1746 define can be null.
1747
wdenkb37c7e52003-06-30 16:24:52 +00001748 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1749
wdenkc6097192002-11-03 00:24:07 +00001750 I2C_READ
1751
1752 Code that returns TRUE if the I2C data line is high,
1753 FALSE if it is low.
1754
wdenkb37c7e52003-06-30 16:24:52 +00001755 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1756
wdenkc6097192002-11-03 00:24:07 +00001757 I2C_SDA(bit)
1758
1759 If <bit> is TRUE, sets the I2C data line high. If it
1760 is FALSE, it clears it (low).
1761
wdenkb37c7e52003-06-30 16:24:52 +00001762 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001763 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001764 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001765
wdenkc6097192002-11-03 00:24:07 +00001766 I2C_SCL(bit)
1767
1768 If <bit> is TRUE, sets the I2C clock line high. If it
1769 is FALSE, it clears it (low).
1770
wdenkb37c7e52003-06-30 16:24:52 +00001771 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001772 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001773 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001774
wdenkc6097192002-11-03 00:24:07 +00001775 I2C_DELAY
1776
1777 This delay is invoked four times per clock cycle so this
1778 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001779 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001780 like:
1781
wdenkb37c7e52003-06-30 16:24:52 +00001782 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001783
Mike Frysinger793b5722010-07-21 13:38:02 -04001784 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1785
1786 If your arch supports the generic GPIO framework (asm/gpio.h),
1787 then you may alternatively define the two GPIOs that are to be
1788 used as SCL / SDA. Any of the previous I2C_xxx macros will
1789 have GPIO-based defaults assigned to them as appropriate.
1790
1791 You should define these to the GPIO value as given directly to
1792 the generic GPIO functions.
1793
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001794 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001795
wdenk8bde7f72003-06-27 21:31:46 +00001796 When a board is reset during an i2c bus transfer
1797 chips might think that the current transfer is still
1798 in progress. On some boards it is possible to access
1799 the i2c SCLK line directly, either by using the
1800 processor pin as a GPIO or by having a second pin
1801 connected to the bus. If this option is defined a
1802 custom i2c_init_board() routine in boards/xxx/board.c
1803 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001804
Richard Retanubun26a33502010-04-12 15:08:17 -04001805 CONFIG_SYS_I2C_BOARD_LATE_INIT
1806
1807 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1808 defined a custom i2c_board_late_init() routine in
1809 boards/xxx/board.c is run AFTER the operations in i2c_init()
1810 is completed. This callpoint can be used to unreset i2c bus
1811 using CPU i2c controller register accesses for CPUs whose i2c
1812 controller provide such a method. It is called at the end of
1813 i2c_init() to allow i2c_init operations to setup the i2c bus
1814 controller on the CPU (e.g. setting bus speed & slave address).
1815
wdenk17ea1172004-06-06 21:51:03 +00001816 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1817
1818 This option enables configuration of bi_iic_fast[] flags
1819 in u-boot bd_info structure based on u-boot environment
1820 variable "i2cfast". (see also i2cfast)
1821
Ben Warrenbb99ad62006-09-07 16:50:54 -04001822 CONFIG_I2C_MULTI_BUS
1823
1824 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001825 must have a controller. At any point in time, only one bus is
1826 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001827 Note that bus numbering is zero-based.
1828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001829 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001830
1831 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001832 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001833 is set, specify a list of bus-device pairs. Otherwise, specify
1834 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001835
1836 e.g.
1837 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001838 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001839
1840 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1841
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001842 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001843 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001844
1845 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1846
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001847 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06001848
1849 If defined, then this indicates the I2C bus number for DDR SPD.
1850 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1851
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001852 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001853
1854 If defined, then this indicates the I2C bus number for the RTC.
1855 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001857 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001858
1859 If defined, then this indicates the I2C bus number for the DTT.
1860 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001862 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001863
1864 If defined, specifies the I2C address of the DTT device.
1865 If not defined, then U-Boot uses predefined value for
1866 specified DTT device.
1867
Timur Tabibe5e61812006-11-03 19:15:00 -06001868 CONFIG_FSL_I2C
1869
1870 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001871 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e61812006-11-03 19:15:00 -06001872
Heiko Schocher67b23a32008-10-15 09:39:47 +02001873 CONFIG_I2C_MUX
1874
1875 Define this option if you have I2C devices reached over 1 .. n
1876 I2C Muxes like the pca9544a. This option addes a new I2C
1877 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1878 new I2C Bus to the existing I2C Busses. If you select the
1879 new Bus with "i2c dev", u-bbot sends first the commandos for
1880 the muxes to activate this new "bus".
1881
1882 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1883 feature!
1884
1885 Example:
1886 Adding a new I2C Bus reached over 2 pca9544a muxes
1887 The First mux with address 70 and channel 6
1888 The Second mux with address 71 and channel 4
1889
1890 => i2c bus pca9544a:70:6:pca9544a:71:4
1891
1892 Use the "i2c bus" command without parameter, to get a list
1893 of I2C Busses with muxes:
1894
1895 => i2c bus
1896 Busses reached over muxes:
1897 Bus ID: 2
1898 reached over Mux(es):
1899 pca9544a@70 ch: 4
1900 Bus ID: 3
1901 reached over Mux(es):
1902 pca9544a@70 ch: 6
1903 pca9544a@71 ch: 4
1904 =>
1905
1906 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001907 u-boot first sends the command to the mux@70 to enable
1908 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001909 the channel 4.
1910
1911 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001912 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001913 the 2 muxes.
1914
1915 This option is actually implemented for the bitbanging
1916 algorithm in common/soft_i2c.c and for the Hardware I2C
1917 Bus on the MPC8260. But it should be not so difficult
1918 to add this option to other architectures.
1919
Andrew Dyer2ac69852008-12-29 17:36:01 -06001920 CONFIG_SOFT_I2C_READ_REPEATED_START
1921
1922 defining this will force the i2c_read() function in
1923 the soft_i2c driver to perform an I2C repeated start
1924 between writing the address pointer and reading the
1925 data. If this define is omitted the default behaviour
1926 of doing a stop-start sequence will be used. Most I2C
1927 devices can use either method, but some require one or
1928 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06001929
wdenkc6097192002-11-03 00:24:07 +00001930- SPI Support: CONFIG_SPI
1931
1932 Enables SPI driver (so far only tested with
1933 SPI EEPROM, also an instance works with Crystal A/D and
1934 D/As on the SACSng board)
1935
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001936 CONFIG_SH_SPI
1937
1938 Enables the driver for SPI controller on SuperH. Currently
1939 only SH7757 is supported.
1940
wdenkc6097192002-11-03 00:24:07 +00001941 CONFIG_SPI_X
1942
1943 Enables extended (16-bit) SPI EEPROM addressing.
1944 (symmetrical to CONFIG_I2C_X)
1945
1946 CONFIG_SOFT_SPI
1947
wdenk43d96162003-03-06 00:02:04 +00001948 Enables a software (bit-bang) SPI driver rather than
1949 using hardware support. This is a general purpose
1950 driver that only requires three general I/O port pins
1951 (two outputs, one input) to function. If this is
1952 defined, the board configuration must define several
1953 SPI configuration items (port pins to use, etc). For
1954 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001955
Ben Warren04a9e112008-01-16 22:37:35 -05001956 CONFIG_HARD_SPI
1957
1958 Enables a hardware SPI driver for general-purpose reads
1959 and writes. As with CONFIG_SOFT_SPI, the board configuration
1960 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001961 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05001962 example, see include/configs/mpc8349emds.h.
1963
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001964 CONFIG_MXC_SPI
1965
1966 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00001967 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001968
Matthias Fuchs01335022007-12-27 17:12:34 +01001969- FPGA Support: CONFIG_FPGA
1970
1971 Enables FPGA subsystem.
1972
1973 CONFIG_FPGA_<vendor>
1974
1975 Enables support for specific chip vendors.
1976 (ALTERA, XILINX)
1977
1978 CONFIG_FPGA_<family>
1979
1980 Enables support for FPGA family.
1981 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1982
1983 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001984
wdenk43d96162003-03-06 00:02:04 +00001985 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001986
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001987 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001988
wdenk8bde7f72003-06-27 21:31:46 +00001989 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001990
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001991 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001992
wdenk43d96162003-03-06 00:02:04 +00001993 Enable checks on FPGA configuration interface busy
1994 status by the configuration function. This option
1995 will require a board or device specific function to
1996 be written.
wdenkc6097192002-11-03 00:24:07 +00001997
1998 CONFIG_FPGA_DELAY
1999
2000 If defined, a function that provides delays in the FPGA
2001 configuration driver.
2002
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002003 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002004 Allow Control-C to interrupt FPGA configuration
2005
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002006 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002007
wdenk43d96162003-03-06 00:02:04 +00002008 Check for configuration errors during FPGA bitfile
2009 loading. For example, abort during Virtex II
2010 configuration if the INIT_B line goes low (which
2011 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002012
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002013 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002014
wdenk43d96162003-03-06 00:02:04 +00002015 Maximum time to wait for the INIT_B line to deassert
2016 after PROB_B has been deasserted during a Virtex II
2017 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002018 ms.
wdenkc6097192002-11-03 00:24:07 +00002019
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002020 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002021
wdenk43d96162003-03-06 00:02:04 +00002022 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002023 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002025 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002026
wdenk43d96162003-03-06 00:02:04 +00002027 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002028 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002029
2030- Configuration Management:
2031 CONFIG_IDENT_STRING
2032
wdenk43d96162003-03-06 00:02:04 +00002033 If defined, this string will be added to the U-Boot
2034 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002035
2036- Vendor Parameter Protection:
2037
wdenk43d96162003-03-06 00:02:04 +00002038 U-Boot considers the values of the environment
2039 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002040 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002041 are set once by the board vendor / manufacturer, and
2042 protects these variables from casual modification by
2043 the user. Once set, these variables are read-only,
2044 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002045 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002046
2047 If CONFIG_ENV_OVERWRITE is #defined in your config
2048 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002049 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002050 these parameters.
2051
2052 Alternatively, if you #define _both_ CONFIG_ETHADDR
2053 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002054 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002055 which can be changed exactly ONCE by the user. [The
2056 serial# is unaffected by this, i. e. it remains
2057 read-only.]
2058
2059- Protected RAM:
2060 CONFIG_PRAM
2061
2062 Define this variable to enable the reservation of
2063 "protected RAM", i. e. RAM which is not overwritten
2064 by U-Boot. Define CONFIG_PRAM to hold the number of
2065 kB you want to reserve for pRAM. You can overwrite
2066 this default value by defining an environment
2067 variable "pram" to the number of kB you want to
2068 reserve. Note that the board info structure will
2069 still show the full amount of RAM. If pRAM is
2070 reserved, a new environment variable "mem" will
2071 automatically be defined to hold the amount of
2072 remaining RAM in a form that can be passed as boot
2073 argument to Linux, for instance like that:
2074
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002075 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002076 saveenv
2077
2078 This way you can tell Linux not to use this memory,
2079 either, which results in a memory region that will
2080 not be affected by reboots.
2081
2082 *WARNING* If your board configuration uses automatic
2083 detection of the RAM size, you must make sure that
2084 this memory test is non-destructive. So far, the
2085 following board configurations are known to be
2086 "pRAM-clean":
2087
2088 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2089 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002090 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002091
2092- Error Recovery:
2093 CONFIG_PANIC_HANG
2094
2095 Define this variable to stop the system in case of a
2096 fatal error, so that you have to reset it manually.
2097 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002098 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002099 automatically as fast as possible, but it may be
2100 useful during development since you can try to debug
2101 the conditions that lead to the situation.
2102
2103 CONFIG_NET_RETRY_COUNT
2104
wdenk43d96162003-03-06 00:02:04 +00002105 This variable defines the number of retries for
2106 network operations like ARP, RARP, TFTP, or BOOTP
2107 before giving up the operation. If not defined, a
2108 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002109
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002110 CONFIG_ARP_TIMEOUT
2111
2112 Timeout waiting for an ARP reply in milliseconds.
2113
wdenkc6097192002-11-03 00:24:07 +00002114- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002115 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002116
2117 Enable auto completion of commands using TAB.
2118
Wolfgang Denka9398e02006-11-27 15:32:42 +01002119 Note that this feature has NOT been implemented yet
2120 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002121
2122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002123 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002124
2125 Define this variable to enable the "hush" shell (from
2126 Busybox) as command line interpreter, thus enabling
2127 powerful command line syntax like
2128 if...then...else...fi conditionals or `&&' and '||'
2129 constructs ("shell scripts").
2130
2131 If undefined, you get the old, much simpler behaviour
2132 with a somewhat smaller memory footprint.
2133
2134
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002135 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002136
2137 This defines the secondary prompt string, which is
2138 printed when the command interpreter needs more input
2139 to complete a command. Usually "> ".
2140
2141 Note:
2142
wdenk8bde7f72003-06-27 21:31:46 +00002143 In the current implementation, the local variables
2144 space and global environment variables space are
2145 separated. Local variables are those you define by
2146 simply typing `name=value'. To access a local
2147 variable later on, you have write `$name' or
2148 `${name}'; to execute the contents of a variable
2149 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002150
wdenk43d96162003-03-06 00:02:04 +00002151 Global environment variables are those you use
2152 setenv/printenv to work with. To run a command stored
2153 in such a variable, you need to use the run command,
2154 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002155
2156 To store commands and special characters in a
2157 variable, please use double quotation marks
2158 surrounding the whole text of the variable, instead
2159 of the backslashes before semicolons and special
2160 symbols.
2161
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002162- Commandline Editing and History:
2163 CONFIG_CMDLINE_EDITING
2164
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002165 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002166 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002167
wdenka8c7c702003-12-06 19:49:23 +00002168- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002169 CONFIG_EXTRA_ENV_SETTINGS
2170
wdenk43d96162003-03-06 00:02:04 +00002171 Define this to contain any number of null terminated
2172 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002173 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002174
wdenk43d96162003-03-06 00:02:04 +00002175 For example, place something like this in your
2176 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002177
2178 #define CONFIG_EXTRA_ENV_SETTINGS \
2179 "myvar1=value1\0" \
2180 "myvar2=value2\0"
2181
wdenk43d96162003-03-06 00:02:04 +00002182 Warning: This method is based on knowledge about the
2183 internal format how the environment is stored by the
2184 U-Boot code. This is NOT an official, exported
2185 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002186 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002187 You better know what you are doing here.
2188
wdenk43d96162003-03-06 00:02:04 +00002189 Note: overly (ab)use of the default environment is
2190 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002191 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002192 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002193
wdenka8c7c702003-12-06 19:49:23 +00002194- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002195 CONFIG_HAS_DATAFLASH
2196
wdenk8bde7f72003-06-27 21:31:46 +00002197 Defining this option enables DataFlash features and
2198 allows to read/write in Dataflash via the standard
2199 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002200
Eric Nelsonf61ec452012-01-31 10:52:08 -07002201- Serial Flash support
2202 CONFIG_CMD_SF
2203
2204 Defining this option enables SPI flash commands
2205 'sf probe/read/write/erase/update'.
2206
2207 Usage requires an initial 'probe' to define the serial
2208 flash parameters, followed by read/write/erase/update
2209 commands.
2210
2211 The following defaults may be provided by the platform
2212 to handle the common case when only a single serial
2213 flash is present on the system.
2214
2215 CONFIG_SF_DEFAULT_BUS Bus identifier
2216 CONFIG_SF_DEFAULT_CS Chip-select
2217 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2218 CONFIG_SF_DEFAULT_SPEED in Hz
2219
wdenk3f85ce22004-02-23 16:11:30 +00002220- SystemACE Support:
2221 CONFIG_SYSTEMACE
2222
2223 Adding this option adds support for Xilinx SystemACE
2224 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002225 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002226 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002227
2228 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002229 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002230
2231 When SystemACE support is added, the "ace" device type
2232 becomes available to the fat commands, i.e. fatls.
2233
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002234- TFTP Fixed UDP Port:
2235 CONFIG_TFTP_PORT
2236
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002237 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002238 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002239 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002240 number generator is used.
2241
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002242 Also, the environment variable tftpdstp is used to supply
2243 the TFTP UDP destination port value. If tftpdstp isn't
2244 defined, the normal port 69 is used.
2245
2246 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002247 blindly start the TFTP transfer using the pre-configured
2248 target IP address and UDP port. This has the effect of
2249 "punching through" the (Windows XP) firewall, allowing
2250 the remainder of the TFTP transfer to proceed normally.
2251 A better solution is to properly configure the firewall,
2252 but sometimes that is not allowed.
2253
wdenka8c7c702003-12-06 19:49:23 +00002254- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002255 CONFIG_SHOW_BOOT_PROGRESS
2256
wdenk43d96162003-03-06 00:02:04 +00002257 Defining this option allows to add some board-
2258 specific code (calling a user-provided function
2259 "show_boot_progress(int)") that enables you to show
2260 the system's boot progress on some display (for
2261 example, some LED's) on your board. At the moment,
2262 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002263
Simon Glass3a608ca2012-02-13 13:51:19 +00002264- Detailed boot stage timing
2265 CONFIG_BOOTSTAGE
2266 Define this option to get detailed timing of each stage
2267 of the boot process.
2268
2269 CONFIG_BOOTSTAGE_USER_COUNT
2270 This is the number of available user bootstage records.
2271 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2272 a new ID will be allocated from this stash. If you exceed
2273 the limit, recording will stop.
2274
2275 CONFIG_BOOTSTAGE_REPORT
2276 Define this to print a report before boot, similar to this:
2277
2278 Timer summary in microseconds:
2279 Mark Elapsed Stage
2280 0 0 reset
2281 3,575,678 3,575,678 board_init_f start
2282 3,575,695 17 arch_cpu_init A9
2283 3,575,777 82 arch_cpu_init done
2284 3,659,598 83,821 board_init_r start
2285 3,910,375 250,777 main_loop
2286 29,916,167 26,005,792 bootm_start
2287 30,361,327 445,160 start_kernel
2288
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002289Legacy uImage format:
2290
wdenkc6097192002-11-03 00:24:07 +00002291 Arg Where When
2292 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002293 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002294 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002295 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002296 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002297 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002298 4 common/cmd_bootm.c Image data has correct checksum
2299 -4 common/cmd_bootm.c Image is for unsupported architecture
2300 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002301 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002302 6 common/cmd_bootm.c Image Type check OK
2303 -6 common/cmd_bootm.c gunzip uncompression error
2304 -7 common/cmd_bootm.c Unimplemented compression type
2305 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002306 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002307 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002308
2309 9 common/image.c Start initial ramdisk verification
2310 -10 common/image.c Ramdisk header has bad magic number
2311 -11 common/image.c Ramdisk header has bad checksum
2312 10 common/image.c Ramdisk header is OK
2313 -12 common/image.c Ramdisk data has bad checksum
2314 11 common/image.c Ramdisk data has correct checksum
2315 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002316 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002317 13 common/image.c Start multifile image verification
2318 14 common/image.c No initial ramdisk, no multifile, continue.
2319
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002320 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002321
Stefan Roesea47a12b2010-04-15 16:07:28 +02002322 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002323 -31 post/post.c POST test failed, detected by post_output_backlog()
2324 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002325
Heiko Schocher566a4942007-06-22 19:11:54 +02002326 34 common/cmd_doc.c before loading a Image from a DOC device
2327 -35 common/cmd_doc.c Bad usage of "doc" command
2328 35 common/cmd_doc.c correct usage of "doc" command
2329 -36 common/cmd_doc.c No boot device
2330 36 common/cmd_doc.c correct boot device
2331 -37 common/cmd_doc.c Unknown Chip ID on boot device
2332 37 common/cmd_doc.c correct chip ID found, device available
2333 -38 common/cmd_doc.c Read Error on boot device
2334 38 common/cmd_doc.c reading Image header from DOC device OK
2335 -39 common/cmd_doc.c Image header has bad magic number
2336 39 common/cmd_doc.c Image header has correct magic number
2337 -40 common/cmd_doc.c Error reading Image from DOC device
2338 40 common/cmd_doc.c Image header has correct magic number
2339 41 common/cmd_ide.c before loading a Image from a IDE device
2340 -42 common/cmd_ide.c Bad usage of "ide" command
2341 42 common/cmd_ide.c correct usage of "ide" command
2342 -43 common/cmd_ide.c No boot device
2343 43 common/cmd_ide.c boot device found
2344 -44 common/cmd_ide.c Device not available
2345 44 common/cmd_ide.c Device available
2346 -45 common/cmd_ide.c wrong partition selected
2347 45 common/cmd_ide.c partition selected
2348 -46 common/cmd_ide.c Unknown partition table
2349 46 common/cmd_ide.c valid partition table found
2350 -47 common/cmd_ide.c Invalid partition type
2351 47 common/cmd_ide.c correct partition type
2352 -48 common/cmd_ide.c Error reading Image Header on boot device
2353 48 common/cmd_ide.c reading Image Header from IDE device OK
2354 -49 common/cmd_ide.c Image header has bad magic number
2355 49 common/cmd_ide.c Image header has correct magic number
2356 -50 common/cmd_ide.c Image header has bad checksum
2357 50 common/cmd_ide.c Image header has correct checksum
2358 -51 common/cmd_ide.c Error reading Image from IDE device
2359 51 common/cmd_ide.c reading Image from IDE device OK
2360 52 common/cmd_nand.c before loading a Image from a NAND device
2361 -53 common/cmd_nand.c Bad usage of "nand" command
2362 53 common/cmd_nand.c correct usage of "nand" command
2363 -54 common/cmd_nand.c No boot device
2364 54 common/cmd_nand.c boot device found
2365 -55 common/cmd_nand.c Unknown Chip ID on boot device
2366 55 common/cmd_nand.c correct chip ID found, device available
2367 -56 common/cmd_nand.c Error reading Image Header on boot device
2368 56 common/cmd_nand.c reading Image Header from NAND device OK
2369 -57 common/cmd_nand.c Image header has bad magic number
2370 57 common/cmd_nand.c Image header has correct magic number
2371 -58 common/cmd_nand.c Error reading Image from NAND device
2372 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002373
Heiko Schocher566a4942007-06-22 19:11:54 +02002374 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002375
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002376 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002377 -64 net/eth.c no Ethernet found.
2378 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002379
Heiko Schocher566a4942007-06-22 19:11:54 +02002380 -80 common/cmd_net.c usage wrong
2381 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002382 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002383 81 common/cmd_net.c NetLoop() back without error
2384 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2385 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002386 83 common/cmd_net.c running "source" command
2387 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002388 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002389
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002390FIT uImage format:
2391
2392 Arg Where When
2393 100 common/cmd_bootm.c Kernel FIT Image has correct format
2394 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2395 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2396 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2397 102 common/cmd_bootm.c Kernel unit name specified
2398 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002399 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002400 104 common/cmd_bootm.c Got kernel subimage node offset
2401 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2402 105 common/cmd_bootm.c Kernel subimage hash verification OK
2403 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2404 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002405 -106 common/cmd_bootm.c Kernel subimage has wrong type
2406 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002407 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2408 108 common/cmd_bootm.c Got kernel subimage data/size
2409 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2410 -109 common/cmd_bootm.c Can't get kernel subimage type
2411 -110 common/cmd_bootm.c Can't get kernel subimage comp
2412 -111 common/cmd_bootm.c Can't get kernel subimage os
2413 -112 common/cmd_bootm.c Can't get kernel subimage load address
2414 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2415
2416 120 common/image.c Start initial ramdisk verification
2417 -120 common/image.c Ramdisk FIT image has incorrect format
2418 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002419 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002420 -122 common/image.c Can't get configuration for ramdisk subimage
2421 123 common/image.c Ramdisk unit name specified
2422 -124 common/image.c Can't get ramdisk subimage node offset
2423 125 common/image.c Got ramdisk subimage node offset
2424 -125 common/image.c Ramdisk subimage hash verification failed
2425 126 common/image.c Ramdisk subimage hash verification OK
2426 -126 common/image.c Ramdisk subimage for unsupported architecture
2427 127 common/image.c Architecture check OK
2428 -127 common/image.c Can't get ramdisk subimage data/size
2429 128 common/image.c Got ramdisk subimage data/size
2430 129 common/image.c Can't get ramdisk load address
2431 -129 common/image.c Got ramdisk load address
2432
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002433 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002434 131 common/cmd_doc.c FIT image format OK
2435
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002436 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002437 141 common/cmd_ide.c FIT image format OK
2438
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002439 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002440 151 common/cmd_nand.c FIT image format OK
2441
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002442- Standalone program support:
2443 CONFIG_STANDALONE_LOAD_ADDR
2444
Wolfgang Denk6feff892011-10-09 21:06:34 +02002445 This option defines a board specific value for the
2446 address where standalone program gets loaded, thus
2447 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002448 settings.
2449
2450- Frame Buffer Address:
2451 CONFIG_FB_ADDR
2452
2453 Define CONFIG_FB_ADDR if you want to use specific
2454 address for frame buffer.
2455 Then system will reserve the frame buffer address to
2456 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002457 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002458
2459 Please see board_init_f function.
2460
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002461- Automatic software updates via TFTP server
2462 CONFIG_UPDATE_TFTP
2463 CONFIG_UPDATE_TFTP_CNT_MAX
2464 CONFIG_UPDATE_TFTP_MSEC_MAX
2465
2466 These options enable and control the auto-update feature;
2467 for a more detailed description refer to doc/README.update.
2468
2469- MTD Support (mtdparts command, UBI support)
2470 CONFIG_MTD_DEVICE
2471
2472 Adds the MTD device infrastructure from the Linux kernel.
2473 Needed for mtdparts command support.
2474
2475 CONFIG_MTD_PARTITIONS
2476
2477 Adds the MTD partitioning infrastructure from the Linux
2478 kernel. Needed for UBI support.
2479
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002480- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002481 CONFIG_SPL
2482 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002483
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002484 CONFIG_SPL_TEXT_BASE
2485 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002486
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002487 CONFIG_SPL_LDSCRIPT
2488 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002489
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002490 CONFIG_SPL_LIBCOMMON_SUPPORT
2491 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002492
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002493 CONFIG_SPL_LIBDISK_SUPPORT
2494 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002495
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002496 CONFIG_SPL_I2C_SUPPORT
2497 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002498
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002499 CONFIG_SPL_GPIO_SUPPORT
2500 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002501
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002502 CONFIG_SPL_MMC_SUPPORT
2503 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002504
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002505 CONFIG_SPL_SERIAL_SUPPORT
2506 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002507
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002508 CONFIG_SPL_SPI_FLASH_SUPPORT
2509 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002510
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002511 CONFIG_SPL_SPI_SUPPORT
2512 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002513
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002514 CONFIG_SPL_FAT_SUPPORT
2515 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002516
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002517 CONFIG_SPL_LIBGENERIC_SUPPORT
2518 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002519
wdenkc6097192002-11-03 00:24:07 +00002520Modem Support:
2521--------------
2522
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002523[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002524
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002525- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002526 CONFIG_MODEM_SUPPORT
2527
2528- RTS/CTS Flow control enable:
2529 CONFIG_HWFLOW
2530
2531- Modem debug support:
2532 CONFIG_MODEM_SUPPORT_DEBUG
2533
wdenk43d96162003-03-06 00:02:04 +00002534 Enables debugging stuff (char screen[1024], dbg())
2535 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002536
wdenka8c7c702003-12-06 19:49:23 +00002537- Interrupt support (PPC):
2538
wdenkd4ca31c2004-01-02 14:00:00 +00002539 There are common interrupt_init() and timer_interrupt()
2540 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002541 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002542 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002543 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002544 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002545 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002546 specific handling. If board has watchdog / status_led
2547 / other_activity_monitor it works automatically from
2548 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002549
wdenkc6097192002-11-03 00:24:07 +00002550- General:
2551
wdenk43d96162003-03-06 00:02:04 +00002552 In the target system modem support is enabled when a
2553 specific key (key combination) is pressed during
2554 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002555 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002556 board_init(). Currently key_pressed() is a dummy
2557 function, returning 1 and thus enabling modem
2558 initialization.
wdenkc6097192002-11-03 00:24:07 +00002559
wdenk43d96162003-03-06 00:02:04 +00002560 If there are no modem init strings in the
2561 environment, U-Boot proceed to autoboot; the
2562 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002563 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002564
2565 See also: doc/README.Modem
2566
Helmut Raiger9660e442011-10-20 04:19:47 +00002567Board initialization settings:
2568------------------------------
2569
2570During Initialization u-boot calls a number of board specific functions
2571to allow the preparation of board specific prerequisites, e.g. pin setup
2572before drivers are initialized. To enable these callbacks the
2573following configuration macros have to be defined. Currently this is
2574architecture specific, so please check arch/your_architecture/lib/board.c
2575typically in board_init_f() and board_init_r().
2576
2577- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2578- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2579- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2580- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002581
wdenkc6097192002-11-03 00:24:07 +00002582Configuration Settings:
2583-----------------------
2584
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002585- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002586 undefine this when you're short of memory.
2587
Peter Tyser2fb26042009-01-27 18:03:12 -06002588- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2589 width of the commands listed in the 'help' command output.
2590
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002591- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002592 prompt for user input.
2593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002594- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002596- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002597
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002598- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002600- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002601 the application (usually a Linux kernel) when it is
2602 booted
2603
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002604- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002605 List of legal baudrate settings for this board.
2606
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002607- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002608 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002610- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002611 If the board specific function
2612 extern int overwrite_console (void);
2613 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002614 serial port, else the settings in the environment are used.
2615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002616- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002617 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002619- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002620 Enable overwrite of previous console environment settings.
2621
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002622- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002623 Begin and End addresses of the area used by the
2624 simple memory test.
2625
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002626- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002627 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002628
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002629- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002630 Scratch address used by the alternate memory test
2631 You only need to set this if address zero isn't writeable
2632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002633- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2634 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002635 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002636 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002637 fixing up gd->ram_size the Linux kernel should gets passed
2638 the now "corrected" memory size and won't touch it either.
2639 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002640 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002641 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002642 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002643
2644 This option can be used as a workaround for the 440EPx/GRx
2645 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2646 be touched.
2647
2648 WARNING: Please make sure that this value is a multiple of
2649 the Linux page size (normally 4k). If this is not the case,
2650 then the end address of the Linux memory will be located at a
2651 non page size aligned address and this could cause major
2652 problems.
2653
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002654- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002655 Default load address for network file downloads
2656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002657- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002658 Enable temporary baudrate change while serial download
2659
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002660- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002661 Physical start address of SDRAM. _Must_ be 0 here.
2662
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002663- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002664 Physical start address of Motherboard I/O (if using a
2665 Cogent motherboard)
2666
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002667- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002668 Physical start address of Flash memory.
2669
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002670- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002671 Physical start address of boot monitor code (set by
2672 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002673 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002674 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002675
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002676- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002677 Size of memory reserved for monitor code, used to
2678 determine _at_compile_time_ (!) if the environment is
2679 embedded within the U-Boot image, or in a separate
2680 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002681
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002682- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002683 Size of DRAM reserved for malloc() use.
2684
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002685- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002686 Normally compressed uImages are limited to an
2687 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002688 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002689 to adjust this setting to your needs.
2690
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002691- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002692 Maximum size of memory mapped by the startup code of
2693 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002694 the Linux kernel (bd_info, boot arguments, FDT blob if
2695 used) must be put below this limit, unless "bootm_low"
2696 enviroment variable is defined and non-zero. In such case
2697 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002698 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002699 variable "bootm_mapsize" will override the value of
2700 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2701 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002702
John Rigbyfca43cc2010-10-13 13:57:35 -06002703- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2704 Enable initrd_high functionality. If defined then the
2705 initrd_high feature is enabled and the bootm ramdisk subcommand
2706 is enabled.
2707
2708- CONFIG_SYS_BOOT_GET_CMDLINE:
2709 Enables allocating and saving kernel cmdline in space between
2710 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2711
2712- CONFIG_SYS_BOOT_GET_KBD:
2713 Enables allocating and saving a kernel copy of the bd_info in
2714 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2715
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002716- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002717 Max number of Flash memory banks
2718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002719- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002720 Max number of sectors on a Flash chip
2721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002722- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002723 Timeout for Flash erase operations (in ms)
2724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002726 Timeout for Flash write operations (in ms)
2727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002728- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002729 Timeout for Flash set sector lock bit operation (in ms)
2730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002731- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002732 Timeout for Flash clear lock bits operation (in ms)
2733
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002734- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002735 If defined, hardware flash sectors protection is used
2736 instead of U-Boot software protection.
2737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002738- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002739
2740 Enable TFTP transfers directly to flash memory;
2741 without this option such a download has to be
2742 performed in two steps: (1) download to RAM, and (2)
2743 copy from RAM to flash.
2744
2745 The two-step approach is usually more reliable, since
2746 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002747 the flash, but in some situations (when system RAM is
2748 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002749 downloaded image) this option may be very useful.
2750
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002751- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002752 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002753 common flash structure for storing flash geometry.
2754
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002755- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002756 This option also enables the building of the cfi_flash driver
2757 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002758
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002759- CONFIG_FLASH_CFI_MTD
2760 This option enables the building of the cfi_mtd driver
2761 in the drivers directory. The driver exports CFI flash
2762 to the MTD layer.
2763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002764- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002765 Use buffered writes to flash.
2766
2767- CONFIG_FLASH_SPANSION_S29WS_N
2768 s29ws-n MirrorBit flash has non-standard addresses for buffered
2769 write commands.
2770
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002771- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002772 If this option is defined, the common CFI flash doesn't
2773 print it's warning upon not recognized FLASH banks. This
2774 is useful, if some of the configured banks are only
2775 optionally available.
2776
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002777- CONFIG_FLASH_SHOW_PROGRESS
2778 If defined (must be an integer), print out countdown
2779 digits and dots. Recommended value: 45 (9..1) for 80
2780 column displays, 15 (3..1) for 40 column displays.
2781
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002782- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002783 Defines the number of Ethernet receive buffers. On some
2784 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002785 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2786 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002787 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002788 Defaults to 4 if not defined.
2789
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002790- CONFIG_ENV_MAX_ENTRIES
2791
Wolfgang Denk071bc922010-10-27 22:48:30 +02002792 Maximum number of entries in the hash table that is used
2793 internally to store the environment settings. The default
2794 setting is supposed to be generous and should work in most
2795 cases. This setting can be used to tune behaviour; see
2796 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002797
wdenkc6097192002-11-03 00:24:07 +00002798The following definitions that deal with the placement and management
2799of environment data (variable area); in general, we support the
2800following configurations:
2801
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002802- CONFIG_BUILD_ENVCRC:
2803
2804 Builds up envcrc with the target environment so that external utils
2805 may easily extract it and embed it in final U-Boot images.
2806
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002807- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002808
2809 Define this if the environment is in flash memory.
2810
2811 a) The environment occupies one whole flash sector, which is
2812 "embedded" in the text segment with the U-Boot code. This
2813 happens usually with "bottom boot sector" or "top boot
2814 sector" type flash chips, which have several smaller
2815 sectors at the start or the end. For instance, such a
2816 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2817 such a case you would place the environment in one of the
2818 4 kB sectors - with U-Boot code before and after it. With
2819 "top boot sector" type flash chips, you would put the
2820 environment in one of the last sectors, leaving a gap
2821 between U-Boot and the environment.
2822
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002823 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002824
2825 Offset of environment data (variable area) to the
2826 beginning of flash memory; for instance, with bottom boot
2827 type flash chips the second sector can be used: the offset
2828 for this sector is given here.
2829
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002830 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002831
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002832 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002833
2834 This is just another way to specify the start address of
2835 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002836 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002837
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002838 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002839
2840 Size of the sector containing the environment.
2841
2842
2843 b) Sometimes flash chips have few, equal sized, BIG sectors.
2844 In such a case you don't want to spend a whole sector for
2845 the environment.
2846
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002847 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002848
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002849 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002850 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002851 of this flash sector for the environment. This saves
2852 memory for the RAM copy of the environment.
2853
2854 It may also save flash memory if you decide to use this
2855 when your environment is "embedded" within U-Boot code,
2856 since then the remainder of the flash sector could be used
2857 for U-Boot code. It should be pointed out that this is
2858 STRONGLY DISCOURAGED from a robustness point of view:
2859 updating the environment in flash makes it always
2860 necessary to erase the WHOLE sector. If something goes
2861 wrong before the contents has been restored from a copy in
2862 RAM, your target system will be dead.
2863
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002864 - CONFIG_ENV_ADDR_REDUND
2865 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002866
wdenk43d96162003-03-06 00:02:04 +00002867 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002868 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002869 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002870 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002871
2872BE CAREFUL! Any changes to the flash layout, and some changes to the
2873source code will make it necessary to adapt <board>/u-boot.lds*
2874accordingly!
2875
2876
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002877- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002878
2879 Define this if you have some non-volatile memory device
2880 (NVRAM, battery buffered SRAM) which you want to use for the
2881 environment.
2882
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002883 - CONFIG_ENV_ADDR:
2884 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002885
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002886 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002887 want to use for environment. It is assumed that this memory
2888 can just be read and written to, without any special
2889 provision.
2890
2891BE CAREFUL! The first access to the environment happens quite early
2892in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002893console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002894U-Boot will hang.
2895
2896Please note that even with NVRAM we still use a copy of the
2897environment in RAM: we could work on NVRAM directly, but we want to
2898keep settings there always unmodified except somebody uses "saveenv"
2899to save the current settings.
2900
2901
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002902- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002903
2904 Use this if you have an EEPROM or similar serial access
2905 device and a driver for it.
2906
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002907 - CONFIG_ENV_OFFSET:
2908 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002909
2910 These two #defines specify the offset and size of the
2911 environment area within the total memory of your EEPROM.
2912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002913 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002914 If defined, specified the chip address of the EEPROM device.
2915 The default address is zero.
2916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002917 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002918 If defined, the number of bits used to address bytes in a
2919 single page in the EEPROM device. A 64 byte page, for example
2920 would require six bits.
2921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002922 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002923 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002924 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002926 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002927 The length in bytes of the EEPROM memory array address. Note
2928 that this is NOT the chip address length!
2929
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002930 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002931 EEPROM chips that implement "address overflow" are ones
2932 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2933 address and the extra bits end up in the "chip address" bit
2934 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2935 byte chips.
2936
2937 Note that we consider the length of the address field to
2938 still be one byte because the extra address bits are hidden
2939 in the chip address.
2940
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002941 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002942 The size in bytes of the EEPROM device.
2943
Heiko Schocher548738b2010-01-07 08:55:40 +01002944 - CONFIG_ENV_EEPROM_IS_ON_I2C
2945 define this, if you have I2C and SPI activated, and your
2946 EEPROM, which holds the environment, is on the I2C bus.
2947
2948 - CONFIG_I2C_ENV_EEPROM_BUS
2949 if you have an Environment on an EEPROM reached over
2950 I2C muxes, you can define here, how to reach this
2951 EEPROM. For example:
2952
Wolfgang Denka9046b92010-06-13 17:48:15 +02002953 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002954
2955 EEPROM which holds the environment, is reached over
2956 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002957
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002958- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002959
wdenkd4ca31c2004-01-02 14:00:00 +00002960 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002961 want to use for the environment.
2962
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002963 - CONFIG_ENV_OFFSET:
2964 - CONFIG_ENV_ADDR:
2965 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002966
2967 These three #defines specify the offset and size of the
2968 environment area within the total memory of your DataFlash placed
2969 at the specified address.
2970
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002971- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002972
2973 Define this if you have a NAND device which you want to use
2974 for the environment.
2975
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002976 - CONFIG_ENV_OFFSET:
2977 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002978
2979 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002980 area within the first NAND device. CONFIG_ENV_OFFSET must be
2981 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002982
Scott Woodfdd813d2010-09-17 14:38:37 -05002983 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002984
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002985 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002986 size used to hold a redundant copy of the environment data, so
2987 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002988 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05002989 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002990
Scott Woodfdd813d2010-09-17 14:38:37 -05002991 - CONFIG_ENV_RANGE (optional):
2992
2993 Specifies the length of the region in which the environment
2994 can be written. This should be a multiple of the NAND device's
2995 block size. Specifying a range with more erase blocks than
2996 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2997 the range to be avoided.
2998
2999 - CONFIG_ENV_OFFSET_OOB (optional):
3000
3001 Enables support for dynamically retrieving the offset of the
3002 environment from block zero's out-of-band data. The
3003 "nand env.oob" command can be used to record this offset.
3004 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3005 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003006
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003007- CONFIG_NAND_ENV_DST
3008
3009 Defines address in RAM to which the nand_spl code should copy the
3010 environment. If redundant environment is used, it will be copied to
3011 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3012
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003013- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003014
3015 Defines offset to the initial SPI buffer area in DPRAM. The
3016 area is used at an early stage (ROM part) if the environment
3017 is configured to reside in the SPI EEPROM: We need a 520 byte
3018 scratch DPRAM area. It is used between the two initialization
3019 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3020 to be a good choice since it makes it far enough from the
3021 start of the data area as well as from the stack pointer.
3022
Bruce Adlere881cb52007-11-02 13:15:42 -07003023Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003024has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003025created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003026until then to read environment variables.
3027
wdenk85ec0bc2003-03-31 16:34:49 +00003028The environment is protected by a CRC32 checksum. Before the monitor
3029is relocated into RAM, as a result of a bad CRC you will be working
3030with the compiled-in default environment - *silently*!!! [This is
3031necessary, because the first environment variable we need is the
3032"baudrate" setting for the console - if we have a bad CRC, we don't
3033have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003034
3035Note: once the monitor has been relocated, then it will complain if
3036the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003037use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003038
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003039- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003040 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003041
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003042 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003043 also needs to be defined.
3044
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003045- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003046 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003047
Ron Madridf5675aa2009-02-18 14:30:44 -08003048- CONFIG_NS16550_MIN_FUNCTIONS:
3049 Define this if you desire to only have use of the NS16550_init
3050 and NS16550_putc functions for the serial driver located at
3051 drivers/serial/ns16550.c. This option is useful for saving
3052 space for already greatly restricted images, including but not
3053 limited to NAND_SPL configurations.
3054
wdenkc6097192002-11-03 00:24:07 +00003055Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003056---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003057
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003058- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003059 Cache Line Size of the CPU.
3060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003061- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003062 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003063
wdenk42d1f032003-10-15 23:53:47 +00003064 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3065 and RPXsuper) to be able to adjust the position of
3066 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003067
Timur Tabie46fedf2011-08-04 18:03:41 -05003068- CONFIG_SYS_CCSRBAR_DEFAULT:
3069 Default (power-on reset) physical address of CCSR on Freescale
3070 PowerPC SOCs.
3071
3072- CONFIG_SYS_CCSRBAR:
3073 Virtual address of CCSR. On a 32-bit build, this is typically
3074 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3075
3076 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3077 for cross-platform code that uses that macro instead.
3078
3079- CONFIG_SYS_CCSRBAR_PHYS:
3080 Physical address of CCSR. CCSR can be relocated to a new
3081 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003082 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003083 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3084 is typically relocated on 36-bit builds. It is recommended
3085 that this macro be defined via the _HIGH and _LOW macros:
3086
3087 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3088 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3089
3090- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003091 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3092 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003093 used in assembly code, so it must not contain typecasts or
3094 integer size suffixes (e.g. "ULL").
3095
3096- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3097 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3098 used in assembly code, so it must not contain typecasts or
3099 integer size suffixes (e.g. "ULL").
3100
3101- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3102 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3103 forced to a value that ensures that CCSR is not relocated.
3104
wdenk7f6c2cb2002-11-10 22:06:23 +00003105- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003106 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003107
3108 the default drive number (default value 0)
3109
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003110 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003111
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003112 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003113 (default value 1)
3114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003115 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003116
wdenk43d96162003-03-06 00:02:04 +00003117 defines the offset of register from address. It
3118 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003119 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003120
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003121 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3122 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003123 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003124
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003125 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003126 fdc_hw_init() is called at the beginning of the FDC
3127 setup. fdc_hw_init() must be provided by the board
3128 source code. It is used to make hardware dependant
3129 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003130
Macpaul Lin0abddf82011-04-11 20:45:32 +00003131- CONFIG_IDE_AHB:
3132 Most IDE controllers were designed to be connected with PCI
3133 interface. Only few of them were designed for AHB interface.
3134 When software is doing ATA command and data transfer to
3135 IDE devices through IDE-AHB controller, some additional
3136 registers accessing to these kind of IDE-AHB controller
3137 is requierd.
3138
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003139- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003140 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003141 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003142
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003143- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003144
wdenk7152b1d2003-09-05 23:19:14 +00003145 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003146 initial data and stack; please note that this must be
3147 writable memory that is working WITHOUT special
3148 initialization, i. e. you CANNOT use normal RAM which
3149 will become available only after programming the
3150 memory controller and running certain initialization
3151 sequences.
3152
3153 U-Boot uses the following memory types:
3154 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3155 - MPC824X: data cache
3156 - PPC4xx: data cache
3157
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003158- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003159
3160 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003161 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3162 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003163 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003164 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003165 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3166 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3167 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003168
3169 Note:
3170 On the MPC824X (or other systems that use the data
3171 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003172 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003173 point to an otherwise UNUSED address space between
3174 the top of RAM and the start of the PCI space.
3175
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003176- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003177
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003178- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003179
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003180- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003181
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003182- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003183
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003184- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003185
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003186- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003187
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003188- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003189 SDRAM timing
3190
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003191- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003192 periodic timer for refresh
3193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003194- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003195
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003196- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3197 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3198 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3199 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003200 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3201
3202- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003203 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3204 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003205 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003207- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3208 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003209 Machine Mode Register and Memory Periodic Timer
3210 Prescaler definitions (SDRAM timing)
3211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003212- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003213 enable I2C microcode relocation patch (MPC8xx);
3214 define relocation offset in DPRAM [DSP2]
3215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003216- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003217 enable SMC microcode relocation patch (MPC8xx);
3218 define relocation offset in DPRAM [SMC1]
3219
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003220- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003221 enable SPI microcode relocation patch (MPC8xx);
3222 define relocation offset in DPRAM [SCC4]
3223
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003224- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003225 Use OSCM clock mode on MBX8xx board. Be careful,
3226 wrong setting might damage your board. Read
3227 doc/README.MBX before setting this variable!
3228
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003229- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003230 Offset of the bootmode word in DPRAM used by post
3231 (Power On Self Tests). This definition overrides
3232 #define'd default value in commproc.h resp.
3233 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003234
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003235- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3236 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3237 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3238 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3239 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3240 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3241 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3242 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003243 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003244
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003245- CONFIG_PCI_DISABLE_PCIE:
3246 Disable PCI-Express on systems where it is supported but not
3247 required.
3248
Kumar Galaa09b9b62010-12-30 12:09:53 -06003249- CONFIG_SYS_SRIO:
3250 Chip has SRIO or not
3251
3252- CONFIG_SRIO1:
3253 Board has SRIO 1 port available
3254
3255- CONFIG_SRIO2:
3256 Board has SRIO 2 port available
3257
3258- CONFIG_SYS_SRIOn_MEM_VIRT:
3259 Virtual Address of SRIO port 'n' memory region
3260
3261- CONFIG_SYS_SRIOn_MEM_PHYS:
3262 Physical Address of SRIO port 'n' memory region
3263
3264- CONFIG_SYS_SRIOn_MEM_SIZE:
3265 Size of SRIO port 'n' memory region
3266
Alex Watermaneced4622011-05-19 15:08:36 -04003267- CONFIG_SYS_NDFC_16
3268 Defined to tell the NDFC that the NAND chip is using a
3269 16 bit bus.
3270
3271- CONFIG_SYS_NDFC_EBC0_CFG
3272 Sets the EBC0_CFG register for the NDFC. If not defined
3273 a default value will be used.
3274
Ben Warrenbb99ad62006-09-07 16:50:54 -04003275- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003276 Get DDR timing information from an I2C EEPROM. Common
3277 with pluggable memory modules such as SODIMMs
3278
Ben Warrenbb99ad62006-09-07 16:50:54 -04003279 SPD_EEPROM_ADDRESS
3280 I2C address of the SPD EEPROM
3281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003282- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003283 If SPD EEPROM is on an I2C bus other than the first
3284 one, specify here. Note that the value must resolve
3285 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003286
York Sun1b3e3c42011-06-07 09:42:16 +08003287- CONFIG_SYS_DDR_RAW_TIMING
3288 Get DDR timing information from other than SPD. Common with
3289 soldered DDR chips onboard without SPD. DDR raw timing
3290 parameters are extracted from datasheet and hard-coded into
3291 header files or board specific files.
3292
York Sun6f5e1dc2011-09-16 13:21:35 -07003293- CONFIG_FSL_DDR_INTERACTIVE
3294 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3295
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003296- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003297 Only for 83xx systems. If specified, then DDR should
3298 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003299
wdenkc26e4542004-04-18 10:13:26 +00003300- CONFIG_ETHER_ON_FEC[12]
3301 Define to enable FEC[12] on a 8xx series processor.
3302
3303- CONFIG_FEC[12]_PHY
3304 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003305 to the given FEC; i. e.
3306 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003307 means that the PHY with address 4 is connected to FEC1
3308
3309 When set to -1, means to probe for first available.
3310
3311- CONFIG_FEC[12]_PHY_NORXERR
3312 The PHY does not have a RXERR line (RMII only).
3313 (so program the FEC to ignore it).
3314
3315- CONFIG_RMII
3316 Enable RMII mode for all FECs.
3317 Note that this is a global option, we can't
3318 have one FEC in standard MII mode and another in RMII mode.
3319
wdenk5cf91d62004-04-23 20:32:05 +00003320- CONFIG_CRC32_VERIFY
3321 Add a verify option to the crc32 command.
3322 The syntax is:
3323
3324 => crc32 -v <address> <count> <crc32>
3325
3326 Where address/count indicate a memory area
3327 and crc32 is the correct crc32 which the
3328 area should have.
3329
wdenk56523f12004-07-11 17:40:54 +00003330- CONFIG_LOOPW
3331 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003332 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003333
stroese7b466642004-12-16 18:46:55 +00003334- CONFIG_MX_CYCLIC
3335 Add the "mdc" and "mwc" memory commands. These are cyclic
3336 "md/mw" commands.
3337 Examples:
3338
wdenkefe2a4d2004-12-16 21:44:03 +00003339 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003340 This command will print 4 bytes (10,11,12,13) each 500 ms.
3341
wdenkefe2a4d2004-12-16 21:44:03 +00003342 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003343 This command will write 12345678 to address 100 all 10 ms.
3344
wdenkefe2a4d2004-12-16 21:44:03 +00003345 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003346 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003347
wdenk8aa1a2d2005-04-04 12:44:11 +00003348- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003349 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003350 low level initializations (like setting up the memory
3351 controller) are omitted and/or U-Boot does not
3352 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003353
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003354 Normally this variable MUST NOT be defined. The only
3355 exception is when U-Boot is loaded (to RAM) by some
3356 other boot loader or by a debugger which performs
3357 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003358
Aneesh V401bb302011-07-13 05:11:07 +00003359- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003360 Modifies the behaviour of start.S when compiling a loader
3361 that is executed before the actual U-Boot. E.g. when
3362 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003363
Heiko Schocher68bb8292011-11-01 20:00:30 +00003364- CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3365 define this, if you want to read first the oob data
3366 and then the data. This is used for example on
3367 davinci plattforms.
3368
Matthias Weisserd8834a12011-03-10 21:36:32 +00003369- CONFIG_USE_ARCH_MEMCPY
3370 CONFIG_USE_ARCH_MEMSET
3371 If these options are used a optimized version of memcpy/memset will
3372 be used if available. These functions may be faster under some
3373 conditions but may increase the binary size.
3374
Timur Tabif2717b42011-11-22 09:21:25 -06003375Freescale QE/FMAN Firmware Support:
3376-----------------------------------
3377
3378The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3379loading of "firmware", which is encoded in the QE firmware binary format.
3380This firmware often needs to be loaded during U-Boot booting, so macros
3381are used to identify the storage device (NOR flash, SPI, etc) and the address
3382within that device.
3383
3384- CONFIG_SYS_QE_FMAN_FW_ADDR
3385 The address in the storage device where the firmware is located. The
3386 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3387 is also specified.
3388
3389- CONFIG_SYS_QE_FMAN_FW_LENGTH
3390 The maximum possible size of the firmware. The firmware binary format
3391 has a field that specifies the actual size of the firmware, but it
3392 might not be possible to read any part of the firmware unless some
3393 local storage is allocated to hold the entire firmware first.
3394
3395- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3396 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3397 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3398 virtual address in NOR flash.
3399
3400- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3401 Specifies that QE/FMAN firmware is located in NAND flash.
3402 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3403
3404- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3405 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3406 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3407
3408- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3409 Specifies that QE/FMAN firmware is located on the primary SPI
3410 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3411
3412
wdenkc6097192002-11-03 00:24:07 +00003413Building the Software:
3414======================
3415
Wolfgang Denk218ca722008-03-26 10:40:12 +01003416Building U-Boot has been tested in several native build environments
3417and in many different cross environments. Of course we cannot support
3418all possibly existing versions of cross development tools in all
3419(potentially obsolete) versions. In case of tool chain problems we
3420recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3421which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003422
Wolfgang Denk218ca722008-03-26 10:40:12 +01003423If you are not using a native environment, it is assumed that you
3424have GNU cross compiling tools available in your path. In this case,
3425you must set the environment variable CROSS_COMPILE in your shell.
3426Note that no changes to the Makefile or any other source files are
3427necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003428
Wolfgang Denk218ca722008-03-26 10:40:12 +01003429 $ CROSS_COMPILE=ppc_4xx-
3430 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003431
Peter Tyser2f8d3962009-03-13 18:54:51 -05003432Note: If you wish to generate Windows versions of the utilities in
3433 the tools directory you can use the MinGW toolchain
3434 (http://www.mingw.org). Set your HOST tools to the MinGW
3435 toolchain and execute 'make tools'. For example:
3436
3437 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3438
3439 Binaries such as tools/mkimage.exe will be created which can
3440 be executed on computers running Windows.
3441
Wolfgang Denk218ca722008-03-26 10:40:12 +01003442U-Boot is intended to be simple to build. After installing the
3443sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003444is done by typing:
3445
3446 make NAME_config
3447
Wolfgang Denk218ca722008-03-26 10:40:12 +01003448where "NAME_config" is the name of one of the existing configu-
3449rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003450
wdenk2729af92004-05-03 20:45:30 +00003451Note: for some board special configuration names may exist; check if
3452 additional information is available from the board vendor; for
3453 instance, the TQM823L systems are available without (standard)
3454 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003455 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003456
wdenk2729af92004-05-03 20:45:30 +00003457 make TQM823L_config
3458 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003459
wdenk2729af92004-05-03 20:45:30 +00003460 make TQM823L_LCD_config
3461 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003462
wdenk2729af92004-05-03 20:45:30 +00003463 etc.
wdenkc6097192002-11-03 00:24:07 +00003464
wdenkc6097192002-11-03 00:24:07 +00003465
wdenk2729af92004-05-03 20:45:30 +00003466Finally, type "make all", and you should get some working U-Boot
3467images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003468
wdenk2729af92004-05-03 20:45:30 +00003469- "u-boot.bin" is a raw binary image
3470- "u-boot" is an image in ELF binary format
3471- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003472
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003473By default the build is performed locally and the objects are saved
3474in the source directory. One of the two methods can be used to change
3475this behavior and build U-Boot to some external directory:
3476
34771. Add O= to the make command line invocations:
3478
3479 make O=/tmp/build distclean
3480 make O=/tmp/build NAME_config
3481 make O=/tmp/build all
3482
34832. Set environment variable BUILD_DIR to point to the desired location:
3484
3485 export BUILD_DIR=/tmp/build
3486 make distclean
3487 make NAME_config
3488 make all
3489
3490Note that the command line "O=" setting overrides the BUILD_DIR environment
3491variable.
3492
wdenkc6097192002-11-03 00:24:07 +00003493
wdenk2729af92004-05-03 20:45:30 +00003494Please be aware that the Makefiles assume you are using GNU make, so
3495for instance on NetBSD you might need to use "gmake" instead of
3496native "make".
wdenkc6097192002-11-03 00:24:07 +00003497
wdenkc6097192002-11-03 00:24:07 +00003498
wdenk2729af92004-05-03 20:45:30 +00003499If the system board that you have is not listed, then you will need
3500to port U-Boot to your hardware platform. To do this, follow these
3501steps:
wdenkc6097192002-11-03 00:24:07 +00003502
wdenk2729af92004-05-03 20:45:30 +000035031. Add a new configuration option for your board to the toplevel
3504 "Makefile" and to the "MAKEALL" script, using the existing
3505 entries as examples. Note that here and at many other places
3506 boards and other names are listed in alphabetical sort order. Please
3507 keep this order.
35082. Create a new directory to hold your board specific code. Add any
3509 files you need. In your board directory, you will need at least
3510 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
35113. Create a new configuration file "include/configs/<board>.h" for
3512 your board
35133. If you're porting U-Boot to a new CPU, then also create a new
3514 directory to hold your CPU specific code. Add any files you need.
35154. Run "make <board>_config" with your new name.
35165. Type "make", and you should get a working "u-boot.srec" file
3517 to be installed on your target system.
35186. Debug and solve any problems that might arise.
3519 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003520
wdenkc6097192002-11-03 00:24:07 +00003521
wdenk2729af92004-05-03 20:45:30 +00003522Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3523==============================================================
wdenkc6097192002-11-03 00:24:07 +00003524
Wolfgang Denk218ca722008-03-26 10:40:12 +01003525If you have modified U-Boot sources (for instance added a new board
3526or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003527provide feedback to the other developers. The feedback normally takes
3528the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003529official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003530
Wolfgang Denk218ca722008-03-26 10:40:12 +01003531But before you submit such a patch, please verify that your modifi-
3532cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003533the supported boards compile WITHOUT ANY compiler warnings. To do so,
3534just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003535for ALL supported system. Be warned, this will take a while. You can
3536select which (cross) compiler to use by passing a `CROSS_COMPILE'
3537environment variable to the script, i. e. to use the ELDK cross tools
3538you can type
wdenkc6097192002-11-03 00:24:07 +00003539
wdenk2729af92004-05-03 20:45:30 +00003540 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003541
wdenk2729af92004-05-03 20:45:30 +00003542or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003543
wdenk2729af92004-05-03 20:45:30 +00003544 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003545
Wolfgang Denk218ca722008-03-26 10:40:12 +01003546When using the MAKEALL script, the default behaviour is to build
3547U-Boot in the source directory. This location can be changed by
3548setting the BUILD_DIR environment variable. Also, for each target
3549built, the MAKEALL script saves two log files (<target>.ERR and
3550<target>.MAKEALL) in the <source dir>/LOG directory. This default
3551location can be changed by setting the MAKEALL_LOGDIR environment
3552variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003553
3554 export BUILD_DIR=/tmp/build
3555 export MAKEALL_LOGDIR=/tmp/log
3556 CROSS_COMPILE=ppc_8xx- MAKEALL
3557
Wolfgang Denk218ca722008-03-26 10:40:12 +01003558With the above settings build objects are saved in the /tmp/build,
3559log files are saved in the /tmp/log and the source tree remains clean
3560during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003561
3562
wdenk2729af92004-05-03 20:45:30 +00003563See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003564
wdenkc6097192002-11-03 00:24:07 +00003565
wdenk2729af92004-05-03 20:45:30 +00003566Monitor Commands - Overview:
3567============================
wdenkc6097192002-11-03 00:24:07 +00003568
wdenk2729af92004-05-03 20:45:30 +00003569go - start application at address 'addr'
3570run - run commands in an environment variable
3571bootm - boot application image from memory
3572bootp - boot image via network using BootP/TFTP protocol
3573tftpboot- boot image via network using TFTP protocol
3574 and env variables "ipaddr" and "serverip"
3575 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003576tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003577rarpboot- boot image via network using RARP/TFTP protocol
3578diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3579loads - load S-Record file over serial line
3580loadb - load binary file over serial line (kermit mode)
3581md - memory display
3582mm - memory modify (auto-incrementing)
3583nm - memory modify (constant address)
3584mw - memory write (fill)
3585cp - memory copy
3586cmp - memory compare
3587crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003588i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003589sspi - SPI utility commands
3590base - print or set address offset
3591printenv- print environment variables
3592setenv - set environment variables
3593saveenv - save environment variables to persistent storage
3594protect - enable or disable FLASH write protection
3595erase - erase FLASH memory
3596flinfo - print FLASH memory information
3597bdinfo - print Board Info structure
3598iminfo - print header information for application image
3599coninfo - print console devices and informations
3600ide - IDE sub-system
3601loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003602loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003603mtest - simple RAM test
3604icache - enable or disable instruction cache
3605dcache - enable or disable data cache
3606reset - Perform RESET of the CPU
3607echo - echo args to console
3608version - print monitor version
3609help - print online help
3610? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003611
wdenkc6097192002-11-03 00:24:07 +00003612
wdenk2729af92004-05-03 20:45:30 +00003613Monitor Commands - Detailed Description:
3614========================================
wdenkc6097192002-11-03 00:24:07 +00003615
wdenk2729af92004-05-03 20:45:30 +00003616TODO.
wdenkc6097192002-11-03 00:24:07 +00003617
wdenk2729af92004-05-03 20:45:30 +00003618For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003619
3620
wdenk2729af92004-05-03 20:45:30 +00003621Environment Variables:
3622======================
wdenkc6097192002-11-03 00:24:07 +00003623
wdenk2729af92004-05-03 20:45:30 +00003624U-Boot supports user configuration using Environment Variables which
3625can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003626
wdenk2729af92004-05-03 20:45:30 +00003627Environment Variables are set using "setenv", printed using
3628"printenv", and saved to Flash using "saveenv". Using "setenv"
3629without a value can be used to delete a variable from the
3630environment. As long as you don't save the environment you are
3631working with an in-memory copy. In case the Flash area containing the
3632environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003633
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003634Some configuration options can be set using Environment Variables.
3635
3636List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003637
wdenk2729af92004-05-03 20:45:30 +00003638 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003639
wdenk2729af92004-05-03 20:45:30 +00003640 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003641
wdenk2729af92004-05-03 20:45:30 +00003642 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003643
wdenk2729af92004-05-03 20:45:30 +00003644 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003645
wdenk2729af92004-05-03 20:45:30 +00003646 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003647
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003648 bootm_low - Memory range available for image processing in the bootm
3649 command can be restricted. This variable is given as
3650 a hexadecimal number and defines lowest address allowed
3651 for use by the bootm command. See also "bootm_size"
3652 environment variable. Address defined by "bootm_low" is
3653 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003654 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3655 bootm_mapsize.
3656
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003657 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003658 This variable is given as a hexadecimal number and it
3659 defines the size of the memory region starting at base
3660 address bootm_low that is accessible by the Linux kernel
3661 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3662 as the default value if it is defined, and bootm_size is
3663 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003664
3665 bootm_size - Memory range available for image processing in the bootm
3666 command can be restricted. This variable is given as
3667 a hexadecimal number and defines the size of the region
3668 allowed for use by the bootm command. See also "bootm_low"
3669 environment variable.
3670
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003671 updatefile - Location of the software update file on a TFTP server, used
3672 by the automatic software update feature. Please refer to
3673 documentation in doc/README.update for more details.
3674
wdenk2729af92004-05-03 20:45:30 +00003675 autoload - if set to "no" (any string beginning with 'n'),
3676 "bootp" will just load perform a lookup of the
3677 configuration from the BOOTP server, but not try to
3678 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003679
wdenk2729af92004-05-03 20:45:30 +00003680 autostart - if set to "yes", an image loaded using the "bootp",
3681 "rarpboot", "tftpboot" or "diskboot" commands will
3682 be automatically started (by internally calling
3683 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk2729af92004-05-03 20:45:30 +00003685 If set to "no", a standalone image passed to the
3686 "bootm" command will be copied to the load address
3687 (and eventually uncompressed), but NOT be started.
3688 This can be used to load and uncompress arbitrary
3689 data.
wdenkc6097192002-11-03 00:24:07 +00003690
David A. Longa28afca2011-07-09 16:40:19 -04003691 fdt_high - if set this restricts the maximum address that the
3692 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003693 For example, if you have a system with 1 GB memory
3694 at physical address 0x10000000, while Linux kernel
3695 only recognizes the first 704 MB as low memory, you
3696 may need to set fdt_high as 0x3C000000 to have the
3697 device tree blob be copied to the maximum address
3698 of the 704 MB low memory, so that Linux kernel can
3699 access it during the boot procedure.
3700
David A. Longa28afca2011-07-09 16:40:19 -04003701 If this is set to the special value 0xFFFFFFFF then
3702 the fdt will not be copied at all on boot. For this
3703 to work it must reside in writable memory, have
3704 sufficient padding on the end of it for u-boot to
3705 add the information it needs into it, and the memory
3706 must be accessible by the kernel.
3707
Simon Glasseea63e02011-10-24 19:15:34 +00003708 fdtcontroladdr- if set this is the address of the control flattened
3709 device tree used by U-Boot when CONFIG_OF_CONTROL is
3710 defined.
3711
wdenk17ea1172004-06-06 21:51:03 +00003712 i2cfast - (PPC405GP|PPC405EP only)
3713 if set to 'y' configures Linux I2C driver for fast
3714 mode (400kHZ). This environment variable is used in
3715 initialization code. So, for changes to be effective
3716 it must be saved and board must be reset.
3717
wdenk2729af92004-05-03 20:45:30 +00003718 initrd_high - restrict positioning of initrd images:
3719 If this variable is not set, initrd images will be
3720 copied to the highest possible address in RAM; this
3721 is usually what you want since it allows for
3722 maximum initrd size. If for some reason you want to
3723 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003724 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003725 variable to a value of "no" or "off" or "0".
3726 Alternatively, you can set it to a maximum upper
3727 address to use (U-Boot will still check that it
3728 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003729
wdenk2729af92004-05-03 20:45:30 +00003730 For instance, when you have a system with 16 MB
3731 RAM, and want to reserve 4 MB from use by Linux,
3732 you can do this by adding "mem=12M" to the value of
3733 the "bootargs" variable. However, now you must make
3734 sure that the initrd image is placed in the first
3735 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003736
wdenk2729af92004-05-03 20:45:30 +00003737 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk2729af92004-05-03 20:45:30 +00003739 If you set initrd_high to 0xFFFFFFFF, this is an
3740 indication to U-Boot that all addresses are legal
3741 for the Linux kernel, including addresses in flash
3742 memory. In this case U-Boot will NOT COPY the
3743 ramdisk at all. This may be useful to reduce the
3744 boot time on your system, but requires that this
3745 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003746
wdenk2729af92004-05-03 20:45:30 +00003747 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003748
wdenk2729af92004-05-03 20:45:30 +00003749 loadaddr - Default load address for commands like "bootp",
3750 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003751
wdenk2729af92004-05-03 20:45:30 +00003752 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003753
wdenk2729af92004-05-03 20:45:30 +00003754 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003755
wdenk2729af92004-05-03 20:45:30 +00003756 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003757
wdenk2729af92004-05-03 20:45:30 +00003758 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003759
wdenk2729af92004-05-03 20:45:30 +00003760 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003761
Mike Frysingere2a53452011-10-02 10:01:27 +00003762 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003763
Mike Frysingere2a53452011-10-02 10:01:27 +00003764 ethact - controls which interface is currently active.
3765 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003766
Heiko Schocher48690d82010-07-20 17:45:02 +02003767 => setenv ethact FEC
3768 => ping 192.168.0.1 # traffic sent on FEC
3769 => setenv ethact SCC
3770 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003771
Matthias Fuchse1692572008-01-17 07:45:05 +01003772 ethrotate - When set to "no" U-Boot does not go through all
3773 available network interfaces.
3774 It just stays at the currently selected interface.
3775
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003776 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003777 either succeed or fail without retrying.
3778 When set to "once" the network operation will
3779 fail when all the available network interfaces
3780 are tried once without success.
3781 Useful on scripts which control the retry operation
3782 themselves.
wdenkc6097192002-11-03 00:24:07 +00003783
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003784 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003785
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003786 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003787 UDP source port.
3788
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003789 tftpdstport - If this is set, the value is used for TFTP's UDP
3790 destination port instead of the Well Know Port 69.
3791
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003792 tftpblocksize - Block size to use for TFTP transfers; if not set,
3793 we use the TFTP server's default block size
3794
3795 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3796 seconds, minimum value is 1000 = 1 second). Defines
3797 when a packet is considered to be lost so it has to
3798 be retransmitted. The default is 5000 = 5 seconds.
3799 Lowering this value may make downloads succeed
3800 faster in networks with high packet loss rates or
3801 with unreliable TFTP servers.
3802
3803 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003804 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003805 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003806
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003807The following image location variables contain the location of images
3808used in booting. The "Image" column gives the role of the image and is
3809not an environment variable name. The other columns are environment
3810variable names. "File Name" gives the name of the file on a TFTP
3811server, "RAM Address" gives the location in RAM the image will be
3812loaded to, and "Flash Location" gives the image's address in NOR
3813flash or offset in NAND flash.
3814
3815*Note* - these variables don't have to be defined for all boards, some
3816boards currenlty use other variables for these purposes, and some
3817boards use these variables for other purposes.
3818
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003819Image File Name RAM Address Flash Location
3820----- --------- ----------- --------------
3821u-boot u-boot u-boot_addr_r u-boot_addr
3822Linux kernel bootfile kernel_addr_r kernel_addr
3823device tree blob fdtfile fdt_addr_r fdt_addr
3824ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003825
wdenk2729af92004-05-03 20:45:30 +00003826The following environment variables may be used and automatically
3827updated by the network boot commands ("bootp" and "rarpboot"),
3828depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003829
wdenk2729af92004-05-03 20:45:30 +00003830 bootfile - see above
3831 dnsip - IP address of your Domain Name Server
3832 dnsip2 - IP address of your secondary Domain Name Server
3833 gatewayip - IP address of the Gateway (Router) to use
3834 hostname - Target hostname
3835 ipaddr - see above
3836 netmask - Subnet Mask
3837 rootpath - Pathname of the root filesystem on the NFS server
3838 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003839
wdenka3d991b2004-04-15 21:48:45 +00003840
wdenk2729af92004-05-03 20:45:30 +00003841There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk2729af92004-05-03 20:45:30 +00003843 serial# - contains hardware identification information such
3844 as type string and/or serial number
3845 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003846
wdenk2729af92004-05-03 20:45:30 +00003847These variables can be set only once (usually during manufacturing of
3848the board). U-Boot refuses to delete or overwrite these variables
3849once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003850
3851
wdenk2729af92004-05-03 20:45:30 +00003852Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003853
wdenk2729af92004-05-03 20:45:30 +00003854 ver - Contains the U-Boot version string as printed
3855 with the "version" command. This variable is
3856 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003857
wdenkc6097192002-11-03 00:24:07 +00003858
wdenk2729af92004-05-03 20:45:30 +00003859Please note that changes to some configuration parameters may take
3860only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003861
stroesec1551ea2003-04-04 15:53:41 +00003862
wdenk2729af92004-05-03 20:45:30 +00003863Command Line Parsing:
3864=====================
stroesec1551ea2003-04-04 15:53:41 +00003865
wdenk2729af92004-05-03 20:45:30 +00003866There are two different command line parsers available with U-Boot:
3867the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003868
wdenk2729af92004-05-03 20:45:30 +00003869Old, simple command line parser:
3870--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003871
wdenk2729af92004-05-03 20:45:30 +00003872- supports environment variables (through setenv / saveenv commands)
3873- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003874- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003875- special characters ('$', ';') can be escaped by prefixing with '\',
3876 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003877 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003878- You can also escape text by enclosing in single apostrophes, for example:
3879 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003880
wdenk2729af92004-05-03 20:45:30 +00003881Hush shell:
3882-----------
wdenkf07771c2003-05-28 08:06:31 +00003883
wdenk2729af92004-05-03 20:45:30 +00003884- similar to Bourne shell, with control structures like
3885 if...then...else...fi, for...do...done; while...do...done,
3886 until...do...done, ...
3887- supports environment ("global") variables (through setenv / saveenv
3888 commands) and local shell variables (through standard shell syntax
3889 "name=value"); only environment variables can be used with "run"
3890 command
wdenkf07771c2003-05-28 08:06:31 +00003891
wdenk2729af92004-05-03 20:45:30 +00003892General rules:
3893--------------
wdenkf07771c2003-05-28 08:06:31 +00003894
wdenk2729af92004-05-03 20:45:30 +00003895(1) If a command line (or an environment variable executed by a "run"
3896 command) contains several commands separated by semicolon, and
3897 one of these commands fails, then the remaining commands will be
3898 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003899
wdenk2729af92004-05-03 20:45:30 +00003900(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003901 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003902 command will cause "run" to terminate, i. e. the remaining
3903 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003904
wdenk2729af92004-05-03 20:45:30 +00003905Note for Redundant Ethernet Interfaces:
3906=======================================
wdenkf07771c2003-05-28 08:06:31 +00003907
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003908Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003909such configurations and is capable of automatic selection of a
3910"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003911
wdenk2729af92004-05-03 20:45:30 +00003912Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3913MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3914"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003915
wdenk2729af92004-05-03 20:45:30 +00003916If the network interface stores some valid MAC address (for instance
3917in SROM), this is used as default address if there is NO correspon-
3918ding setting in the environment; if the corresponding environment
3919variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003920
wdenk2729af92004-05-03 20:45:30 +00003921o If the SROM has a valid MAC address, and there is no address in the
3922 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003923
wdenk2729af92004-05-03 20:45:30 +00003924o If there is no valid address in the SROM, and a definition in the
3925 environment exists, then the value from the environment variable is
3926 used.
wdenkc6097192002-11-03 00:24:07 +00003927
wdenk2729af92004-05-03 20:45:30 +00003928o If both the SROM and the environment contain a MAC address, and
3929 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk2729af92004-05-03 20:45:30 +00003931o If both the SROM and the environment contain a MAC address, and the
3932 addresses differ, the value from the environment is used and a
3933 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003934
wdenk2729af92004-05-03 20:45:30 +00003935o If neither SROM nor the environment contain a MAC address, an error
3936 is raised.
wdenkc6097192002-11-03 00:24:07 +00003937
Ben Warrenecee9322010-04-26 11:11:46 -07003938If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003939will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07003940may be skipped by setting the appropriate 'ethmacskip' environment variable.
3941The naming convention is as follows:
3942"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003943
wdenk2729af92004-05-03 20:45:30 +00003944Image Formats:
3945==============
wdenkc6097192002-11-03 00:24:07 +00003946
Marian Balakowicz3310c542008-03-12 12:13:13 +01003947U-Boot is capable of booting (and performing other auxiliary operations on)
3948images in two formats:
3949
3950New uImage format (FIT)
3951-----------------------
3952
3953Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3954to Flattened Device Tree). It allows the use of images with multiple
3955components (several kernels, ramdisks, etc.), with contents protected by
3956SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3957
3958
3959Old uImage format
3960-----------------
3961
3962Old image format is based on binary files which can be basically anything,
3963preceded by a special header; see the definitions in include/image.h for
3964details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003965
wdenk2729af92004-05-03 20:45:30 +00003966* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3967 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003968 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3969 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3970 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003971* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003972 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3973 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003974* Compression Type (uncompressed, gzip, bzip2)
3975* Load Address
3976* Entry Point
3977* Image Name
3978* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003979
wdenk2729af92004-05-03 20:45:30 +00003980The header is marked by a special Magic Number, and both the header
3981and the data portions of the image are secured against corruption by
3982CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003983
wdenkc6097192002-11-03 00:24:07 +00003984
wdenk2729af92004-05-03 20:45:30 +00003985Linux Support:
3986==============
wdenkc6097192002-11-03 00:24:07 +00003987
wdenk2729af92004-05-03 20:45:30 +00003988Although U-Boot should support any OS or standalone application
3989easily, the main focus has always been on Linux during the design of
3990U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992U-Boot includes many features that so far have been part of some
3993special "boot loader" code within the Linux kernel. Also, any
3994"initrd" images to be used are no longer part of one big Linux image;
3995instead, kernel and "initrd" are separate images. This implementation
3996serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003997
wdenk2729af92004-05-03 20:45:30 +00003998- the same features can be used for other OS or standalone
3999 applications (for instance: using compressed images to reduce the
4000 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004001
wdenk2729af92004-05-03 20:45:30 +00004002- it becomes much easier to port new Linux kernel versions because
4003 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004004
wdenk2729af92004-05-03 20:45:30 +00004005- the same Linux kernel image can now be used with different "initrd"
4006 images; of course this also means that different kernel images can
4007 be run with the same "initrd". This makes testing easier (you don't
4008 have to build a new "zImage.initrd" Linux image when you just
4009 change a file in your "initrd"). Also, a field-upgrade of the
4010 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004011
wdenkc6097192002-11-03 00:24:07 +00004012
wdenk2729af92004-05-03 20:45:30 +00004013Linux HOWTO:
4014============
wdenkc6097192002-11-03 00:24:07 +00004015
wdenk2729af92004-05-03 20:45:30 +00004016Porting Linux to U-Boot based systems:
4017---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk2729af92004-05-03 20:45:30 +00004019U-Boot cannot save you from doing all the necessary modifications to
4020configure the Linux device drivers for use with your target hardware
4021(no, we don't intend to provide a full virtual machine interface to
4022Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004023
Stefan Roesea47a12b2010-04-15 16:07:28 +02004024But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004025
wdenk2729af92004-05-03 20:45:30 +00004026Just make sure your machine specific header file (for instance
4027include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004028Information structure as we define in include/asm-<arch>/u-boot.h,
4029and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004030as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004031
wdenkc6097192002-11-03 00:24:07 +00004032
wdenk2729af92004-05-03 20:45:30 +00004033Configuring the Linux kernel:
4034-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004035
wdenk2729af92004-05-03 20:45:30 +00004036No specific requirements for U-Boot. Make sure you have some root
4037device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004038
wdenkc6097192002-11-03 00:24:07 +00004039
wdenk2729af92004-05-03 20:45:30 +00004040Building a Linux Image:
4041-----------------------
wdenkc6097192002-11-03 00:24:07 +00004042
wdenk2729af92004-05-03 20:45:30 +00004043With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4044not used. If you use recent kernel source, a new build target
4045"uImage" will exist which automatically builds an image usable by
4046U-Boot. Most older kernels also have support for a "pImage" target,
4047which was introduced for our predecessor project PPCBoot and uses a
4048100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004049
wdenk2729af92004-05-03 20:45:30 +00004050Example:
wdenkc6097192002-11-03 00:24:07 +00004051
wdenk2729af92004-05-03 20:45:30 +00004052 make TQM850L_config
4053 make oldconfig
4054 make dep
4055 make uImage
wdenkc6097192002-11-03 00:24:07 +00004056
wdenk2729af92004-05-03 20:45:30 +00004057The "uImage" build target uses a special tool (in 'tools/mkimage') to
4058encapsulate a compressed Linux kernel image with header information,
4059CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004060
wdenk2729af92004-05-03 20:45:30 +00004061* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004062
wdenk2729af92004-05-03 20:45:30 +00004063* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004064
wdenk2729af92004-05-03 20:45:30 +00004065 ${CROSS_COMPILE}-objcopy -O binary \
4066 -R .note -R .comment \
4067 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004068
wdenk2729af92004-05-03 20:45:30 +00004069* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004072
wdenk2729af92004-05-03 20:45:30 +00004073* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004074
wdenk2729af92004-05-03 20:45:30 +00004075 mkimage -A ppc -O linux -T kernel -C gzip \
4076 -a 0 -e 0 -n "Linux Kernel Image" \
4077 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004078
wdenk24ee89b2002-11-03 17:56:27 +00004079
wdenk2729af92004-05-03 20:45:30 +00004080The "mkimage" tool can also be used to create ramdisk images for use
4081with U-Boot, either separated from the Linux kernel image, or
4082combined into one file. "mkimage" encapsulates the images with a 64
4083byte header containing information about target architecture,
4084operating system, image type, compression method, entry points, time
4085stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087"mkimage" can be called in two ways: to verify existing images and
4088print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004089
wdenk2729af92004-05-03 20:45:30 +00004090In the first form (with "-l" option) mkimage lists the information
4091contained in the header of an existing U-Boot image; this includes
4092checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004093
wdenk2729af92004-05-03 20:45:30 +00004094 tools/mkimage -l image
4095 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004096
wdenk2729af92004-05-03 20:45:30 +00004097The second form (with "-d" option) is used to build a U-Boot image
4098from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004099
wdenk2729af92004-05-03 20:45:30 +00004100 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4101 -n name -d data_file image
4102 -A ==> set architecture to 'arch'
4103 -O ==> set operating system to 'os'
4104 -T ==> set image type to 'type'
4105 -C ==> set compression type 'comp'
4106 -a ==> set load address to 'addr' (hex)
4107 -e ==> set entry point to 'ep' (hex)
4108 -n ==> set image name to 'name'
4109 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004110
wdenk69459792004-05-29 16:53:29 +00004111Right now, all Linux kernels for PowerPC systems use the same load
4112address (0x00000000), but the entry point address depends on the
4113kernel version:
wdenkc6097192002-11-03 00:24:07 +00004114
wdenk2729af92004-05-03 20:45:30 +00004115- 2.2.x kernels have the entry point at 0x0000000C,
4116- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk2729af92004-05-03 20:45:30 +00004118So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004119
wdenk2729af92004-05-03 20:45:30 +00004120 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4121 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004122 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004123 > examples/uImage.TQM850L
4124 Image Name: 2.4.4 kernel for TQM850L
4125 Created: Wed Jul 19 02:34:59 2000
4126 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4127 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4128 Load Address: 0x00000000
4129 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004132
wdenk2729af92004-05-03 20:45:30 +00004133 -> tools/mkimage -l examples/uImage.TQM850L
4134 Image Name: 2.4.4 kernel for TQM850L
4135 Created: Wed Jul 19 02:34:59 2000
4136 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4137 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4138 Load Address: 0x00000000
4139 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004140
wdenk2729af92004-05-03 20:45:30 +00004141NOTE: for embedded systems where boot time is critical you can trade
4142speed for memory and install an UNCOMPRESSED image instead: this
4143needs more space in Flash, but boots much faster since it does not
4144need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004145
Stefan Roesea47a12b2010-04-15 16:07:28 +02004146 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004147 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4148 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004149 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004150 > examples/uImage.TQM850L-uncompressed
4151 Image Name: 2.4.4 kernel for TQM850L
4152 Created: Wed Jul 19 02:34:59 2000
4153 Image Type: PowerPC Linux Kernel Image (uncompressed)
4154 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4155 Load Address: 0x00000000
4156 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004157
wdenkc6097192002-11-03 00:24:07 +00004158
wdenk2729af92004-05-03 20:45:30 +00004159Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4160when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162 -> tools/mkimage -n 'Simple Ramdisk Image' \
4163 > -A ppc -O linux -T ramdisk -C gzip \
4164 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4165 Image Name: Simple Ramdisk Image
4166 Created: Wed Jan 12 14:01:50 2000
4167 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4168 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4169 Load Address: 0x00000000
4170 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004171
wdenkdb01a2e2004-04-15 23:14:49 +00004172
wdenk2729af92004-05-03 20:45:30 +00004173Installing a Linux Image:
4174-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176To downloading a U-Boot image over the serial (console) interface,
4177you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004180
wdenk2729af92004-05-03 20:45:30 +00004181The 'objcopy' does not understand the information in the U-Boot
4182image header, so the resulting S-Record file will be relative to
4183address 0x00000000. To load it to a given address, you need to
4184specify the target address as 'offset' parameter with the 'loads'
4185command.
wdenkc6097192002-11-03 00:24:07 +00004186
wdenk2729af92004-05-03 20:45:30 +00004187Example: install the image to address 0x40100000 (which on the
4188TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004191
wdenk2729af92004-05-03 20:45:30 +00004192 .......... done
4193 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004194
wdenk2729af92004-05-03 20:45:30 +00004195 => loads 40100000
4196 ## Ready for S-Record download ...
4197 ~>examples/image.srec
4198 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4199 ...
4200 15989 15990 15991 15992
4201 [file transfer complete]
4202 [connected]
4203 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004204
4205
wdenk2729af92004-05-03 20:45:30 +00004206You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004207this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004208corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004209
wdenk2729af92004-05-03 20:45:30 +00004210 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004211
wdenk2729af92004-05-03 20:45:30 +00004212 ## Checking Image at 40100000 ...
4213 Image Name: 2.2.13 for initrd on TQM850L
4214 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4215 Data Size: 335725 Bytes = 327 kB = 0 MB
4216 Load Address: 00000000
4217 Entry Point: 0000000c
4218 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004219
4220
wdenk2729af92004-05-03 20:45:30 +00004221Boot Linux:
4222-----------
wdenkc6097192002-11-03 00:24:07 +00004223
wdenk2729af92004-05-03 20:45:30 +00004224The "bootm" command is used to boot an application that is stored in
4225memory (RAM or Flash). In case of a Linux kernel image, the contents
4226of the "bootargs" environment variable is passed to the kernel as
4227parameters. You can check and modify this variable using the
4228"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004229
4230
wdenk2729af92004-05-03 20:45:30 +00004231 => printenv bootargs
4232 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004233
wdenk2729af92004-05-03 20:45:30 +00004234 => 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 +00004235
wdenk2729af92004-05-03 20:45:30 +00004236 => printenv bootargs
4237 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 +00004238
wdenk2729af92004-05-03 20:45:30 +00004239 => bootm 40020000
4240 ## Booting Linux kernel at 40020000 ...
4241 Image Name: 2.2.13 for NFS on TQM850L
4242 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4243 Data Size: 381681 Bytes = 372 kB = 0 MB
4244 Load Address: 00000000
4245 Entry Point: 0000000c
4246 Verifying Checksum ... OK
4247 Uncompressing Kernel Image ... OK
4248 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
4249 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4250 time_init: decrementer frequency = 187500000/60
4251 Calibrating delay loop... 49.77 BogoMIPS
4252 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4253 ...
wdenkc6097192002-11-03 00:24:07 +00004254
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004255If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004256the memory addresses of both the kernel and the initrd image (PPBCOOT
4257format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004258
wdenk2729af92004-05-03 20:45:30 +00004259 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk2729af92004-05-03 20:45:30 +00004261 ## Checking Image at 40100000 ...
4262 Image Name: 2.2.13 for initrd on TQM850L
4263 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4264 Data Size: 335725 Bytes = 327 kB = 0 MB
4265 Load Address: 00000000
4266 Entry Point: 0000000c
4267 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004268
wdenk2729af92004-05-03 20:45:30 +00004269 ## Checking Image at 40200000 ...
4270 Image Name: Simple Ramdisk Image
4271 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4272 Data Size: 566530 Bytes = 553 kB = 0 MB
4273 Load Address: 00000000
4274 Entry Point: 00000000
4275 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277 => bootm 40100000 40200000
4278 ## Booting Linux kernel at 40100000 ...
4279 Image Name: 2.2.13 for initrd on TQM850L
4280 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4281 Data Size: 335725 Bytes = 327 kB = 0 MB
4282 Load Address: 00000000
4283 Entry Point: 0000000c
4284 Verifying Checksum ... OK
4285 Uncompressing Kernel Image ... OK
4286 ## Loading RAMDisk Image at 40200000 ...
4287 Image Name: Simple Ramdisk Image
4288 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4289 Data Size: 566530 Bytes = 553 kB = 0 MB
4290 Load Address: 00000000
4291 Entry Point: 00000000
4292 Verifying Checksum ... OK
4293 Loading Ramdisk ... OK
4294 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
4295 Boot arguments: root=/dev/ram
4296 time_init: decrementer frequency = 187500000/60
4297 Calibrating delay loop... 49.77 BogoMIPS
4298 ...
4299 RAMDISK: Compressed image found at block 0
4300 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004301
wdenk2729af92004-05-03 20:45:30 +00004302 bash#
wdenkc6097192002-11-03 00:24:07 +00004303
Matthew McClintock02677682006-06-28 10:41:37 -05004304Boot Linux and pass a flat device tree:
4305-----------
4306
4307First, U-Boot must be compiled with the appropriate defines. See the section
4308titled "Linux Kernel Interface" above for a more in depth explanation. The
4309following is an example of how to start a kernel and pass an updated
4310flat device tree:
4311
4312=> print oftaddr
4313oftaddr=0x300000
4314=> print oft
4315oft=oftrees/mpc8540ads.dtb
4316=> tftp $oftaddr $oft
4317Speed: 1000, full duplex
4318Using TSEC0 device
4319TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4320Filename 'oftrees/mpc8540ads.dtb'.
4321Load address: 0x300000
4322Loading: #
4323done
4324Bytes transferred = 4106 (100a hex)
4325=> tftp $loadaddr $bootfile
4326Speed: 1000, full duplex
4327Using TSEC0 device
4328TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4329Filename 'uImage'.
4330Load address: 0x200000
4331Loading:############
4332done
4333Bytes transferred = 1029407 (fb51f hex)
4334=> print loadaddr
4335loadaddr=200000
4336=> print oftaddr
4337oftaddr=0x300000
4338=> bootm $loadaddr - $oftaddr
4339## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004340 Image Name: Linux-2.6.17-dirty
4341 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4342 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004343 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004344 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004345 Verifying Checksum ... OK
4346 Uncompressing Kernel Image ... OK
4347Booting using flat device tree at 0x300000
4348Using MPC85xx ADS machine description
4349Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4350[snip]
4351
4352
wdenk2729af92004-05-03 20:45:30 +00004353More About U-Boot Image Types:
4354------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004355
wdenk2729af92004-05-03 20:45:30 +00004356U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004357
wdenk2729af92004-05-03 20:45:30 +00004358 "Standalone Programs" are directly runnable in the environment
4359 provided by U-Boot; it is expected that (if they behave
4360 well) you can continue to work in U-Boot after return from
4361 the Standalone Program.
4362 "OS Kernel Images" are usually images of some Embedded OS which
4363 will take over control completely. Usually these programs
4364 will install their own set of exception handlers, device
4365 drivers, set up the MMU, etc. - this means, that you cannot
4366 expect to re-enter U-Boot except by resetting the CPU.
4367 "RAMDisk Images" are more or less just data blocks, and their
4368 parameters (address, size) are passed to an OS kernel that is
4369 being started.
4370 "Multi-File Images" contain several images, typically an OS
4371 (Linux) kernel image and one or more data images like
4372 RAMDisks. This construct is useful for instance when you want
4373 to boot over the network using BOOTP etc., where the boot
4374 server provides just a single image file, but you want to get
4375 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004376
wdenk2729af92004-05-03 20:45:30 +00004377 "Multi-File Images" start with a list of image sizes, each
4378 image size (in bytes) specified by an "uint32_t" in network
4379 byte order. This list is terminated by an "(uint32_t)0".
4380 Immediately after the terminating 0 follow the images, one by
4381 one, all aligned on "uint32_t" boundaries (size rounded up to
4382 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004383
wdenk2729af92004-05-03 20:45:30 +00004384 "Firmware Images" are binary images containing firmware (like
4385 U-Boot or FPGA images) which usually will be programmed to
4386 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004387
wdenk2729af92004-05-03 20:45:30 +00004388 "Script files" are command sequences that will be executed by
4389 U-Boot's command interpreter; this feature is especially
4390 useful when you configure U-Boot to use a real shell (hush)
4391 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004392
wdenkc6097192002-11-03 00:24:07 +00004393
wdenk2729af92004-05-03 20:45:30 +00004394Standalone HOWTO:
4395=================
wdenkc6097192002-11-03 00:24:07 +00004396
wdenk2729af92004-05-03 20:45:30 +00004397One of the features of U-Boot is that you can dynamically load and
4398run "standalone" applications, which can use some resources of
4399U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004400
wdenk2729af92004-05-03 20:45:30 +00004401Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004402
wdenk2729af92004-05-03 20:45:30 +00004403"Hello World" Demo:
4404-------------------
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406'examples/hello_world.c' contains a small "Hello World" Demo
4407application; it is automatically compiled when you build U-Boot.
4408It's configured to run at address 0x00040004, so you can play with it
4409like that:
wdenkc6097192002-11-03 00:24:07 +00004410
wdenk2729af92004-05-03 20:45:30 +00004411 => loads
4412 ## Ready for S-Record download ...
4413 ~>examples/hello_world.srec
4414 1 2 3 4 5 6 7 8 9 10 11 ...
4415 [file transfer complete]
4416 [connected]
4417 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419 => go 40004 Hello World! This is a test.
4420 ## Starting application at 0x00040004 ...
4421 Hello World
4422 argc = 7
4423 argv[0] = "40004"
4424 argv[1] = "Hello"
4425 argv[2] = "World!"
4426 argv[3] = "This"
4427 argv[4] = "is"
4428 argv[5] = "a"
4429 argv[6] = "test."
4430 argv[7] = "<NULL>"
4431 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004432
wdenk2729af92004-05-03 20:45:30 +00004433 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004434
wdenk2729af92004-05-03 20:45:30 +00004435Another example, which demonstrates how to register a CPM interrupt
4436handler with the U-Boot code, can be found in 'examples/timer.c'.
4437Here, a CPM timer is set up to generate an interrupt every second.
4438The interrupt service routine is trivial, just printing a '.'
4439character, but this is just a demo program. The application can be
4440controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk2729af92004-05-03 20:45:30 +00004442 ? - print current values og the CPM Timer registers
4443 b - enable interrupts and start timer
4444 e - stop timer and disable interrupts
4445 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004446
wdenk2729af92004-05-03 20:45:30 +00004447 => loads
4448 ## Ready for S-Record download ...
4449 ~>examples/timer.srec
4450 1 2 3 4 5 6 7 8 9 10 11 ...
4451 [file transfer complete]
4452 [connected]
4453 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk2729af92004-05-03 20:45:30 +00004455 => go 40004
4456 ## Starting application at 0x00040004 ...
4457 TIMERS=0xfff00980
4458 Using timer 1
4459 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004460
wdenk2729af92004-05-03 20:45:30 +00004461Hit 'b':
4462 [q, b, e, ?] Set interval 1000000 us
4463 Enabling timer
4464Hit '?':
4465 [q, b, e, ?] ........
4466 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4467Hit '?':
4468 [q, b, e, ?] .
4469 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4470Hit '?':
4471 [q, b, e, ?] .
4472 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4473Hit '?':
4474 [q, b, e, ?] .
4475 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4476Hit 'e':
4477 [q, b, e, ?] ...Stopping timer
4478Hit 'q':
4479 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004480
4481
wdenk2729af92004-05-03 20:45:30 +00004482Minicom warning:
4483================
wdenk85ec0bc2003-03-31 16:34:49 +00004484
wdenk2729af92004-05-03 20:45:30 +00004485Over time, many people have reported problems when trying to use the
4486"minicom" terminal emulation program for serial download. I (wd)
4487consider minicom to be broken, and recommend not to use it. Under
4488Unix, I recommend to use C-Kermit for general purpose use (and
4489especially for kermit binary protocol download ("loadb" command), and
4490use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004491
wdenk2729af92004-05-03 20:45:30 +00004492Nevertheless, if you absolutely want to use it try adding this
4493configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004494
wdenk2729af92004-05-03 20:45:30 +00004495 Name Program Name U/D FullScr IO-Red. Multi
4496 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4497 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004498
4499
wdenk2729af92004-05-03 20:45:30 +00004500NetBSD Notes:
4501=============
wdenkc6097192002-11-03 00:24:07 +00004502
wdenk2729af92004-05-03 20:45:30 +00004503Starting at version 0.9.2, U-Boot supports NetBSD both as host
4504(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004505
wdenk2729af92004-05-03 20:45:30 +00004506Building requires a cross environment; it is known to work on
4507NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4508need gmake since the Makefiles are not compatible with BSD make).
4509Note that the cross-powerpc package does not install include files;
4510attempting to build U-Boot will fail because <machine/ansi.h> is
4511missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004512
wdenk2729af92004-05-03 20:45:30 +00004513 # cd /usr/pkg/cross/powerpc-netbsd/include
4514 # mkdir powerpc
4515 # ln -s powerpc machine
4516 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4517 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk2729af92004-05-03 20:45:30 +00004519Native builds *don't* work due to incompatibilities between native
4520and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004521
wdenk2729af92004-05-03 20:45:30 +00004522Booting assumes that (the first part of) the image booted is a
4523stage-2 loader which in turn loads and then invokes the kernel
4524proper. Loader sources will eventually appear in the NetBSD source
4525tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004526meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004527
4528
wdenk2729af92004-05-03 20:45:30 +00004529Implementation Internals:
4530=========================
wdenkc6097192002-11-03 00:24:07 +00004531
wdenk2729af92004-05-03 20:45:30 +00004532The following is not intended to be a complete description of every
4533implementation detail. However, it should help to understand the
4534inner workings of U-Boot and make it easier to port it to custom
4535hardware.
wdenkc6097192002-11-03 00:24:07 +00004536
4537
wdenk2729af92004-05-03 20:45:30 +00004538Initial Stack, Global Data:
4539---------------------------
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk2729af92004-05-03 20:45:30 +00004541The implementation of U-Boot is complicated by the fact that U-Boot
4542starts running out of ROM (flash memory), usually without access to
4543system RAM (because the memory controller is not initialized yet).
4544This means that we don't have writable Data or BSS segments, and BSS
4545is not initialized as zero. To be able to get a C environment working
4546at all, we have to allocate at least a minimal stack. Implementation
4547options for this are defined and restricted by the CPU used: Some CPU
4548models provide on-chip memory (like the IMMR area on MPC8xx and
4549MPC826x processors), on others (parts of) the data cache can be
4550locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004551
Wolfgang Denk218ca722008-03-26 10:40:12 +01004552 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004553 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004554
wdenk2729af92004-05-03 20:45:30 +00004555 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4556 From: "Chris Hallinan" <clh@net1plus.com>
4557 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4558 ...
wdenk43d96162003-03-06 00:02:04 +00004559
wdenk2729af92004-05-03 20:45:30 +00004560 Correct me if I'm wrong, folks, but the way I understand it
4561 is this: Using DCACHE as initial RAM for Stack, etc, does not
4562 require any physical RAM backing up the cache. The cleverness
4563 is that the cache is being used as a temporary supply of
4564 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004565 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004566 can see how this works by studying the cache architecture and
4567 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004568
wdenk2729af92004-05-03 20:45:30 +00004569 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4570 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004571 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004572 option should work for you. Using CS 4 should be fine if your
4573 board designers haven't used it for something that would
4574 cause you grief during the initial boot! It is frequently not
4575 used.
wdenk43d96162003-03-06 00:02:04 +00004576
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004577 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004578 with your processor/board/system design. The default value
4579 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004580 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004581 than your SDRAM module. If you have a 64MB SDRAM module, set
4582 it above 400_0000. Just make sure your board has no resources
4583 that are supposed to respond to that address! That code in
4584 start.S has been around a while and should work as is when
4585 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004586
wdenk2729af92004-05-03 20:45:30 +00004587 -Chris Hallinan
4588 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004589
wdenk2729af92004-05-03 20:45:30 +00004590It is essential to remember this, since it has some impact on the C
4591code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk2729af92004-05-03 20:45:30 +00004593* Initialized global data (data segment) is read-only. Do not attempt
4594 to write it.
wdenkc6097192002-11-03 00:24:07 +00004595
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004596* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004597 as zero data - BSS segment) at all - this is undefined, initiali-
4598 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk2729af92004-05-03 20:45:30 +00004600* Stack space is very limited. Avoid big data buffers or things like
4601 that.
wdenkc6097192002-11-03 00:24:07 +00004602
wdenk2729af92004-05-03 20:45:30 +00004603Having only the stack as writable memory limits means we cannot use
4604normal global data to share information beween the code. But it
4605turned out that the implementation of U-Boot can be greatly
4606simplified by making a global data structure (gd_t) available to all
4607functions. We could pass a pointer to this data as argument to _all_
4608functions, but this would bloat the code. Instead we use a feature of
4609the GCC compiler (Global Register Variables) to share the data: we
4610place a pointer (gd) to the global data into a register which we
4611reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004612
wdenk2729af92004-05-03 20:45:30 +00004613When choosing a register for such a purpose we are restricted by the
4614relevant (E)ABI specifications for the current architecture, and by
4615GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004616
wdenk2729af92004-05-03 20:45:30 +00004617For PowerPC, the following registers have specific use:
4618 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004619 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004620 R3-R4: parameter passing and return values
4621 R5-R10: parameter passing
4622 R13: small data area pointer
4623 R30: GOT pointer
4624 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004625
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004626 (U-Boot also uses R12 as internal GOT pointer. r12
4627 is a volatile register so r12 needs to be reset when
4628 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004629
Wolfgang Denke7670f62008-02-14 22:43:22 +01004630 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004631
wdenk2729af92004-05-03 20:45:30 +00004632 Note: on PPC, we could use a static initializer (since the
4633 address of the global data structure is known at compile time),
4634 but it turned out that reserving a register results in somewhat
4635 smaller code - although the code savings are not that big (on
4636 average for all boards 752 bytes for the whole U-Boot image,
4637 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004638
Robin Getzc4db3352009-08-17 15:23:02 +00004639On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004640 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4641
Robin Getzc4db3352009-08-17 15:23:02 +00004642 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004643
wdenk2729af92004-05-03 20:45:30 +00004644On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk2729af92004-05-03 20:45:30 +00004646 R0: function argument word/integer result
4647 R1-R3: function argument word
4648 R9: GOT pointer
4649 R10: stack limit (used only if stack checking if enabled)
4650 R11: argument (frame) pointer
4651 R12: temporary workspace
4652 R13: stack pointer
4653 R14: link register
4654 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004655
wdenk2729af92004-05-03 20:45:30 +00004656 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004657
Thomas Chou0df01fd2010-05-21 11:08:03 +08004658On Nios II, the ABI is documented here:
4659 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4660
4661 ==> U-Boot will use gp to hold a pointer to the global data
4662
4663 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4664 to access small data sections, so gp is free.
4665
Macpaul Linafc1ce82011-10-19 20:41:11 +00004666On NDS32, the following registers are used:
4667
4668 R0-R1: argument/return
4669 R2-R5: argument
4670 R15: temporary register for assembler
4671 R16: trampoline register
4672 R28: frame pointer (FP)
4673 R29: global pointer (GP)
4674 R30: link register (LP)
4675 R31: stack pointer (SP)
4676 PC: program counter (PC)
4677
4678 ==> U-Boot will use R10 to hold a pointer to the global data
4679
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004680NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4681or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004682
wdenk2729af92004-05-03 20:45:30 +00004683Memory Management:
4684------------------
wdenkc6097192002-11-03 00:24:07 +00004685
wdenk2729af92004-05-03 20:45:30 +00004686U-Boot runs in system state and uses physical addresses, i.e. the
4687MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004688
wdenk2729af92004-05-03 20:45:30 +00004689The available memory is mapped to fixed addresses using the memory
4690controller. In this process, a contiguous block is formed for each
4691memory type (Flash, SDRAM, SRAM), even when it consists of several
4692physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004693
wdenk2729af92004-05-03 20:45:30 +00004694U-Boot is installed in the first 128 kB of the first Flash bank (on
4695TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4696booting and sizing and initializing DRAM, the code relocates itself
4697to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004698memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004699configuration setting]. Below that, a structure with global Board
4700Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk2729af92004-05-03 20:45:30 +00004702Additionally, some exception handler code is copied to the low 8 kB
4703of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004704
wdenk2729af92004-05-03 20:45:30 +00004705So a typical memory configuration with 16 MB of DRAM could look like
4706this:
wdenkc6097192002-11-03 00:24:07 +00004707
wdenk2729af92004-05-03 20:45:30 +00004708 0x0000 0000 Exception Vector code
4709 :
4710 0x0000 1FFF
4711 0x0000 2000 Free for Application Use
4712 :
4713 :
wdenkc6097192002-11-03 00:24:07 +00004714
wdenk2729af92004-05-03 20:45:30 +00004715 :
4716 :
4717 0x00FB FF20 Monitor Stack (Growing downward)
4718 0x00FB FFAC Board Info Data and permanent copy of global data
4719 0x00FC 0000 Malloc Arena
4720 :
4721 0x00FD FFFF
4722 0x00FE 0000 RAM Copy of Monitor Code
4723 ... eventually: LCD or video framebuffer
4724 ... eventually: pRAM (Protected RAM - unchanged by reset)
4725 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004726
4727
wdenk2729af92004-05-03 20:45:30 +00004728System Initialization:
4729----------------------
wdenkc6097192002-11-03 00:24:07 +00004730
wdenk2729af92004-05-03 20:45:30 +00004731In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004732(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004733configuration for CS0# this is a mirror of the onboard Flash memory.
4734To be able to re-map memory U-Boot then jumps to its link address.
4735To be able to implement the initialization code in C, a (small!)
4736initial stack is set up in the internal Dual Ported RAM (in case CPUs
4737which provide such a feature like MPC8xx or MPC8260), or in a locked
4738part of the data cache. After that, U-Boot initializes the CPU core,
4739the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004740
wdenk2729af92004-05-03 20:45:30 +00004741Next, all (potentially) available memory banks are mapped using a
4742preliminary mapping. For example, we put them on 512 MB boundaries
4743(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4744on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4745programmed for SDRAM access. Using the temporary configuration, a
4746simple memory test is run that determines the size of the SDRAM
4747banks.
wdenkc6097192002-11-03 00:24:07 +00004748
wdenk2729af92004-05-03 20:45:30 +00004749When there is more than one SDRAM bank, and the banks are of
4750different size, the largest is mapped first. For equal size, the first
4751bank (CS2#) is mapped first. The first mapping is always for address
47520x00000000, with any additional banks following immediately to create
4753contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755Then, the monitor installs itself at the upper end of the SDRAM area
4756and allocates memory for use by malloc() and for the global Board
4757Info data; also, the exception vector code is copied to the low RAM
4758pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk2729af92004-05-03 20:45:30 +00004760Only after this relocation will you have a "normal" C environment;
4761until that you are restricted in several ways, mostly because you are
4762running from ROM, and because the code will have to be relocated to a
4763new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004764
4765
wdenk2729af92004-05-03 20:45:30 +00004766U-Boot Porting Guide:
4767----------------------
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk2729af92004-05-03 20:45:30 +00004769[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4770list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004771
4772
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004773int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004774{
4775 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004776
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004777 signal(SIGALRM, no_more_time);
4778 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk2729af92004-05-03 20:45:30 +00004780 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004781 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004782 return 0;
4783 }
4784
wdenk2729af92004-05-03 20:45:30 +00004785 Download latest U-Boot source;
4786
Wolfgang Denk06682362008-12-30 22:56:11 +01004787 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004788
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004789 if (clueless)
4790 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004791
wdenk2729af92004-05-03 20:45:30 +00004792 while (learning) {
4793 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004794 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4795 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004796 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004797 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004798 }
wdenkc6097192002-11-03 00:24:07 +00004799
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004800 if (available_money > toLocalCurrency ($2500))
4801 Buy a BDI3000;
4802 else
wdenk2729af92004-05-03 20:45:30 +00004803 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004804
4805 if (a similar board exists) { /* hopefully... */
4806 cp -a board/<similar> board/<myboard>
4807 cp include/configs/<similar>.h include/configs/<myboard>.h
4808 } else {
4809 Create your own board support subdirectory;
4810 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004811 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004812 Edit new board/<myboard> files
4813 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004814
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004815 while (!accepted) {
4816 while (!running) {
4817 do {
4818 Add / modify source code;
4819 } until (compiles);
4820 Debug;
4821 if (clueless)
4822 email("Hi, I am having problems...");
4823 }
4824 Send patch file to the U-Boot email list;
4825 if (reasonable critiques)
4826 Incorporate improvements from email list code review;
4827 else
4828 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004829 }
wdenkc6097192002-11-03 00:24:07 +00004830
wdenk2729af92004-05-03 20:45:30 +00004831 return 0;
4832}
4833
4834void no_more_time (int sig)
4835{
4836 hire_a_guru();
4837}
wdenkc6097192002-11-03 00:24:07 +00004838
4839
wdenk2729af92004-05-03 20:45:30 +00004840Coding Standards:
4841-----------------
wdenkc6097192002-11-03 00:24:07 +00004842
wdenk2729af92004-05-03 20:45:30 +00004843All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004844coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004845"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004846
Detlev Zundel2c051652006-09-01 15:39:02 +02004847Source files originating from a different project (for example the
4848MTD subsystem) are generally exempt from these guidelines and are not
4849reformated to ease subsequent migration to newer versions of those
4850sources.
4851
4852Please note that U-Boot is implemented in C (and to some small parts in
4853Assembler); no C++ is used, so please do not use C++ style comments (//)
4854in your code.
wdenk2729af92004-05-03 20:45:30 +00004855
4856Please also stick to the following formatting rules:
4857- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004858- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004859- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004860- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004861- do not add trailing empty lines to source files
4862
4863Submissions which do not conform to the standards may be returned
4864with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004865
4866
wdenk2729af92004-05-03 20:45:30 +00004867Submitting Patches:
4868-------------------
wdenkc6097192002-11-03 00:24:07 +00004869
wdenk2729af92004-05-03 20:45:30 +00004870Since the number of patches for U-Boot is growing, we need to
4871establish some rules. Submissions which do not conform to these rules
4872may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004873
Magnus Lilja0d28f342008-08-06 19:32:33 +02004874Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004875
Wolfgang Denk06682362008-12-30 22:56:11 +01004876Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4877see http://lists.denx.de/mailman/listinfo/u-boot
4878
wdenk2729af92004-05-03 20:45:30 +00004879When you send a patch, please include the following information with
4880it:
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk2729af92004-05-03 20:45:30 +00004882* For bug fixes: a description of the bug and how your patch fixes
4883 this bug. Please try to include a way of demonstrating that the
4884 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk2729af92004-05-03 20:45:30 +00004886* For new features: a description of the feature and your
4887 implementation.
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk2729af92004-05-03 20:45:30 +00004889* A CHANGELOG entry as plaintext (separate from the patch)
4890
4891* For major contributions, your entry to the CREDITS file
4892
4893* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004894 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004895
4896* If your patch adds new configuration options, don't forget to
4897 document these in the README file.
4898
Wolfgang Denk218ca722008-03-26 10:40:12 +01004899* The patch itself. If you are using git (which is *strongly*
4900 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004901 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004902 the U-Boot mailing list, you will avoid most of the common problems
4903 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004904
Wolfgang Denk218ca722008-03-26 10:40:12 +01004905 If you cannot use git, use "diff -purN OLD NEW". If your version of
4906 diff does not support these options, then get the latest version of
4907 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004908
Wolfgang Denk218ca722008-03-26 10:40:12 +01004909 The current directory when running this command shall be the parent
4910 directory of the U-Boot source tree (i. e. please make sure that
4911 your patch includes sufficient directory information for the
4912 affected files).
4913
4914 We prefer patches as plain text. MIME attachments are discouraged,
4915 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004916
4917* If one logical set of modifications affects or creates several
4918 files, all these changes shall be submitted in a SINGLE patch file.
4919
4920* Changesets that contain different, unrelated modifications shall be
4921 submitted as SEPARATE patches, one patch per changeset.
4922
4923
4924Notes:
4925
4926* Before sending the patch, run the MAKEALL script on your patched
4927 source tree and make sure that no errors or warnings are reported
4928 for any of the boards.
4929
4930* Keep your modifications to the necessary minimum: A patch
4931 containing several unrelated changes or arbitrary reformats will be
4932 returned with a request to re-formatting / split it.
4933
4934* If you modify existing code, make sure that your new code does not
4935 add to the memory footprint of the code ;-) Small is beautiful!
4936 When adding new features, these should compile conditionally only
4937 (using #ifdef), and the resulting code with the new feature
4938 disabled must not need more memory than the old code without your
4939 modification.
wdenk90dc6702005-05-03 14:12:25 +00004940
Wolfgang Denk06682362008-12-30 22:56:11 +01004941* Remember that there is a size limit of 100 kB per message on the
4942 u-boot mailing list. Bigger patches will be moderated. If they are
4943 reasonable and not too big, they will be acknowledged. But patches
4944 bigger than the size limit should be avoided.