blob: 110eac6f16131a7cc54c14db9f47f5acd9a63292 [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
Sonny Rao046a37b2011-11-02 09:52:08 +0000647- Safe printf() functions
648 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
649 the printf() functions. These are defined in
650 include/vsprintf.h and include snprintf(), vsnprintf() and
651 so on. Code size increase is approximately 300-500 bytes.
652 If this option is not given then these functions will
653 silently discard their buffer size argument - this means
654 you are not getting any overflow checking in this case.
655
wdenkc6097192002-11-03 00:24:07 +0000656- Boot Delay: CONFIG_BOOTDELAY - in seconds
657 Delay before automatically booting the default image;
658 set to -1 to disable autoboot.
659
660 See doc/README.autoboot for these options that
661 work with CONFIG_BOOTDELAY. None are required.
662 CONFIG_BOOT_RETRY_TIME
663 CONFIG_BOOT_RETRY_MIN
664 CONFIG_AUTOBOOT_KEYED
665 CONFIG_AUTOBOOT_PROMPT
666 CONFIG_AUTOBOOT_DELAY_STR
667 CONFIG_AUTOBOOT_STOP_STR
668 CONFIG_AUTOBOOT_DELAY_STR2
669 CONFIG_AUTOBOOT_STOP_STR2
670 CONFIG_ZERO_BOOTDELAY_CHECK
671 CONFIG_RESET_TO_RETRY
672
673- Autoboot Command:
674 CONFIG_BOOTCOMMAND
675 Only needed when CONFIG_BOOTDELAY is enabled;
676 define a command string that is automatically executed
677 when no character is read on the console interface
678 within "Boot Delay" after reset.
679
680 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000681 This can be used to pass arguments to the bootm
682 command. The value of CONFIG_BOOTARGS goes into the
683 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000684
685 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000686 The value of these goes into the environment as
687 "ramboot" and "nfsboot" respectively, and can be used
688 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200689 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000690
691- Pre-Boot Commands:
692 CONFIG_PREBOOT
693
694 When this option is #defined, the existence of the
695 environment variable "preboot" will be checked
696 immediately before starting the CONFIG_BOOTDELAY
697 countdown and/or running the auto-boot command resp.
698 entering interactive mode.
699
700 This feature is especially useful when "preboot" is
701 automatically generated or modified. For an example
702 see the LWMON board specific code: here "preboot" is
703 modified when the user holds down a certain
704 combination of keys on the (special) keyboard when
705 booting the systems
706
707- Serial Download Echo Mode:
708 CONFIG_LOADS_ECHO
709 If defined to 1, all characters received during a
710 serial download (using the "loads" command) are
711 echoed back. This might be needed by some terminal
712 emulations (like "cu"), but may as well just take
713 time on others. This setting #define's the initial
714 value of the "loads_echo" environment variable.
715
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500716- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000717 CONFIG_KGDB_BAUDRATE
718 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200719 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000720
721- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500722 Monitor commands can be included or excluded
723 from the build by using the #include files
724 "config_cmd_all.h" and #undef'ing unwanted
725 commands, or using "config_cmd_default.h"
726 and augmenting with additional #define's
727 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000728
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500729 The default command configuration includes all commands
730 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000731
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500732 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500733 CONFIG_CMD_BDI bdinfo
734 CONFIG_CMD_BEDBUG * Include BedBug Debugger
735 CONFIG_CMD_BMP * BMP support
736 CONFIG_CMD_BSP * Board specific commands
737 CONFIG_CMD_BOOTD bootd
738 CONFIG_CMD_CACHE * icache, dcache
739 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500740 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500741 CONFIG_CMD_DATE * support for RTC, date/time...
742 CONFIG_CMD_DHCP * DHCP support
743 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600744 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
745 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
746 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
747 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500748 CONFIG_CMD_DTT * Digital Therm and Thermostat
749 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500750 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500751 CONFIG_CMD_EEPROM * EEPROM read/write support
752 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500753 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500754 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500755 CONFIG_CMD_FDC * Floppy Disk Support
756 CONFIG_CMD_FAT * FAT partition support
757 CONFIG_CMD_FDOS * Dos diskette Support
758 CONFIG_CMD_FLASH flinfo, erase, protect
759 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500760 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000761 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500762 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
763 CONFIG_CMD_I2C * I2C serial bus support
764 CONFIG_CMD_IDE * IDE harddisk support
765 CONFIG_CMD_IMI iminfo
766 CONFIG_CMD_IMLS List all found images
767 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500768 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500769 CONFIG_CMD_IRQ * irqinfo
770 CONFIG_CMD_ITEST Integer/string test of 2 values
771 CONFIG_CMD_JFFS2 * JFFS2 Support
772 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500773 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500774 CONFIG_CMD_LOADB loadb
775 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400776 CONFIG_CMD_MD5SUM print md5 message digest
777 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500778 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
779 loop, loopw, mtest
780 CONFIG_CMD_MISC Misc functions like sleep etc
781 CONFIG_CMD_MMC * MMC memory mapped support
782 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100783 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500784 CONFIG_CMD_NAND * NAND support
785 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600786 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000787 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500788 CONFIG_CMD_PCI * pciinfo
789 CONFIG_CMD_PCMCIA * PCMCIA support
790 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
791 host
792 CONFIG_CMD_PORTIO * Port I/O
793 CONFIG_CMD_REGINFO * Register dump
794 CONFIG_CMD_RUN run command in env variable
795 CONFIG_CMD_SAVES * save S record dump
796 CONFIG_CMD_SCSI * SCSI Support
797 CONFIG_CMD_SDRAM * print SDRAM configuration information
798 (requires CONFIG_CMD_I2C)
799 CONFIG_CMD_SETGETDCR Support for DCR Register access
800 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700801 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100802 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400803 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200804 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500805 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000806 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000807 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000808 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500809 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500810 CONFIG_CMD_CDP * Cisco Discover Protocol support
811 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000812
wdenkc6097192002-11-03 00:24:07 +0000813
814 EXAMPLE: If you want all functions except of network
815 support you can write:
816
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500817 #include "config_cmd_all.h"
818 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000819
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400820 Other Commands:
821 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000822
823 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500824 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000825 what you (and your U-Boot users) are doing. Data
826 cache cannot be enabled on systems like the 8xx or
827 8260 (where accesses to the IMMR region must be
828 uncached), and it cannot be disabled on all other
829 systems where we (mis-) use the data cache to hold an
830 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000831
832
833 XXX - this list needs to get updated!
834
Simon Glass45ba8072011-10-15 05:48:20 +0000835- Device tree:
836 CONFIG_OF_CONTROL
837 If this variable is defined, U-Boot will use a device tree
838 to configure its devices, instead of relying on statically
839 compiled #defines in the board file. This option is
840 experimental and only available on a few boards. The device
841 tree is available in the global data as gd->fdt_blob.
842
Simon Glass2c0f79e2011-10-24 19:15:31 +0000843 U-Boot needs to get its device tree from somewhere. This can
844 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000845
846 CONFIG_OF_EMBED
847 If this variable is defined, U-Boot will embed a device tree
848 binary in its image. This device tree file should be in the
849 board directory and called <soc>-<board>.dts. The binary file
850 is then picked up in board_init_f() and made available through
851 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000852
Simon Glass2c0f79e2011-10-24 19:15:31 +0000853 CONFIG_OF_SEPARATE
854 If this variable is defined, U-Boot will build a device tree
855 binary. It will be called u-boot.dtb. Architecture-specific
856 code will locate it at run-time. Generally this works by:
857
858 cat u-boot.bin u-boot.dtb >image.bin
859
860 and in fact, U-Boot does this for you, creating a file called
861 u-boot-dtb.bin which is useful in the common case. You can
862 still use the individual files if you need something more
863 exotic.
864
wdenkc6097192002-11-03 00:24:07 +0000865- Watchdog:
866 CONFIG_WATCHDOG
867 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000868 support for the SoC. There must be support in the SoC
869 specific code for a watchdog. For the 8xx and 8260
870 CPUs, the SIU Watchdog feature is enabled in the SYPCR
871 register. When supported for a specific SoC is
872 available, then no further board specific code should
873 be needed to use it.
874
875 CONFIG_HW_WATCHDOG
876 When using a watchdog circuitry external to the used
877 SoC, then define this variable and provide board
878 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000879
stroesec1551ea2003-04-04 15:53:41 +0000880- U-Boot Version:
881 CONFIG_VERSION_VARIABLE
882 If this variable is defined, an environment variable
883 named "ver" is created by U-Boot showing the U-Boot
884 version as printed by the "version" command.
885 This variable is readonly.
886
wdenkc6097192002-11-03 00:24:07 +0000887- Real-Time Clock:
888
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500889 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000890 has to be selected, too. Define exactly one of the
891 following options:
892
893 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
894 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000895 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000896 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000897 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000898 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000899 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000900 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100901 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000902 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200903 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200904 CONFIG_SYS_RV3029_TCR - enable trickle charger on
905 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000906
wdenkb37c7e52003-06-30 16:24:52 +0000907 Note that if the RTC uses I2C, then the I2C interface
908 must also be configured. See I2C Support, below.
909
Peter Tysere92739d2008-12-17 16:36:21 -0600910- GPIO Support:
911 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
912 CONFIG_PCA953X_INFO - enable pca953x info command
913
Chris Packham5dec49c2010-12-19 10:12:13 +0000914 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
915 chip-ngpio pairs that tell the PCA953X driver the number of
916 pins supported by a particular chip.
917
Peter Tysere92739d2008-12-17 16:36:21 -0600918 Note that if the GPIO device uses I2C, then the I2C interface
919 must also be configured. See I2C Support, below.
920
wdenkc6097192002-11-03 00:24:07 +0000921- Timestamp Support:
922
wdenk43d96162003-03-06 00:02:04 +0000923 When CONFIG_TIMESTAMP is selected, the timestamp
924 (date and time) of an image is printed by image
925 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500926 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000927
928- Partition Support:
929 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400930 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000931
Wolfgang Denk218ca722008-03-26 10:40:12 +0100932 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
933 CONFIG_CMD_SCSI) you must configure support for at
934 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000935
936- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000937 CONFIG_IDE_RESET_ROUTINE - this is defined in several
938 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000939
wdenk4d13cba2004-03-14 14:09:05 +0000940 CONFIG_IDE_RESET - is this is defined, IDE Reset will
941 be performed by calling the function
942 ide_set_reset(int reset)
943 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000944
945- ATAPI Support:
946 CONFIG_ATAPI
947
948 Set this to enable ATAPI support.
949
wdenkc40b2952004-03-13 23:29:43 +0000950- LBA48 Support
951 CONFIG_LBA48
952
953 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100954 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000955 Whithout these , LBA48 support uses 32bit variables and will 'only'
956 support disks up to 2.1TB.
957
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200958 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000959 When enabled, makes the IDE subsystem use 64bit sector addresses.
960 Default is 32bit.
961
wdenkc6097192002-11-03 00:24:07 +0000962- SCSI Support:
963 At the moment only there is only support for the
964 SYM53C8XX SCSI controller; define
965 CONFIG_SCSI_SYM53C8XX to enable it.
966
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200967 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
968 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
969 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000970 maximum numbers of LUNs, SCSI ID's and target
971 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200972 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000973
974- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000975 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000976 Support for Intel 8254x/8257x gigabit chips.
977
978 CONFIG_E1000_SPI
979 Utility code for direct access to the SPI bus on Intel 8257x.
980 This does not do anything useful unless you set at least one
981 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
982
983 CONFIG_E1000_SPI_GENERIC
984 Allow generic access to the SPI bus on the Intel 8257x, for
985 example with the "sspi" command.
986
987 CONFIG_CMD_E1000
988 Management command for E1000 devices. When used on devices
989 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +0000990
Andre Schwarzac3315c2008-03-06 16:45:44 +0100991 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200992 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100993
wdenkc6097192002-11-03 00:24:07 +0000994 CONFIG_EEPRO100
995 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200996 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000997 write routine for first time initialisation.
998
999 CONFIG_TULIP
1000 Support for Digital 2114x chips.
1001 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1002 modem chip initialisation (KS8761/QS6611).
1003
1004 CONFIG_NATSEMI
1005 Support for National dp83815 chips.
1006
1007 CONFIG_NS8382X
1008 Support for National dp8382[01] gigabit chips.
1009
wdenk45219c42003-05-12 21:50:16 +00001010- NETWORK Support (other):
1011
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001012 CONFIG_DRIVER_AT91EMAC
1013 Support for AT91RM9200 EMAC.
1014
1015 CONFIG_RMII
1016 Define this to use reduced MII inteface
1017
1018 CONFIG_DRIVER_AT91EMAC_QUIET
1019 If this defined, the driver is quiet.
1020 The driver doen't show link status messages.
1021
Rob Herringefdd7312011-12-15 11:15:49 +00001022 CONFIG_CALXEDA_XGMAC
1023 Support for the Calxeda XGMAC device
1024
wdenk45219c42003-05-12 21:50:16 +00001025 CONFIG_DRIVER_LAN91C96
1026 Support for SMSC's LAN91C96 chips.
1027
1028 CONFIG_LAN91C96_BASE
1029 Define this to hold the physical address
1030 of the LAN91C96's I/O space
1031
1032 CONFIG_LAN91C96_USE_32_BIT
1033 Define this to enable 32 bit addressing
1034
wdenkf39748a2004-06-09 13:37:52 +00001035 CONFIG_DRIVER_SMC91111
1036 Support for SMSC's LAN91C111 chip
1037
1038 CONFIG_SMC91111_BASE
1039 Define this to hold the physical address
1040 of the device (I/O space)
1041
1042 CONFIG_SMC_USE_32_BIT
1043 Define this if data bus is 32 bits
1044
1045 CONFIG_SMC_USE_IOFUNCS
1046 Define this to use i/o functions instead of macros
1047 (some hardware wont work with macros)
1048
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001049 CONFIG_DRIVER_TI_EMAC
1050 Support for davinci emac
1051
1052 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1053 Define this if you have more then 3 PHYs.
1054
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001055 CONFIG_FTGMAC100
1056 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1057
1058 CONFIG_FTGMAC100_EGIGA
1059 Define this to use GE link update with gigabit PHY.
1060 Define this if FTGMAC100 is connected to gigabit PHY.
1061 If your system has 10/100 PHY only, it might not occur
1062 wrong behavior. Because PHY usually return timeout or
1063 useless data when polling gigabit status and gigabit
1064 control registers. This behavior won't affect the
1065 correctnessof 10/100 link speed update.
1066
Mike Rapoportc2fff332009-11-11 10:03:03 +02001067 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001068 Support for SMSC's LAN911x and LAN921x chips
1069
Mike Rapoportc2fff332009-11-11 10:03:03 +02001070 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001071 Define this to hold the physical address
1072 of the device (I/O space)
1073
Mike Rapoportc2fff332009-11-11 10:03:03 +02001074 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001075 Define this if data bus is 32 bits
1076
Mike Rapoportc2fff332009-11-11 10:03:03 +02001077 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001078 Define this if data bus is 16 bits. If your processor
1079 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001080 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001081
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001082 CONFIG_SH_ETHER
1083 Support for Renesas on-chip Ethernet controller
1084
1085 CONFIG_SH_ETHER_USE_PORT
1086 Define the number of ports to be used
1087
1088 CONFIG_SH_ETHER_PHY_ADDR
1089 Define the ETH PHY's address
1090
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001091 CONFIG_SH_ETHER_CACHE_WRITEBACK
1092 If this option is set, the driver enables cache flush.
1093
Vadim Bendebury5e124722011-10-17 08:36:14 +00001094- TPM Support:
1095 CONFIG_GENERIC_LPC_TPM
1096 Support for generic parallel port TPM devices. Only one device
1097 per system is supported at this time.
1098
1099 CONFIG_TPM_TIS_BASE_ADDRESS
1100 Base address where the generic TPM device is mapped
1101 to. Contemporary x86 systems usually map it at
1102 0xfed40000.
1103
wdenkc6097192002-11-03 00:24:07 +00001104- USB Support:
1105 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001106 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001107 CONFIG_USB_UHCI to enable it.
1108 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001109 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001110 storage devices.
1111 Note:
1112 Supported are USB Keyboards and USB Floppy drives
1113 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001114 MPC5200 USB requires additional defines:
1115 CONFIG_USB_CLOCK
1116 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001117 CONFIG_PSC3_USB
1118 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001119 CONFIG_USB_CONFIG
1120 for differential drivers: 0x00001000
1121 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001122 for differential drivers on PSC3: 0x00000100
1123 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001124 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001125 May be defined to allow interrupt polling
1126 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001127
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001128- USB Device:
1129 Define the below if you wish to use the USB console.
1130 Once firmware is rebuilt from a serial console issue the
1131 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001132 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001133 it has found a new device. The environment variable usbtty
1134 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001135 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001136 Common Device Class Abstract Control Model serial device.
1137 If you select usbtty = gserial you should be able to enumerate
1138 a Linux host by
1139 # modprobe usbserial vendor=0xVendorID product=0xProductID
1140 else if using cdc_acm, simply setting the environment
1141 variable usbtty to be cdc_acm should suffice. The following
1142 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001143
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001144 CONFIG_USB_DEVICE
1145 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001146
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001147 CONFIG_USB_TTY
1148 Define this to have a tty type of device available to
1149 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001150
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001151 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001152 Define this if you want stdin, stdout &/or stderr to
1153 be set to usbtty.
1154
1155 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001156 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001157 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001158 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001159
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001160 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001161 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001162 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001163
Wolfgang Denk386eda02006-06-14 18:14:56 +02001164 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001165 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001166 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001167 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1168 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1169 should pretend to be a Linux device to it's target host.
1170
1171 CONFIG_USBD_MANUFACTURER
1172 Define this string as the name of your company for
1173 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001174
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001175 CONFIG_USBD_PRODUCT_NAME
1176 Define this string as the name of your product
1177 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1178
1179 CONFIG_USBD_VENDORID
1180 Define this as your assigned Vendor ID from the USB
1181 Implementors Forum. This *must* be a genuine Vendor ID
1182 to avoid polluting the USB namespace.
1183 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001184
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001185 CONFIG_USBD_PRODUCTID
1186 Define this as the unique Product ID
1187 for your device
1188 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001189
Igor Grinbergd70a5602011-12-12 12:08:35 +02001190- ULPI Layer Support:
1191 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1192 the generic ULPI layer. The generic layer accesses the ULPI PHY
1193 via the platform viewport, so you need both the genric layer and
1194 the viewport enabled. Currently only Chipidea/ARC based
1195 viewport is supported.
1196 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1197 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
wdenkc6097192002-11-03 00:24:07 +00001198
1199- MMC Support:
1200 The MMC controller on the Intel PXA is supported. To
1201 enable this define CONFIG_MMC. The MMC can be
1202 accessed from the boot prompt by mapping the device
1203 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001204 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1205 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001206
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001207 CONFIG_SH_MMCIF
1208 Support for Renesas on-chip MMCIF controller
1209
1210 CONFIG_SH_MMCIF_ADDR
1211 Define the base address of MMCIF registers
1212
1213 CONFIG_SH_MMCIF_CLK
1214 Define the clock frequency for MMCIF
1215
wdenk6705d812004-08-02 23:22:59 +00001216- Journaling Flash filesystem support:
1217 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1218 CONFIG_JFFS2_NAND_DEV
1219 Define these for a default partition on a NAND device
1220
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001221 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1222 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001223 Define these for a default partition on a NOR device
1224
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001225 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001226 Define this to create an own partition. You have to provide a
1227 function struct part_info* jffs2_part_info(int part_num)
1228
1229 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001230 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001231 to disable the command chpart. This is the default when you
1232 have not defined a custom partition
1233
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001234- FAT(File Allocation Table) filesystem write function support:
1235 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001236
1237 Define this to enable support for saving memory data as a
1238 file in FAT formatted partition.
1239
1240 This will also enable the command "fatwrite" enabling the
1241 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001242
wdenkc6097192002-11-03 00:24:07 +00001243- Keyboard Support:
1244 CONFIG_ISA_KEYBOARD
1245
1246 Define this to enable standard (PC-Style) keyboard
1247 support
1248
1249 CONFIG_I8042_KBD
1250 Standard PC keyboard driver with US (is default) and
1251 GERMAN key layout (switch via environment 'keymap=de') support.
1252 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1253 for cfb_console. Supports cursor blinking.
1254
1255- Video support:
1256 CONFIG_VIDEO
1257
1258 Define this to enable video support (for output to
1259 video).
1260
1261 CONFIG_VIDEO_CT69000
1262
1263 Enable Chips & Technologies 69000 Video chip
1264
1265 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001266 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001267 video output is selected via environment 'videoout'
1268 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1269 assumed.
wdenkc6097192002-11-03 00:24:07 +00001270
wdenkb79a11c2004-03-25 15:14:43 +00001271 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001272 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001273 are possible:
1274 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001275 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001276
1277 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1278 -------------+---------------------------------------------
1279 8 bits | 0x301* 0x303 0x305 0x161 0x307
1280 15 bits | 0x310 0x313 0x316 0x162 0x319
1281 16 bits | 0x311 0x314 0x317 0x163 0x31A
1282 24 bits | 0x312 0x315 0x318 ? 0x31B
1283 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001284 (i.e. setenv videomode 317; saveenv; reset;)
1285
wdenkb79a11c2004-03-25 15:14:43 +00001286 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001287 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001288
1289
stroesec1551ea2003-04-04 15:53:41 +00001290 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001291 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001292 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1293 or CONFIG_VIDEO_SED13806_16BPP
1294
Timur Tabi7d3053f2011-02-15 17:09:19 -06001295 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001296 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001297 SOCs that have a DIU should define this macro to enable DIU
1298 support, and should also define these other macros:
1299
1300 CONFIG_SYS_DIU_ADDR
1301 CONFIG_VIDEO
1302 CONFIG_CMD_BMP
1303 CONFIG_CFB_CONSOLE
1304 CONFIG_VIDEO_SW_CURSOR
1305 CONFIG_VGA_AS_SINGLE_DEVICE
1306 CONFIG_VIDEO_LOGO
1307 CONFIG_VIDEO_BMP_LOGO
1308
Timur Tabiba8e76b2011-04-11 14:18:22 -05001309 The DIU driver will look for the 'video-mode' environment
1310 variable, and if defined, enable the DIU as a console during
1311 boot. See the documentation file README.video for a
1312 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001313
wdenk682011f2003-06-03 23:54:09 +00001314- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001315 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001316
wdenk8bde7f72003-06-27 21:31:46 +00001317 Define this to enable a custom keyboard support.
1318 This simply calls drv_keyboard_init() which must be
1319 defined in your board-specific files.
1320 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001321
wdenkc6097192002-11-03 00:24:07 +00001322- LCD Support: CONFIG_LCD
1323
1324 Define this to enable LCD support (for output to LCD
1325 display); also select one of the supported displays
1326 by defining one of these:
1327
Stelian Pop39cf4802008-05-09 21:57:18 +02001328 CONFIG_ATMEL_LCD:
1329
1330 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1331
wdenkfd3103b2003-11-25 16:55:19 +00001332 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001333
wdenkfd3103b2003-11-25 16:55:19 +00001334 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001335
wdenkfd3103b2003-11-25 16:55:19 +00001336 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001337
wdenkfd3103b2003-11-25 16:55:19 +00001338 NEC NL6448BC20-08. 6.5", 640x480.
1339 Active, color, single scan.
1340
1341 CONFIG_NEC_NL6448BC33_54
1342
1343 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001344 Active, color, single scan.
1345
1346 CONFIG_SHARP_16x9
1347
1348 Sharp 320x240. Active, color, single scan.
1349 It isn't 16x9, and I am not sure what it is.
1350
1351 CONFIG_SHARP_LQ64D341
1352
1353 Sharp LQ64D341 display, 640x480.
1354 Active, color, single scan.
1355
1356 CONFIG_HLD1045
1357
1358 HLD1045 display, 640x480.
1359 Active, color, single scan.
1360
1361 CONFIG_OPTREX_BW
1362
1363 Optrex CBL50840-2 NF-FW 99 22 M5
1364 or
1365 Hitachi LMG6912RPFC-00T
1366 or
1367 Hitachi SP14Q002
1368
1369 320x240. Black & white.
1370
1371 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001372 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001373
wdenk7152b1d2003-09-05 23:19:14 +00001374- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001375
wdenk8bde7f72003-06-27 21:31:46 +00001376 If this option is set, the environment is checked for
1377 a variable "splashimage". If found, the usual display
1378 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001379 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001380 specified in "splashimage" is loaded instead. The
1381 console is redirected to the "nulldev", too. This
1382 allows for a "silent" boot where a splash screen is
1383 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001384
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001385 CONFIG_SPLASH_SCREEN_ALIGN
1386
1387 If this option is set the splash image can be freely positioned
1388 on the screen. Environment variable "splashpos" specifies the
1389 position as "x,y". If a positive number is given it is used as
1390 number of pixel from left/top. If a negative number is given it
1391 is used as number of pixel from right/bottom. You can also
1392 specify 'm' for centering the image.
1393
1394 Example:
1395 setenv splashpos m,m
1396 => image at center of screen
1397
1398 setenv splashpos 30,20
1399 => image at x = 30 and y = 20
1400
1401 setenv splashpos -10,m
1402 => vertically centered image
1403 at x = dspWidth - bmpWidth - 9
1404
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001405- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1406
1407 If this option is set, additionally to standard BMP
1408 images, gzipped BMP images can be displayed via the
1409 splashscreen support or the bmp command.
1410
Anatolij Gustschind5011762010-03-15 14:50:25 +01001411- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1412
1413 If this option is set, 8-bit RLE compressed BMP images
1414 can be displayed via the splashscreen support or the
1415 bmp command.
1416
wdenkc29fdfc2003-08-29 20:57:53 +00001417- Compression support:
1418 CONFIG_BZIP2
1419
1420 If this option is set, support for bzip2 compressed
1421 images is included. If not, only uncompressed and gzip
1422 compressed images are supported.
1423
wdenk42d1f032003-10-15 23:53:47 +00001424 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001425 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001426 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001427
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001428 CONFIG_LZMA
1429
1430 If this option is set, support for lzma compressed
1431 images is included.
1432
1433 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1434 requires an amount of dynamic memory that is given by the
1435 formula:
1436
1437 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1438
1439 Where lc and lp stand for, respectively, Literal context bits
1440 and Literal pos bits.
1441
1442 This value is upper-bounded by 14MB in the worst case. Anyway,
1443 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1444 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1445 a very small buffer.
1446
1447 Use the lzmainfo tool to determinate the lc and lp values and
1448 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001449 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001450
wdenk17ea1172004-06-06 21:51:03 +00001451- MII/PHY support:
1452 CONFIG_PHY_ADDR
1453
1454 The address of PHY on MII bus.
1455
1456 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1457
1458 The clock frequency of the MII bus
1459
1460 CONFIG_PHY_GIGE
1461
1462 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001463 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001464
1465 CONFIG_PHY_RESET_DELAY
1466
1467 Some PHY like Intel LXT971A need extra delay after
1468 reset before any MII register access is possible.
1469 For such PHY, set this option to the usec delay
1470 required. (minimum 300usec for LXT971A)
1471
1472 CONFIG_PHY_CMD_DELAY (ppc4xx)
1473
1474 Some PHY like Intel LXT971A need extra delay after
1475 command issued before MII status register can be read
1476
wdenkc6097192002-11-03 00:24:07 +00001477- Ethernet address:
1478 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001479 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001480 CONFIG_ETH2ADDR
1481 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001482 CONFIG_ETH4ADDR
1483 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001484
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001485 Define a default value for Ethernet address to use
1486 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001487 is not determined automatically.
1488
1489- IP address:
1490 CONFIG_IPADDR
1491
1492 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001493 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001494 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001495 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001496
1497- Server IP address:
1498 CONFIG_SERVERIP
1499
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001500 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001501 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001502 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001503
Robin Getz97cfe862009-07-21 12:15:28 -04001504 CONFIG_KEEP_SERVERADDR
1505
1506 Keeps the server's MAC address, in the env 'serveraddr'
1507 for passing to bootargs (like Linux's netconsole option)
1508
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001509- Gateway IP address:
1510 CONFIG_GATEWAYIP
1511
1512 Defines a default value for the IP address of the
1513 default router where packets to other networks are
1514 sent to.
1515 (Environment variable "gatewayip")
1516
1517- Subnet mask:
1518 CONFIG_NETMASK
1519
1520 Defines a default value for the subnet mask (or
1521 routing prefix) which is used to determine if an IP
1522 address belongs to the local subnet or needs to be
1523 forwarded through a router.
1524 (Environment variable "netmask")
1525
David Updegraff53a5c422007-06-11 10:41:07 -05001526- Multicast TFTP Mode:
1527 CONFIG_MCAST_TFTP
1528
1529 Defines whether you want to support multicast TFTP as per
1530 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001531 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001532 driver in use must provide a function: mcast() to join/leave a
1533 multicast group.
1534
wdenkc6097192002-11-03 00:24:07 +00001535- BOOTP Recovery Mode:
1536 CONFIG_BOOTP_RANDOM_DELAY
1537
1538 If you have many targets in a network that try to
1539 boot using BOOTP, you may want to avoid that all
1540 systems send out BOOTP requests at precisely the same
1541 moment (which would happen for instance at recovery
1542 from a power failure, when all systems will try to
1543 boot, thus flooding the BOOTP server. Defining
1544 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1545 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001546 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001547
1548 1st BOOTP request: delay 0 ... 1 sec
1549 2nd BOOTP request: delay 0 ... 2 sec
1550 3rd BOOTP request: delay 0 ... 4 sec
1551 4th and following
1552 BOOTP requests: delay 0 ... 8 sec
1553
stroesefe389a82003-08-28 14:17:32 +00001554- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001555 You can fine tune the DHCP functionality by defining
1556 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001557
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001558 CONFIG_BOOTP_SUBNETMASK
1559 CONFIG_BOOTP_GATEWAY
1560 CONFIG_BOOTP_HOSTNAME
1561 CONFIG_BOOTP_NISDOMAIN
1562 CONFIG_BOOTP_BOOTPATH
1563 CONFIG_BOOTP_BOOTFILESIZE
1564 CONFIG_BOOTP_DNS
1565 CONFIG_BOOTP_DNS2
1566 CONFIG_BOOTP_SEND_HOSTNAME
1567 CONFIG_BOOTP_NTPSERVER
1568 CONFIG_BOOTP_TIMEOFFSET
1569 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001570
Wilson Callan5d110f02007-07-28 10:56:13 -04001571 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1572 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001573
1574 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1575 serverip from a DHCP server, it is possible that more
1576 than one DNS serverip is offered to the client.
1577 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1578 serverip will be stored in the additional environment
1579 variable "dnsip2". The first DNS serverip is always
1580 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001581 is defined.
stroesefe389a82003-08-28 14:17:32 +00001582
1583 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1584 to do a dynamic update of a DNS server. To do this, they
1585 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001586 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001587 of the "hostname" environment variable is passed as
1588 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001589
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001590 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1591
1592 A 32bit value in microseconds for a delay between
1593 receiving a "DHCP Offer" and sending the "DHCP Request".
1594 This fixes a problem with certain DHCP servers that don't
1595 respond 100% of the time to a "DHCP request". E.g. On an
1596 AT91RM9200 processor running at 180MHz, this delay needed
1597 to be *at least* 15,000 usec before a Windows Server 2003
1598 DHCP server would reply 100% of the time. I recommend at
1599 least 50,000 usec to be safe. The alternative is to hope
1600 that one of the retries will be successful but note that
1601 the DHCP timeout and retry process takes a longer than
1602 this delay.
1603
wdenka3d991b2004-04-15 21:48:45 +00001604 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001605 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001606
1607 The device id used in CDP trigger frames.
1608
1609 CONFIG_CDP_DEVICE_ID_PREFIX
1610
1611 A two character string which is prefixed to the MAC address
1612 of the device.
1613
1614 CONFIG_CDP_PORT_ID
1615
1616 A printf format string which contains the ascii name of
1617 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001618 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001619
1620 CONFIG_CDP_CAPABILITIES
1621
1622 A 32bit integer which indicates the device capabilities;
1623 0x00000010 for a normal host which does not forwards.
1624
1625 CONFIG_CDP_VERSION
1626
1627 An ascii string containing the version of the software.
1628
1629 CONFIG_CDP_PLATFORM
1630
1631 An ascii string containing the name of the platform.
1632
1633 CONFIG_CDP_TRIGGER
1634
1635 A 32bit integer sent on the trigger.
1636
1637 CONFIG_CDP_POWER_CONSUMPTION
1638
1639 A 16bit integer containing the power consumption of the
1640 device in .1 of milliwatts.
1641
1642 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1643
1644 A byte containing the id of the VLAN.
1645
wdenkc6097192002-11-03 00:24:07 +00001646- Status LED: CONFIG_STATUS_LED
1647
1648 Several configurations allow to display the current
1649 status using a LED. For instance, the LED will blink
1650 fast while running U-Boot code, stop blinking as
1651 soon as a reply to a BOOTP request was received, and
1652 start blinking slow once the Linux kernel is running
1653 (supported by a status LED driver in the Linux
1654 kernel). Defining CONFIG_STATUS_LED enables this
1655 feature in U-Boot.
1656
1657- CAN Support: CONFIG_CAN_DRIVER
1658
1659 Defining CONFIG_CAN_DRIVER enables CAN driver support
1660 on those systems that support this (optional)
1661 feature, like the TQM8xxL modules.
1662
1663- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1664
wdenkb37c7e52003-06-30 16:24:52 +00001665 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001666 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001667 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001668
wdenk945af8d2003-07-16 21:53:01 +00001669 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001670 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001671 CONFIG_COMMANDS) and communicate with i2c based realtime
1672 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001673 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001674
Ben Warrenbb99ad62006-09-07 16:50:54 -04001675 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001676
wdenk945af8d2003-07-16 21:53:01 +00001677 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001678 bit-banging) driver instead of CPM or similar hardware
1679 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001680
wdenk945af8d2003-07-16 21:53:01 +00001681 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001682 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001683
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001684 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001685 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001686 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001687 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001688
Peter Tyser8d321b82010-04-12 22:28:21 -05001689 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001690 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001691 and so its address should therefore be cleared to 0 (See,
1692 eg, MPC823e User's Manual p.16-473). So, set
1693 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001694
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001695 CONFIG_SYS_I2C_INIT_MPC5XXX
1696
1697 When a board is reset during an i2c bus transfer
1698 chips might think that the current transfer is still
1699 in progress. Reset the slave devices by sending start
1700 commands until the slave device responds.
1701
wdenk945af8d2003-07-16 21:53:01 +00001702 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001703
1704 If you use the software i2c interface (CONFIG_SOFT_I2C)
1705 then the following macros need to be defined (examples are
1706 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001707
1708 I2C_INIT
1709
wdenkb37c7e52003-06-30 16:24:52 +00001710 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001711 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001712
wdenkba56f622004-02-06 23:19:44 +00001713 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001714
wdenkc6097192002-11-03 00:24:07 +00001715 I2C_PORT
1716
wdenk43d96162003-03-06 00:02:04 +00001717 (Only for MPC8260 CPU). The I/O port to use (the code
1718 assumes both bits are on the same port). Valid values
1719 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001720
1721 I2C_ACTIVE
1722
1723 The code necessary to make the I2C data line active
1724 (driven). If the data line is open collector, this
1725 define can be null.
1726
wdenkb37c7e52003-06-30 16:24:52 +00001727 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1728
wdenkc6097192002-11-03 00:24:07 +00001729 I2C_TRISTATE
1730
1731 The code necessary to make the I2C data line tri-stated
1732 (inactive). If the data line is open collector, this
1733 define can be null.
1734
wdenkb37c7e52003-06-30 16:24:52 +00001735 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1736
wdenkc6097192002-11-03 00:24:07 +00001737 I2C_READ
1738
1739 Code that returns TRUE if the I2C data line is high,
1740 FALSE if it is low.
1741
wdenkb37c7e52003-06-30 16:24:52 +00001742 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1743
wdenkc6097192002-11-03 00:24:07 +00001744 I2C_SDA(bit)
1745
1746 If <bit> is TRUE, sets the I2C data line high. If it
1747 is FALSE, it clears it (low).
1748
wdenkb37c7e52003-06-30 16:24:52 +00001749 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001750 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001751 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001752
wdenkc6097192002-11-03 00:24:07 +00001753 I2C_SCL(bit)
1754
1755 If <bit> is TRUE, sets the I2C clock line high. If it
1756 is FALSE, it clears it (low).
1757
wdenkb37c7e52003-06-30 16:24:52 +00001758 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001759 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001760 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001761
wdenkc6097192002-11-03 00:24:07 +00001762 I2C_DELAY
1763
1764 This delay is invoked four times per clock cycle so this
1765 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001766 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001767 like:
1768
wdenkb37c7e52003-06-30 16:24:52 +00001769 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001770
Mike Frysinger793b5722010-07-21 13:38:02 -04001771 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1772
1773 If your arch supports the generic GPIO framework (asm/gpio.h),
1774 then you may alternatively define the two GPIOs that are to be
1775 used as SCL / SDA. Any of the previous I2C_xxx macros will
1776 have GPIO-based defaults assigned to them as appropriate.
1777
1778 You should define these to the GPIO value as given directly to
1779 the generic GPIO functions.
1780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001781 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001782
wdenk8bde7f72003-06-27 21:31:46 +00001783 When a board is reset during an i2c bus transfer
1784 chips might think that the current transfer is still
1785 in progress. On some boards it is possible to access
1786 the i2c SCLK line directly, either by using the
1787 processor pin as a GPIO or by having a second pin
1788 connected to the bus. If this option is defined a
1789 custom i2c_init_board() routine in boards/xxx/board.c
1790 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001791
Richard Retanubun26a33502010-04-12 15:08:17 -04001792 CONFIG_SYS_I2C_BOARD_LATE_INIT
1793
1794 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1795 defined a custom i2c_board_late_init() routine in
1796 boards/xxx/board.c is run AFTER the operations in i2c_init()
1797 is completed. This callpoint can be used to unreset i2c bus
1798 using CPU i2c controller register accesses for CPUs whose i2c
1799 controller provide such a method. It is called at the end of
1800 i2c_init() to allow i2c_init operations to setup the i2c bus
1801 controller on the CPU (e.g. setting bus speed & slave address).
1802
wdenk17ea1172004-06-06 21:51:03 +00001803 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1804
1805 This option enables configuration of bi_iic_fast[] flags
1806 in u-boot bd_info structure based on u-boot environment
1807 variable "i2cfast". (see also i2cfast)
1808
Ben Warrenbb99ad62006-09-07 16:50:54 -04001809 CONFIG_I2C_MULTI_BUS
1810
1811 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001812 must have a controller. At any point in time, only one bus is
1813 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001814 Note that bus numbering is zero-based.
1815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001816 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001817
1818 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001819 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001820 is set, specify a list of bus-device pairs. Otherwise, specify
1821 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001822
1823 e.g.
1824 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001825 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001826
1827 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1828
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001829 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001830 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001831
1832 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1833
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001834 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001835
1836 If defined, then this indicates the I2C bus number for DDR SPD.
1837 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1838
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001839 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001840
1841 If defined, then this indicates the I2C bus number for the RTC.
1842 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001844 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001845
1846 If defined, then this indicates the I2C bus number for the DTT.
1847 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1848
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001849 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001850
1851 If defined, specifies the I2C address of the DTT device.
1852 If not defined, then U-Boot uses predefined value for
1853 specified DTT device.
1854
Timur Tabibe5e6182006-11-03 19:15:00 -06001855 CONFIG_FSL_I2C
1856
1857 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001858 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001859
Heiko Schocher67b23a32008-10-15 09:39:47 +02001860 CONFIG_I2C_MUX
1861
1862 Define this option if you have I2C devices reached over 1 .. n
1863 I2C Muxes like the pca9544a. This option addes a new I2C
1864 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1865 new I2C Bus to the existing I2C Busses. If you select the
1866 new Bus with "i2c dev", u-bbot sends first the commandos for
1867 the muxes to activate this new "bus".
1868
1869 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1870 feature!
1871
1872 Example:
1873 Adding a new I2C Bus reached over 2 pca9544a muxes
1874 The First mux with address 70 and channel 6
1875 The Second mux with address 71 and channel 4
1876
1877 => i2c bus pca9544a:70:6:pca9544a:71:4
1878
1879 Use the "i2c bus" command without parameter, to get a list
1880 of I2C Busses with muxes:
1881
1882 => i2c bus
1883 Busses reached over muxes:
1884 Bus ID: 2
1885 reached over Mux(es):
1886 pca9544a@70 ch: 4
1887 Bus ID: 3
1888 reached over Mux(es):
1889 pca9544a@70 ch: 6
1890 pca9544a@71 ch: 4
1891 =>
1892
1893 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001894 u-boot first sends the command to the mux@70 to enable
1895 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001896 the channel 4.
1897
1898 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001899 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001900 the 2 muxes.
1901
1902 This option is actually implemented for the bitbanging
1903 algorithm in common/soft_i2c.c and for the Hardware I2C
1904 Bus on the MPC8260. But it should be not so difficult
1905 to add this option to other architectures.
1906
Andrew Dyer2ac69852008-12-29 17:36:01 -06001907 CONFIG_SOFT_I2C_READ_REPEATED_START
1908
1909 defining this will force the i2c_read() function in
1910 the soft_i2c driver to perform an I2C repeated start
1911 between writing the address pointer and reading the
1912 data. If this define is omitted the default behaviour
1913 of doing a stop-start sequence will be used. Most I2C
1914 devices can use either method, but some require one or
1915 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001916
wdenkc6097192002-11-03 00:24:07 +00001917- SPI Support: CONFIG_SPI
1918
1919 Enables SPI driver (so far only tested with
1920 SPI EEPROM, also an instance works with Crystal A/D and
1921 D/As on the SACSng board)
1922
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001923 CONFIG_SH_SPI
1924
1925 Enables the driver for SPI controller on SuperH. Currently
1926 only SH7757 is supported.
1927
wdenkc6097192002-11-03 00:24:07 +00001928 CONFIG_SPI_X
1929
1930 Enables extended (16-bit) SPI EEPROM addressing.
1931 (symmetrical to CONFIG_I2C_X)
1932
1933 CONFIG_SOFT_SPI
1934
wdenk43d96162003-03-06 00:02:04 +00001935 Enables a software (bit-bang) SPI driver rather than
1936 using hardware support. This is a general purpose
1937 driver that only requires three general I/O port pins
1938 (two outputs, one input) to function. If this is
1939 defined, the board configuration must define several
1940 SPI configuration items (port pins to use, etc). For
1941 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001942
Ben Warren04a9e112008-01-16 22:37:35 -05001943 CONFIG_HARD_SPI
1944
1945 Enables a hardware SPI driver for general-purpose reads
1946 and writes. As with CONFIG_SOFT_SPI, the board configuration
1947 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001948 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05001949 example, see include/configs/mpc8349emds.h.
1950
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001951 CONFIG_MXC_SPI
1952
1953 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00001954 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001955
Matthias Fuchs01335022007-12-27 17:12:34 +01001956- FPGA Support: CONFIG_FPGA
1957
1958 Enables FPGA subsystem.
1959
1960 CONFIG_FPGA_<vendor>
1961
1962 Enables support for specific chip vendors.
1963 (ALTERA, XILINX)
1964
1965 CONFIG_FPGA_<family>
1966
1967 Enables support for FPGA family.
1968 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1969
1970 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001971
wdenk43d96162003-03-06 00:02:04 +00001972 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001973
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001974 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001975
wdenk8bde7f72003-06-27 21:31:46 +00001976 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001977
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001978 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001979
wdenk43d96162003-03-06 00:02:04 +00001980 Enable checks on FPGA configuration interface busy
1981 status by the configuration function. This option
1982 will require a board or device specific function to
1983 be written.
wdenkc6097192002-11-03 00:24:07 +00001984
1985 CONFIG_FPGA_DELAY
1986
1987 If defined, a function that provides delays in the FPGA
1988 configuration driver.
1989
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001990 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001991 Allow Control-C to interrupt FPGA configuration
1992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001993 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001994
wdenk43d96162003-03-06 00:02:04 +00001995 Check for configuration errors during FPGA bitfile
1996 loading. For example, abort during Virtex II
1997 configuration if the INIT_B line goes low (which
1998 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001999
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002000 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002001
wdenk43d96162003-03-06 00:02:04 +00002002 Maximum time to wait for the INIT_B line to deassert
2003 after PROB_B has been deasserted during a Virtex II
2004 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002005 ms.
wdenkc6097192002-11-03 00:24:07 +00002006
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002007 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002008
wdenk43d96162003-03-06 00:02:04 +00002009 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002010 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002011
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002012 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002013
wdenk43d96162003-03-06 00:02:04 +00002014 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002015 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002016
2017- Configuration Management:
2018 CONFIG_IDENT_STRING
2019
wdenk43d96162003-03-06 00:02:04 +00002020 If defined, this string will be added to the U-Boot
2021 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002022
2023- Vendor Parameter Protection:
2024
wdenk43d96162003-03-06 00:02:04 +00002025 U-Boot considers the values of the environment
2026 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002027 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002028 are set once by the board vendor / manufacturer, and
2029 protects these variables from casual modification by
2030 the user. Once set, these variables are read-only,
2031 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002032 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002033
2034 If CONFIG_ENV_OVERWRITE is #defined in your config
2035 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002036 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002037 these parameters.
2038
2039 Alternatively, if you #define _both_ CONFIG_ETHADDR
2040 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002041 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002042 which can be changed exactly ONCE by the user. [The
2043 serial# is unaffected by this, i. e. it remains
2044 read-only.]
2045
2046- Protected RAM:
2047 CONFIG_PRAM
2048
2049 Define this variable to enable the reservation of
2050 "protected RAM", i. e. RAM which is not overwritten
2051 by U-Boot. Define CONFIG_PRAM to hold the number of
2052 kB you want to reserve for pRAM. You can overwrite
2053 this default value by defining an environment
2054 variable "pram" to the number of kB you want to
2055 reserve. Note that the board info structure will
2056 still show the full amount of RAM. If pRAM is
2057 reserved, a new environment variable "mem" will
2058 automatically be defined to hold the amount of
2059 remaining RAM in a form that can be passed as boot
2060 argument to Linux, for instance like that:
2061
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002062 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002063 saveenv
2064
2065 This way you can tell Linux not to use this memory,
2066 either, which results in a memory region that will
2067 not be affected by reboots.
2068
2069 *WARNING* If your board configuration uses automatic
2070 detection of the RAM size, you must make sure that
2071 this memory test is non-destructive. So far, the
2072 following board configurations are known to be
2073 "pRAM-clean":
2074
2075 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2076 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002077 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002078
2079- Error Recovery:
2080 CONFIG_PANIC_HANG
2081
2082 Define this variable to stop the system in case of a
2083 fatal error, so that you have to reset it manually.
2084 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002085 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002086 automatically as fast as possible, but it may be
2087 useful during development since you can try to debug
2088 the conditions that lead to the situation.
2089
2090 CONFIG_NET_RETRY_COUNT
2091
wdenk43d96162003-03-06 00:02:04 +00002092 This variable defines the number of retries for
2093 network operations like ARP, RARP, TFTP, or BOOTP
2094 before giving up the operation. If not defined, a
2095 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002096
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002097 CONFIG_ARP_TIMEOUT
2098
2099 Timeout waiting for an ARP reply in milliseconds.
2100
wdenkc6097192002-11-03 00:24:07 +00002101- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002102 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002103
2104 Enable auto completion of commands using TAB.
2105
Wolfgang Denka9398e02006-11-27 15:32:42 +01002106 Note that this feature has NOT been implemented yet
2107 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002108
2109
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002110 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002111
2112 Define this variable to enable the "hush" shell (from
2113 Busybox) as command line interpreter, thus enabling
2114 powerful command line syntax like
2115 if...then...else...fi conditionals or `&&' and '||'
2116 constructs ("shell scripts").
2117
2118 If undefined, you get the old, much simpler behaviour
2119 with a somewhat smaller memory footprint.
2120
2121
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002122 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002123
2124 This defines the secondary prompt string, which is
2125 printed when the command interpreter needs more input
2126 to complete a command. Usually "> ".
2127
2128 Note:
2129
wdenk8bde7f72003-06-27 21:31:46 +00002130 In the current implementation, the local variables
2131 space and global environment variables space are
2132 separated. Local variables are those you define by
2133 simply typing `name=value'. To access a local
2134 variable later on, you have write `$name' or
2135 `${name}'; to execute the contents of a variable
2136 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002137
wdenk43d96162003-03-06 00:02:04 +00002138 Global environment variables are those you use
2139 setenv/printenv to work with. To run a command stored
2140 in such a variable, you need to use the run command,
2141 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002142
2143 To store commands and special characters in a
2144 variable, please use double quotation marks
2145 surrounding the whole text of the variable, instead
2146 of the backslashes before semicolons and special
2147 symbols.
2148
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002149- Commandline Editing and History:
2150 CONFIG_CMDLINE_EDITING
2151
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002152 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002153 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002154
wdenka8c7c702003-12-06 19:49:23 +00002155- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002156 CONFIG_EXTRA_ENV_SETTINGS
2157
wdenk43d96162003-03-06 00:02:04 +00002158 Define this to contain any number of null terminated
2159 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002160 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002161
wdenk43d96162003-03-06 00:02:04 +00002162 For example, place something like this in your
2163 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002164
2165 #define CONFIG_EXTRA_ENV_SETTINGS \
2166 "myvar1=value1\0" \
2167 "myvar2=value2\0"
2168
wdenk43d96162003-03-06 00:02:04 +00002169 Warning: This method is based on knowledge about the
2170 internal format how the environment is stored by the
2171 U-Boot code. This is NOT an official, exported
2172 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002173 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002174 You better know what you are doing here.
2175
wdenk43d96162003-03-06 00:02:04 +00002176 Note: overly (ab)use of the default environment is
2177 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002178 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002179 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002180
wdenka8c7c702003-12-06 19:49:23 +00002181- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002182 CONFIG_HAS_DATAFLASH
2183
wdenk8bde7f72003-06-27 21:31:46 +00002184 Defining this option enables DataFlash features and
2185 allows to read/write in Dataflash via the standard
2186 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002187
Eric Nelsonf61ec452012-01-31 10:52:08 -07002188- Serial Flash support
2189 CONFIG_CMD_SF
2190
2191 Defining this option enables SPI flash commands
2192 'sf probe/read/write/erase/update'.
2193
2194 Usage requires an initial 'probe' to define the serial
2195 flash parameters, followed by read/write/erase/update
2196 commands.
2197
2198 The following defaults may be provided by the platform
2199 to handle the common case when only a single serial
2200 flash is present on the system.
2201
2202 CONFIG_SF_DEFAULT_BUS Bus identifier
2203 CONFIG_SF_DEFAULT_CS Chip-select
2204 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2205 CONFIG_SF_DEFAULT_SPEED in Hz
2206
wdenk3f85ce22004-02-23 16:11:30 +00002207- SystemACE Support:
2208 CONFIG_SYSTEMACE
2209
2210 Adding this option adds support for Xilinx SystemACE
2211 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002212 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002213 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002214
2215 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002216 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002217
2218 When SystemACE support is added, the "ace" device type
2219 becomes available to the fat commands, i.e. fatls.
2220
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002221- TFTP Fixed UDP Port:
2222 CONFIG_TFTP_PORT
2223
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002224 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002225 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002226 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002227 number generator is used.
2228
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002229 Also, the environment variable tftpdstp is used to supply
2230 the TFTP UDP destination port value. If tftpdstp isn't
2231 defined, the normal port 69 is used.
2232
2233 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002234 blindly start the TFTP transfer using the pre-configured
2235 target IP address and UDP port. This has the effect of
2236 "punching through" the (Windows XP) firewall, allowing
2237 the remainder of the TFTP transfer to proceed normally.
2238 A better solution is to properly configure the firewall,
2239 but sometimes that is not allowed.
2240
wdenka8c7c702003-12-06 19:49:23 +00002241- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002242 CONFIG_SHOW_BOOT_PROGRESS
2243
wdenk43d96162003-03-06 00:02:04 +00002244 Defining this option allows to add some board-
2245 specific code (calling a user-provided function
2246 "show_boot_progress(int)") that enables you to show
2247 the system's boot progress on some display (for
2248 example, some LED's) on your board. At the moment,
2249 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002250
Simon Glass3a608ca2012-02-13 13:51:19 +00002251- Detailed boot stage timing
2252 CONFIG_BOOTSTAGE
2253 Define this option to get detailed timing of each stage
2254 of the boot process.
2255
2256 CONFIG_BOOTSTAGE_USER_COUNT
2257 This is the number of available user bootstage records.
2258 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2259 a new ID will be allocated from this stash. If you exceed
2260 the limit, recording will stop.
2261
2262 CONFIG_BOOTSTAGE_REPORT
2263 Define this to print a report before boot, similar to this:
2264
2265 Timer summary in microseconds:
2266 Mark Elapsed Stage
2267 0 0 reset
2268 3,575,678 3,575,678 board_init_f start
2269 3,575,695 17 arch_cpu_init A9
2270 3,575,777 82 arch_cpu_init done
2271 3,659,598 83,821 board_init_r start
2272 3,910,375 250,777 main_loop
2273 29,916,167 26,005,792 bootm_start
2274 30,361,327 445,160 start_kernel
2275
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002276Legacy uImage format:
2277
wdenkc6097192002-11-03 00:24:07 +00002278 Arg Where When
2279 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002280 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002281 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002282 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002283 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002284 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002285 4 common/cmd_bootm.c Image data has correct checksum
2286 -4 common/cmd_bootm.c Image is for unsupported architecture
2287 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002288 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002289 6 common/cmd_bootm.c Image Type check OK
2290 -6 common/cmd_bootm.c gunzip uncompression error
2291 -7 common/cmd_bootm.c Unimplemented compression type
2292 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002293 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002294 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002295
2296 9 common/image.c Start initial ramdisk verification
2297 -10 common/image.c Ramdisk header has bad magic number
2298 -11 common/image.c Ramdisk header has bad checksum
2299 10 common/image.c Ramdisk header is OK
2300 -12 common/image.c Ramdisk data has bad checksum
2301 11 common/image.c Ramdisk data has correct checksum
2302 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002303 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002304 13 common/image.c Start multifile image verification
2305 14 common/image.c No initial ramdisk, no multifile, continue.
2306
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002307 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002308
Stefan Roesea47a12b2010-04-15 16:07:28 +02002309 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002310 -31 post/post.c POST test failed, detected by post_output_backlog()
2311 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002312
Heiko Schocher566a4942007-06-22 19:11:54 +02002313 34 common/cmd_doc.c before loading a Image from a DOC device
2314 -35 common/cmd_doc.c Bad usage of "doc" command
2315 35 common/cmd_doc.c correct usage of "doc" command
2316 -36 common/cmd_doc.c No boot device
2317 36 common/cmd_doc.c correct boot device
2318 -37 common/cmd_doc.c Unknown Chip ID on boot device
2319 37 common/cmd_doc.c correct chip ID found, device available
2320 -38 common/cmd_doc.c Read Error on boot device
2321 38 common/cmd_doc.c reading Image header from DOC device OK
2322 -39 common/cmd_doc.c Image header has bad magic number
2323 39 common/cmd_doc.c Image header has correct magic number
2324 -40 common/cmd_doc.c Error reading Image from DOC device
2325 40 common/cmd_doc.c Image header has correct magic number
2326 41 common/cmd_ide.c before loading a Image from a IDE device
2327 -42 common/cmd_ide.c Bad usage of "ide" command
2328 42 common/cmd_ide.c correct usage of "ide" command
2329 -43 common/cmd_ide.c No boot device
2330 43 common/cmd_ide.c boot device found
2331 -44 common/cmd_ide.c Device not available
2332 44 common/cmd_ide.c Device available
2333 -45 common/cmd_ide.c wrong partition selected
2334 45 common/cmd_ide.c partition selected
2335 -46 common/cmd_ide.c Unknown partition table
2336 46 common/cmd_ide.c valid partition table found
2337 -47 common/cmd_ide.c Invalid partition type
2338 47 common/cmd_ide.c correct partition type
2339 -48 common/cmd_ide.c Error reading Image Header on boot device
2340 48 common/cmd_ide.c reading Image Header from IDE device OK
2341 -49 common/cmd_ide.c Image header has bad magic number
2342 49 common/cmd_ide.c Image header has correct magic number
2343 -50 common/cmd_ide.c Image header has bad checksum
2344 50 common/cmd_ide.c Image header has correct checksum
2345 -51 common/cmd_ide.c Error reading Image from IDE device
2346 51 common/cmd_ide.c reading Image from IDE device OK
2347 52 common/cmd_nand.c before loading a Image from a NAND device
2348 -53 common/cmd_nand.c Bad usage of "nand" command
2349 53 common/cmd_nand.c correct usage of "nand" command
2350 -54 common/cmd_nand.c No boot device
2351 54 common/cmd_nand.c boot device found
2352 -55 common/cmd_nand.c Unknown Chip ID on boot device
2353 55 common/cmd_nand.c correct chip ID found, device available
2354 -56 common/cmd_nand.c Error reading Image Header on boot device
2355 56 common/cmd_nand.c reading Image Header from NAND device OK
2356 -57 common/cmd_nand.c Image header has bad magic number
2357 57 common/cmd_nand.c Image header has correct magic number
2358 -58 common/cmd_nand.c Error reading Image from NAND device
2359 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002360
Heiko Schocher566a4942007-06-22 19:11:54 +02002361 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002362
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002363 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002364 -64 net/eth.c no Ethernet found.
2365 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002366
Heiko Schocher566a4942007-06-22 19:11:54 +02002367 -80 common/cmd_net.c usage wrong
2368 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002369 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002370 81 common/cmd_net.c NetLoop() back without error
2371 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2372 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002373 83 common/cmd_net.c running "source" command
2374 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002375 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002376
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002377FIT uImage format:
2378
2379 Arg Where When
2380 100 common/cmd_bootm.c Kernel FIT Image has correct format
2381 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2382 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2383 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2384 102 common/cmd_bootm.c Kernel unit name specified
2385 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002386 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002387 104 common/cmd_bootm.c Got kernel subimage node offset
2388 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2389 105 common/cmd_bootm.c Kernel subimage hash verification OK
2390 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2391 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002392 -106 common/cmd_bootm.c Kernel subimage has wrong type
2393 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002394 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2395 108 common/cmd_bootm.c Got kernel subimage data/size
2396 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2397 -109 common/cmd_bootm.c Can't get kernel subimage type
2398 -110 common/cmd_bootm.c Can't get kernel subimage comp
2399 -111 common/cmd_bootm.c Can't get kernel subimage os
2400 -112 common/cmd_bootm.c Can't get kernel subimage load address
2401 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2402
2403 120 common/image.c Start initial ramdisk verification
2404 -120 common/image.c Ramdisk FIT image has incorrect format
2405 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002406 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002407 -122 common/image.c Can't get configuration for ramdisk subimage
2408 123 common/image.c Ramdisk unit name specified
2409 -124 common/image.c Can't get ramdisk subimage node offset
2410 125 common/image.c Got ramdisk subimage node offset
2411 -125 common/image.c Ramdisk subimage hash verification failed
2412 126 common/image.c Ramdisk subimage hash verification OK
2413 -126 common/image.c Ramdisk subimage for unsupported architecture
2414 127 common/image.c Architecture check OK
2415 -127 common/image.c Can't get ramdisk subimage data/size
2416 128 common/image.c Got ramdisk subimage data/size
2417 129 common/image.c Can't get ramdisk load address
2418 -129 common/image.c Got ramdisk load address
2419
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002420 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002421 131 common/cmd_doc.c FIT image format OK
2422
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002423 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002424 141 common/cmd_ide.c FIT image format OK
2425
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002426 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002427 151 common/cmd_nand.c FIT image format OK
2428
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002429- Standalone program support:
2430 CONFIG_STANDALONE_LOAD_ADDR
2431
Wolfgang Denk6feff892011-10-09 21:06:34 +02002432 This option defines a board specific value for the
2433 address where standalone program gets loaded, thus
2434 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002435 settings.
2436
2437- Frame Buffer Address:
2438 CONFIG_FB_ADDR
2439
2440 Define CONFIG_FB_ADDR if you want to use specific
2441 address for frame buffer.
2442 Then system will reserve the frame buffer address to
2443 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002444 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002445
2446 Please see board_init_f function.
2447
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002448- Automatic software updates via TFTP server
2449 CONFIG_UPDATE_TFTP
2450 CONFIG_UPDATE_TFTP_CNT_MAX
2451 CONFIG_UPDATE_TFTP_MSEC_MAX
2452
2453 These options enable and control the auto-update feature;
2454 for a more detailed description refer to doc/README.update.
2455
2456- MTD Support (mtdparts command, UBI support)
2457 CONFIG_MTD_DEVICE
2458
2459 Adds the MTD device infrastructure from the Linux kernel.
2460 Needed for mtdparts command support.
2461
2462 CONFIG_MTD_PARTITIONS
2463
2464 Adds the MTD partitioning infrastructure from the Linux
2465 kernel. Needed for UBI support.
2466
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002467- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002468 CONFIG_SPL
2469 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002470
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002471 CONFIG_SPL_TEXT_BASE
2472 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002473
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002474 CONFIG_SPL_LDSCRIPT
2475 LDSCRIPT for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002476
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002477 CONFIG_SPL_LIBCOMMON_SUPPORT
2478 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002479
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002480 CONFIG_SPL_LIBDISK_SUPPORT
2481 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002482
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002483 CONFIG_SPL_I2C_SUPPORT
2484 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002485
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002486 CONFIG_SPL_GPIO_SUPPORT
2487 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002488
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002489 CONFIG_SPL_MMC_SUPPORT
2490 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002491
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002492 CONFIG_SPL_SERIAL_SUPPORT
2493 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002494
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002495 CONFIG_SPL_SPI_FLASH_SUPPORT
2496 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002497
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002498 CONFIG_SPL_SPI_SUPPORT
2499 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002500
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002501 CONFIG_SPL_FAT_SUPPORT
2502 Support for fs/fat/libfat.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002503
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002504 CONFIG_SPL_LIBGENERIC_SUPPORT
2505 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002506
wdenkc6097192002-11-03 00:24:07 +00002507Modem Support:
2508--------------
2509
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002510[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002511
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002512- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002513 CONFIG_MODEM_SUPPORT
2514
2515- RTS/CTS Flow control enable:
2516 CONFIG_HWFLOW
2517
2518- Modem debug support:
2519 CONFIG_MODEM_SUPPORT_DEBUG
2520
wdenk43d96162003-03-06 00:02:04 +00002521 Enables debugging stuff (char screen[1024], dbg())
2522 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002523
wdenka8c7c702003-12-06 19:49:23 +00002524- Interrupt support (PPC):
2525
wdenkd4ca31c2004-01-02 14:00:00 +00002526 There are common interrupt_init() and timer_interrupt()
2527 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002528 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002529 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002530 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002531 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002532 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002533 specific handling. If board has watchdog / status_led
2534 / other_activity_monitor it works automatically from
2535 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002536
wdenkc6097192002-11-03 00:24:07 +00002537- General:
2538
wdenk43d96162003-03-06 00:02:04 +00002539 In the target system modem support is enabled when a
2540 specific key (key combination) is pressed during
2541 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002542 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002543 board_init(). Currently key_pressed() is a dummy
2544 function, returning 1 and thus enabling modem
2545 initialization.
wdenkc6097192002-11-03 00:24:07 +00002546
wdenk43d96162003-03-06 00:02:04 +00002547 If there are no modem init strings in the
2548 environment, U-Boot proceed to autoboot; the
2549 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002550 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002551
2552 See also: doc/README.Modem
2553
Helmut Raiger9660e442011-10-20 04:19:47 +00002554Board initialization settings:
2555------------------------------
2556
2557During Initialization u-boot calls a number of board specific functions
2558to allow the preparation of board specific prerequisites, e.g. pin setup
2559before drivers are initialized. To enable these callbacks the
2560following configuration macros have to be defined. Currently this is
2561architecture specific, so please check arch/your_architecture/lib/board.c
2562typically in board_init_f() and board_init_r().
2563
2564- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2565- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2566- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2567- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002568
wdenkc6097192002-11-03 00:24:07 +00002569Configuration Settings:
2570-----------------------
2571
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002572- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002573 undefine this when you're short of memory.
2574
Peter Tyser2fb26042009-01-27 18:03:12 -06002575- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2576 width of the commands listed in the 'help' command output.
2577
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002578- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002579 prompt for user input.
2580
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002581- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002582
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002583- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002584
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002585- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002586
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002587- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002588 the application (usually a Linux kernel) when it is
2589 booted
2590
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002591- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002592 List of legal baudrate settings for this board.
2593
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002594- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002595 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002596
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002597- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002598 If the board specific function
2599 extern int overwrite_console (void);
2600 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002601 serial port, else the settings in the environment are used.
2602
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002603- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002604 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002605
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002606- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002607 Enable overwrite of previous console environment settings.
2608
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002609- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002610 Begin and End addresses of the area used by the
2611 simple memory test.
2612
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002613- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002614 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002616- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002617 Scratch address used by the alternate memory test
2618 You only need to set this if address zero isn't writeable
2619
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002620- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2621 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002622 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002623 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002624 fixing up gd->ram_size the Linux kernel should gets passed
2625 the now "corrected" memory size and won't touch it either.
2626 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002627 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002628 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002629 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002630
2631 This option can be used as a workaround for the 440EPx/GRx
2632 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2633 be touched.
2634
2635 WARNING: Please make sure that this value is a multiple of
2636 the Linux page size (normally 4k). If this is not the case,
2637 then the end address of the Linux memory will be located at a
2638 non page size aligned address and this could cause major
2639 problems.
2640
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002641- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002642 Default load address for network file downloads
2643
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002644- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002645 Enable temporary baudrate change while serial download
2646
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002647- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002648 Physical start address of SDRAM. _Must_ be 0 here.
2649
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002650- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002651 Physical start address of Motherboard I/O (if using a
2652 Cogent motherboard)
2653
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002654- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002655 Physical start address of Flash memory.
2656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002657- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002658 Physical start address of boot monitor code (set by
2659 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002660 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002661 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002662
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002663- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002664 Size of memory reserved for monitor code, used to
2665 determine _at_compile_time_ (!) if the environment is
2666 embedded within the U-Boot image, or in a separate
2667 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002668
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002669- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002670 Size of DRAM reserved for malloc() use.
2671
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002672- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002673 Normally compressed uImages are limited to an
2674 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002675 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002676 to adjust this setting to your needs.
2677
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002678- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002679 Maximum size of memory mapped by the startup code of
2680 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002681 the Linux kernel (bd_info, boot arguments, FDT blob if
2682 used) must be put below this limit, unless "bootm_low"
2683 enviroment variable is defined and non-zero. In such case
2684 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002685 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002686 variable "bootm_mapsize" will override the value of
2687 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2688 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002689
John Rigbyfca43cc2010-10-13 13:57:35 -06002690- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2691 Enable initrd_high functionality. If defined then the
2692 initrd_high feature is enabled and the bootm ramdisk subcommand
2693 is enabled.
2694
2695- CONFIG_SYS_BOOT_GET_CMDLINE:
2696 Enables allocating and saving kernel cmdline in space between
2697 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2698
2699- CONFIG_SYS_BOOT_GET_KBD:
2700 Enables allocating and saving a kernel copy of the bd_info in
2701 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2702
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002703- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002704 Max number of Flash memory banks
2705
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002706- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002707 Max number of sectors on a Flash chip
2708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002709- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002710 Timeout for Flash erase operations (in ms)
2711
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002712- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002713 Timeout for Flash write operations (in ms)
2714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002715- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002716 Timeout for Flash set sector lock bit operation (in ms)
2717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002718- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002719 Timeout for Flash clear lock bits operation (in ms)
2720
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002721- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002722 If defined, hardware flash sectors protection is used
2723 instead of U-Boot software protection.
2724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002726
2727 Enable TFTP transfers directly to flash memory;
2728 without this option such a download has to be
2729 performed in two steps: (1) download to RAM, and (2)
2730 copy from RAM to flash.
2731
2732 The two-step approach is usually more reliable, since
2733 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002734 the flash, but in some situations (when system RAM is
2735 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002736 downloaded image) this option may be very useful.
2737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002738- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002739 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002740 common flash structure for storing flash geometry.
2741
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002742- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002743 This option also enables the building of the cfi_flash driver
2744 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002745
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002746- CONFIG_FLASH_CFI_MTD
2747 This option enables the building of the cfi_mtd driver
2748 in the drivers directory. The driver exports CFI flash
2749 to the MTD layer.
2750
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002751- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002752 Use buffered writes to flash.
2753
2754- CONFIG_FLASH_SPANSION_S29WS_N
2755 s29ws-n MirrorBit flash has non-standard addresses for buffered
2756 write commands.
2757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002758- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002759 If this option is defined, the common CFI flash doesn't
2760 print it's warning upon not recognized FLASH banks. This
2761 is useful, if some of the configured banks are only
2762 optionally available.
2763
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002764- CONFIG_FLASH_SHOW_PROGRESS
2765 If defined (must be an integer), print out countdown
2766 digits and dots. Recommended value: 45 (9..1) for 80
2767 column displays, 15 (3..1) for 40 column displays.
2768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002769- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002770 Defines the number of Ethernet receive buffers. On some
2771 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002772 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2773 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002774 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002775 Defaults to 4 if not defined.
2776
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002777- CONFIG_ENV_MAX_ENTRIES
2778
Wolfgang Denk071bc922010-10-27 22:48:30 +02002779 Maximum number of entries in the hash table that is used
2780 internally to store the environment settings. The default
2781 setting is supposed to be generous and should work in most
2782 cases. This setting can be used to tune behaviour; see
2783 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002784
wdenkc6097192002-11-03 00:24:07 +00002785The following definitions that deal with the placement and management
2786of environment data (variable area); in general, we support the
2787following configurations:
2788
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002789- CONFIG_BUILD_ENVCRC:
2790
2791 Builds up envcrc with the target environment so that external utils
2792 may easily extract it and embed it in final U-Boot images.
2793
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002794- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002795
2796 Define this if the environment is in flash memory.
2797
2798 a) The environment occupies one whole flash sector, which is
2799 "embedded" in the text segment with the U-Boot code. This
2800 happens usually with "bottom boot sector" or "top boot
2801 sector" type flash chips, which have several smaller
2802 sectors at the start or the end. For instance, such a
2803 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2804 such a case you would place the environment in one of the
2805 4 kB sectors - with U-Boot code before and after it. With
2806 "top boot sector" type flash chips, you would put the
2807 environment in one of the last sectors, leaving a gap
2808 between U-Boot and the environment.
2809
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002810 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002811
2812 Offset of environment data (variable area) to the
2813 beginning of flash memory; for instance, with bottom boot
2814 type flash chips the second sector can be used: the offset
2815 for this sector is given here.
2816
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002817 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002818
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002819 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002820
2821 This is just another way to specify the start address of
2822 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002823 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002824
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002825 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002826
2827 Size of the sector containing the environment.
2828
2829
2830 b) Sometimes flash chips have few, equal sized, BIG sectors.
2831 In such a case you don't want to spend a whole sector for
2832 the environment.
2833
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002834 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002835
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002836 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002837 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002838 of this flash sector for the environment. This saves
2839 memory for the RAM copy of the environment.
2840
2841 It may also save flash memory if you decide to use this
2842 when your environment is "embedded" within U-Boot code,
2843 since then the remainder of the flash sector could be used
2844 for U-Boot code. It should be pointed out that this is
2845 STRONGLY DISCOURAGED from a robustness point of view:
2846 updating the environment in flash makes it always
2847 necessary to erase the WHOLE sector. If something goes
2848 wrong before the contents has been restored from a copy in
2849 RAM, your target system will be dead.
2850
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002851 - CONFIG_ENV_ADDR_REDUND
2852 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002853
wdenk43d96162003-03-06 00:02:04 +00002854 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002855 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002856 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002857 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002858
2859BE CAREFUL! Any changes to the flash layout, and some changes to the
2860source code will make it necessary to adapt <board>/u-boot.lds*
2861accordingly!
2862
2863
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002864- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002865
2866 Define this if you have some non-volatile memory device
2867 (NVRAM, battery buffered SRAM) which you want to use for the
2868 environment.
2869
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002870 - CONFIG_ENV_ADDR:
2871 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002872
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002873 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002874 want to use for environment. It is assumed that this memory
2875 can just be read and written to, without any special
2876 provision.
2877
2878BE CAREFUL! The first access to the environment happens quite early
2879in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002880console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002881U-Boot will hang.
2882
2883Please note that even with NVRAM we still use a copy of the
2884environment in RAM: we could work on NVRAM directly, but we want to
2885keep settings there always unmodified except somebody uses "saveenv"
2886to save the current settings.
2887
2888
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002889- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002890
2891 Use this if you have an EEPROM or similar serial access
2892 device and a driver for it.
2893
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002894 - CONFIG_ENV_OFFSET:
2895 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002896
2897 These two #defines specify the offset and size of the
2898 environment area within the total memory of your EEPROM.
2899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002900 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002901 If defined, specified the chip address of the EEPROM device.
2902 The default address is zero.
2903
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002904 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002905 If defined, the number of bits used to address bytes in a
2906 single page in the EEPROM device. A 64 byte page, for example
2907 would require six bits.
2908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002909 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002910 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002911 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002913 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002914 The length in bytes of the EEPROM memory array address. Note
2915 that this is NOT the chip address length!
2916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002917 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002918 EEPROM chips that implement "address overflow" are ones
2919 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2920 address and the extra bits end up in the "chip address" bit
2921 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2922 byte chips.
2923
2924 Note that we consider the length of the address field to
2925 still be one byte because the extra address bits are hidden
2926 in the chip address.
2927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002928 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002929 The size in bytes of the EEPROM device.
2930
Heiko Schocher548738b2010-01-07 08:55:40 +01002931 - CONFIG_ENV_EEPROM_IS_ON_I2C
2932 define this, if you have I2C and SPI activated, and your
2933 EEPROM, which holds the environment, is on the I2C bus.
2934
2935 - CONFIG_I2C_ENV_EEPROM_BUS
2936 if you have an Environment on an EEPROM reached over
2937 I2C muxes, you can define here, how to reach this
2938 EEPROM. For example:
2939
Wolfgang Denka9046b92010-06-13 17:48:15 +02002940 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01002941
2942 EEPROM which holds the environment, is reached over
2943 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002944
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002945- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002946
wdenkd4ca31c2004-01-02 14:00:00 +00002947 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002948 want to use for the environment.
2949
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002950 - CONFIG_ENV_OFFSET:
2951 - CONFIG_ENV_ADDR:
2952 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002953
2954 These three #defines specify the offset and size of the
2955 environment area within the total memory of your DataFlash placed
2956 at the specified address.
2957
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002958- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002959
2960 Define this if you have a NAND device which you want to use
2961 for the environment.
2962
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002963 - CONFIG_ENV_OFFSET:
2964 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002965
2966 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05002967 area within the first NAND device. CONFIG_ENV_OFFSET must be
2968 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00002969
Scott Woodfdd813d2010-09-17 14:38:37 -05002970 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002971
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002972 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05002973 size used to hold a redundant copy of the environment data, so
2974 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002975 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05002976 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002977
Scott Woodfdd813d2010-09-17 14:38:37 -05002978 - CONFIG_ENV_RANGE (optional):
2979
2980 Specifies the length of the region in which the environment
2981 can be written. This should be a multiple of the NAND device's
2982 block size. Specifying a range with more erase blocks than
2983 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2984 the range to be avoided.
2985
2986 - CONFIG_ENV_OFFSET_OOB (optional):
2987
2988 Enables support for dynamically retrieving the offset of the
2989 environment from block zero's out-of-band data. The
2990 "nand env.oob" command can be used to record this offset.
2991 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2992 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002993
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002994- CONFIG_NAND_ENV_DST
2995
2996 Defines address in RAM to which the nand_spl code should copy the
2997 environment. If redundant environment is used, it will be copied to
2998 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2999
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003000- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003001
3002 Defines offset to the initial SPI buffer area in DPRAM. The
3003 area is used at an early stage (ROM part) if the environment
3004 is configured to reside in the SPI EEPROM: We need a 520 byte
3005 scratch DPRAM area. It is used between the two initialization
3006 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3007 to be a good choice since it makes it far enough from the
3008 start of the data area as well as from the stack pointer.
3009
Bruce Adlere881cb52007-11-02 13:15:42 -07003010Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003011has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003012created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003013until then to read environment variables.
3014
wdenk85ec0bc2003-03-31 16:34:49 +00003015The environment is protected by a CRC32 checksum. Before the monitor
3016is relocated into RAM, as a result of a bad CRC you will be working
3017with the compiled-in default environment - *silently*!!! [This is
3018necessary, because the first environment variable we need is the
3019"baudrate" setting for the console - if we have a bad CRC, we don't
3020have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003021
3022Note: once the monitor has been relocated, then it will complain if
3023the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003024use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003025
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003026- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003027 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003028
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003029 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003030 also needs to be defined.
3031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003032- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003033 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003034
Ron Madridf5675aa2009-02-18 14:30:44 -08003035- CONFIG_NS16550_MIN_FUNCTIONS:
3036 Define this if you desire to only have use of the NS16550_init
3037 and NS16550_putc functions for the serial driver located at
3038 drivers/serial/ns16550.c. This option is useful for saving
3039 space for already greatly restricted images, including but not
3040 limited to NAND_SPL configurations.
3041
wdenkc6097192002-11-03 00:24:07 +00003042Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003043---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003044
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003045- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003046 Cache Line Size of the CPU.
3047
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003048- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003049 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003050
wdenk42d1f032003-10-15 23:53:47 +00003051 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3052 and RPXsuper) to be able to adjust the position of
3053 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003054
Timur Tabie46fedf2011-08-04 18:03:41 -05003055- CONFIG_SYS_CCSRBAR_DEFAULT:
3056 Default (power-on reset) physical address of CCSR on Freescale
3057 PowerPC SOCs.
3058
3059- CONFIG_SYS_CCSRBAR:
3060 Virtual address of CCSR. On a 32-bit build, this is typically
3061 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3062
3063 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3064 for cross-platform code that uses that macro instead.
3065
3066- CONFIG_SYS_CCSRBAR_PHYS:
3067 Physical address of CCSR. CCSR can be relocated to a new
3068 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003069 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003070 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3071 is typically relocated on 36-bit builds. It is recommended
3072 that this macro be defined via the _HIGH and _LOW macros:
3073
3074 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3075 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3076
3077- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003078 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3079 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003080 used in assembly code, so it must not contain typecasts or
3081 integer size suffixes (e.g. "ULL").
3082
3083- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3084 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3085 used in assembly code, so it must not contain typecasts or
3086 integer size suffixes (e.g. "ULL").
3087
3088- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3089 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3090 forced to a value that ensures that CCSR is not relocated.
3091
wdenk7f6c2cb2002-11-10 22:06:23 +00003092- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003093 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003094
3095 the default drive number (default value 0)
3096
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003097 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003098
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003099 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003100 (default value 1)
3101
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003102 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003103
wdenk43d96162003-03-06 00:02:04 +00003104 defines the offset of register from address. It
3105 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003106 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003107
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003108 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3109 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003110 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003111
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003112 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003113 fdc_hw_init() is called at the beginning of the FDC
3114 setup. fdc_hw_init() must be provided by the board
3115 source code. It is used to make hardware dependant
3116 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003117
Macpaul Lin0abddf82011-04-11 20:45:32 +00003118- CONFIG_IDE_AHB:
3119 Most IDE controllers were designed to be connected with PCI
3120 interface. Only few of them were designed for AHB interface.
3121 When software is doing ATA command and data transfer to
3122 IDE devices through IDE-AHB controller, some additional
3123 registers accessing to these kind of IDE-AHB controller
3124 is requierd.
3125
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003126- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003127 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003128 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003130- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003131
wdenk7152b1d2003-09-05 23:19:14 +00003132 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003133 initial data and stack; please note that this must be
3134 writable memory that is working WITHOUT special
3135 initialization, i. e. you CANNOT use normal RAM which
3136 will become available only after programming the
3137 memory controller and running certain initialization
3138 sequences.
3139
3140 U-Boot uses the following memory types:
3141 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3142 - MPC824X: data cache
3143 - PPC4xx: data cache
3144
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003145- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003146
3147 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003148 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3149 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003150 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003151 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003152 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3153 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3154 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003155
3156 Note:
3157 On the MPC824X (or other systems that use the data
3158 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003159 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003160 point to an otherwise UNUSED address space between
3161 the top of RAM and the start of the PCI space.
3162
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003163- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003164
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003165- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003167- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003168
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003169- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003171- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003172
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003173- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003174
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003175- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003176 SDRAM timing
3177
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003178- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003179 periodic timer for refresh
3180
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003181- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003182
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003183- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3184 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3185 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3186 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003187 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3188
3189- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003190 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3191 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003192 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3193
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003194- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3195 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003196 Machine Mode Register and Memory Periodic Timer
3197 Prescaler definitions (SDRAM timing)
3198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003199- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003200 enable I2C microcode relocation patch (MPC8xx);
3201 define relocation offset in DPRAM [DSP2]
3202
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003203- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003204 enable SMC microcode relocation patch (MPC8xx);
3205 define relocation offset in DPRAM [SMC1]
3206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003207- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003208 enable SPI microcode relocation patch (MPC8xx);
3209 define relocation offset in DPRAM [SCC4]
3210
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003211- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003212 Use OSCM clock mode on MBX8xx board. Be careful,
3213 wrong setting might damage your board. Read
3214 doc/README.MBX before setting this variable!
3215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003216- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003217 Offset of the bootmode word in DPRAM used by post
3218 (Power On Self Tests). This definition overrides
3219 #define'd default value in commproc.h resp.
3220 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003221
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003222- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3223 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3224 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3225 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3226 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3227 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3228 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3229 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003230 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003231
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003232- CONFIG_PCI_DISABLE_PCIE:
3233 Disable PCI-Express on systems where it is supported but not
3234 required.
3235
Kumar Galaa09b9b62010-12-30 12:09:53 -06003236- CONFIG_SYS_SRIO:
3237 Chip has SRIO or not
3238
3239- CONFIG_SRIO1:
3240 Board has SRIO 1 port available
3241
3242- CONFIG_SRIO2:
3243 Board has SRIO 2 port available
3244
3245- CONFIG_SYS_SRIOn_MEM_VIRT:
3246 Virtual Address of SRIO port 'n' memory region
3247
3248- CONFIG_SYS_SRIOn_MEM_PHYS:
3249 Physical Address of SRIO port 'n' memory region
3250
3251- CONFIG_SYS_SRIOn_MEM_SIZE:
3252 Size of SRIO port 'n' memory region
3253
Alex Watermaneced4622011-05-19 15:08:36 -04003254- CONFIG_SYS_NDFC_16
3255 Defined to tell the NDFC that the NAND chip is using a
3256 16 bit bus.
3257
3258- CONFIG_SYS_NDFC_EBC0_CFG
3259 Sets the EBC0_CFG register for the NDFC. If not defined
3260 a default value will be used.
3261
Ben Warrenbb99ad62006-09-07 16:50:54 -04003262- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003263 Get DDR timing information from an I2C EEPROM. Common
3264 with pluggable memory modules such as SODIMMs
3265
Ben Warrenbb99ad62006-09-07 16:50:54 -04003266 SPD_EEPROM_ADDRESS
3267 I2C address of the SPD EEPROM
3268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003269- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003270 If SPD EEPROM is on an I2C bus other than the first
3271 one, specify here. Note that the value must resolve
3272 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003273
York Sun1b3e3c42011-06-07 09:42:16 +08003274- CONFIG_SYS_DDR_RAW_TIMING
3275 Get DDR timing information from other than SPD. Common with
3276 soldered DDR chips onboard without SPD. DDR raw timing
3277 parameters are extracted from datasheet and hard-coded into
3278 header files or board specific files.
3279
York Sun6f5e1dc2011-09-16 13:21:35 -07003280- CONFIG_FSL_DDR_INTERACTIVE
3281 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3282
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003283- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003284 Only for 83xx systems. If specified, then DDR should
3285 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003286
wdenkc26e4542004-04-18 10:13:26 +00003287- CONFIG_ETHER_ON_FEC[12]
3288 Define to enable FEC[12] on a 8xx series processor.
3289
3290- CONFIG_FEC[12]_PHY
3291 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003292 to the given FEC; i. e.
3293 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003294 means that the PHY with address 4 is connected to FEC1
3295
3296 When set to -1, means to probe for first available.
3297
3298- CONFIG_FEC[12]_PHY_NORXERR
3299 The PHY does not have a RXERR line (RMII only).
3300 (so program the FEC to ignore it).
3301
3302- CONFIG_RMII
3303 Enable RMII mode for all FECs.
3304 Note that this is a global option, we can't
3305 have one FEC in standard MII mode and another in RMII mode.
3306
wdenk5cf91d62004-04-23 20:32:05 +00003307- CONFIG_CRC32_VERIFY
3308 Add a verify option to the crc32 command.
3309 The syntax is:
3310
3311 => crc32 -v <address> <count> <crc32>
3312
3313 Where address/count indicate a memory area
3314 and crc32 is the correct crc32 which the
3315 area should have.
3316
wdenk56523f12004-07-11 17:40:54 +00003317- CONFIG_LOOPW
3318 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003319 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003320
stroese7b466642004-12-16 18:46:55 +00003321- CONFIG_MX_CYCLIC
3322 Add the "mdc" and "mwc" memory commands. These are cyclic
3323 "md/mw" commands.
3324 Examples:
3325
wdenkefe2a4d2004-12-16 21:44:03 +00003326 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003327 This command will print 4 bytes (10,11,12,13) each 500 ms.
3328
wdenkefe2a4d2004-12-16 21:44:03 +00003329 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003330 This command will write 12345678 to address 100 all 10 ms.
3331
wdenkefe2a4d2004-12-16 21:44:03 +00003332 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003333 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003334
wdenk8aa1a2d2005-04-04 12:44:11 +00003335- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003336 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003337 low level initializations (like setting up the memory
3338 controller) are omitted and/or U-Boot does not
3339 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003340
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003341 Normally this variable MUST NOT be defined. The only
3342 exception is when U-Boot is loaded (to RAM) by some
3343 other boot loader or by a debugger which performs
3344 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003345
Aneesh V401bb302011-07-13 05:11:07 +00003346- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003347 Modifies the behaviour of start.S when compiling a loader
3348 that is executed before the actual U-Boot. E.g. when
3349 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003350
Heiko Schocher68bb8292011-11-01 20:00:30 +00003351- CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3352 define this, if you want to read first the oob data
3353 and then the data. This is used for example on
3354 davinci plattforms.
3355
Matthias Weisserd8834a12011-03-10 21:36:32 +00003356- CONFIG_USE_ARCH_MEMCPY
3357 CONFIG_USE_ARCH_MEMSET
3358 If these options are used a optimized version of memcpy/memset will
3359 be used if available. These functions may be faster under some
3360 conditions but may increase the binary size.
3361
Timur Tabif2717b42011-11-22 09:21:25 -06003362Freescale QE/FMAN Firmware Support:
3363-----------------------------------
3364
3365The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3366loading of "firmware", which is encoded in the QE firmware binary format.
3367This firmware often needs to be loaded during U-Boot booting, so macros
3368are used to identify the storage device (NOR flash, SPI, etc) and the address
3369within that device.
3370
3371- CONFIG_SYS_QE_FMAN_FW_ADDR
3372 The address in the storage device where the firmware is located. The
3373 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3374 is also specified.
3375
3376- CONFIG_SYS_QE_FMAN_FW_LENGTH
3377 The maximum possible size of the firmware. The firmware binary format
3378 has a field that specifies the actual size of the firmware, but it
3379 might not be possible to read any part of the firmware unless some
3380 local storage is allocated to hold the entire firmware first.
3381
3382- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3383 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3384 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3385 virtual address in NOR flash.
3386
3387- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3388 Specifies that QE/FMAN firmware is located in NAND flash.
3389 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3390
3391- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3392 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3393 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3394
3395- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3396 Specifies that QE/FMAN firmware is located on the primary SPI
3397 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3398
3399
wdenkc6097192002-11-03 00:24:07 +00003400Building the Software:
3401======================
3402
Wolfgang Denk218ca722008-03-26 10:40:12 +01003403Building U-Boot has been tested in several native build environments
3404and in many different cross environments. Of course we cannot support
3405all possibly existing versions of cross development tools in all
3406(potentially obsolete) versions. In case of tool chain problems we
3407recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3408which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003409
Wolfgang Denk218ca722008-03-26 10:40:12 +01003410If you are not using a native environment, it is assumed that you
3411have GNU cross compiling tools available in your path. In this case,
3412you must set the environment variable CROSS_COMPILE in your shell.
3413Note that no changes to the Makefile or any other source files are
3414necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003415
Wolfgang Denk218ca722008-03-26 10:40:12 +01003416 $ CROSS_COMPILE=ppc_4xx-
3417 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003418
Peter Tyser2f8d3962009-03-13 18:54:51 -05003419Note: If you wish to generate Windows versions of the utilities in
3420 the tools directory you can use the MinGW toolchain
3421 (http://www.mingw.org). Set your HOST tools to the MinGW
3422 toolchain and execute 'make tools'. For example:
3423
3424 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3425
3426 Binaries such as tools/mkimage.exe will be created which can
3427 be executed on computers running Windows.
3428
Wolfgang Denk218ca722008-03-26 10:40:12 +01003429U-Boot is intended to be simple to build. After installing the
3430sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003431is done by typing:
3432
3433 make NAME_config
3434
Wolfgang Denk218ca722008-03-26 10:40:12 +01003435where "NAME_config" is the name of one of the existing configu-
3436rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003437
wdenk2729af92004-05-03 20:45:30 +00003438Note: for some board special configuration names may exist; check if
3439 additional information is available from the board vendor; for
3440 instance, the TQM823L systems are available without (standard)
3441 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003442 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003443
wdenk2729af92004-05-03 20:45:30 +00003444 make TQM823L_config
3445 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003446
wdenk2729af92004-05-03 20:45:30 +00003447 make TQM823L_LCD_config
3448 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003449
wdenk2729af92004-05-03 20:45:30 +00003450 etc.
wdenkc6097192002-11-03 00:24:07 +00003451
wdenkc6097192002-11-03 00:24:07 +00003452
wdenk2729af92004-05-03 20:45:30 +00003453Finally, type "make all", and you should get some working U-Boot
3454images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk2729af92004-05-03 20:45:30 +00003456- "u-boot.bin" is a raw binary image
3457- "u-boot" is an image in ELF binary format
3458- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003459
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003460By default the build is performed locally and the objects are saved
3461in the source directory. One of the two methods can be used to change
3462this behavior and build U-Boot to some external directory:
3463
34641. Add O= to the make command line invocations:
3465
3466 make O=/tmp/build distclean
3467 make O=/tmp/build NAME_config
3468 make O=/tmp/build all
3469
34702. Set environment variable BUILD_DIR to point to the desired location:
3471
3472 export BUILD_DIR=/tmp/build
3473 make distclean
3474 make NAME_config
3475 make all
3476
3477Note that the command line "O=" setting overrides the BUILD_DIR environment
3478variable.
3479
wdenkc6097192002-11-03 00:24:07 +00003480
wdenk2729af92004-05-03 20:45:30 +00003481Please be aware that the Makefiles assume you are using GNU make, so
3482for instance on NetBSD you might need to use "gmake" instead of
3483native "make".
wdenkc6097192002-11-03 00:24:07 +00003484
wdenkc6097192002-11-03 00:24:07 +00003485
wdenk2729af92004-05-03 20:45:30 +00003486If the system board that you have is not listed, then you will need
3487to port U-Boot to your hardware platform. To do this, follow these
3488steps:
wdenkc6097192002-11-03 00:24:07 +00003489
wdenk2729af92004-05-03 20:45:30 +000034901. Add a new configuration option for your board to the toplevel
3491 "Makefile" and to the "MAKEALL" script, using the existing
3492 entries as examples. Note that here and at many other places
3493 boards and other names are listed in alphabetical sort order. Please
3494 keep this order.
34952. Create a new directory to hold your board specific code. Add any
3496 files you need. In your board directory, you will need at least
3497 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
34983. Create a new configuration file "include/configs/<board>.h" for
3499 your board
35003. If you're porting U-Boot to a new CPU, then also create a new
3501 directory to hold your CPU specific code. Add any files you need.
35024. Run "make <board>_config" with your new name.
35035. Type "make", and you should get a working "u-boot.srec" file
3504 to be installed on your target system.
35056. Debug and solve any problems that might arise.
3506 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003507
wdenkc6097192002-11-03 00:24:07 +00003508
wdenk2729af92004-05-03 20:45:30 +00003509Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3510==============================================================
wdenkc6097192002-11-03 00:24:07 +00003511
Wolfgang Denk218ca722008-03-26 10:40:12 +01003512If you have modified U-Boot sources (for instance added a new board
3513or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003514provide feedback to the other developers. The feedback normally takes
3515the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003516official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003517
Wolfgang Denk218ca722008-03-26 10:40:12 +01003518But before you submit such a patch, please verify that your modifi-
3519cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003520the supported boards compile WITHOUT ANY compiler warnings. To do so,
3521just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003522for ALL supported system. Be warned, this will take a while. You can
3523select which (cross) compiler to use by passing a `CROSS_COMPILE'
3524environment variable to the script, i. e. to use the ELDK cross tools
3525you can type
wdenkc6097192002-11-03 00:24:07 +00003526
wdenk2729af92004-05-03 20:45:30 +00003527 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003528
wdenk2729af92004-05-03 20:45:30 +00003529or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003530
wdenk2729af92004-05-03 20:45:30 +00003531 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003532
Wolfgang Denk218ca722008-03-26 10:40:12 +01003533When using the MAKEALL script, the default behaviour is to build
3534U-Boot in the source directory. This location can be changed by
3535setting the BUILD_DIR environment variable. Also, for each target
3536built, the MAKEALL script saves two log files (<target>.ERR and
3537<target>.MAKEALL) in the <source dir>/LOG directory. This default
3538location can be changed by setting the MAKEALL_LOGDIR environment
3539variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003540
3541 export BUILD_DIR=/tmp/build
3542 export MAKEALL_LOGDIR=/tmp/log
3543 CROSS_COMPILE=ppc_8xx- MAKEALL
3544
Wolfgang Denk218ca722008-03-26 10:40:12 +01003545With the above settings build objects are saved in the /tmp/build,
3546log files are saved in the /tmp/log and the source tree remains clean
3547during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003548
3549
wdenk2729af92004-05-03 20:45:30 +00003550See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003551
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk2729af92004-05-03 20:45:30 +00003553Monitor Commands - Overview:
3554============================
wdenkc6097192002-11-03 00:24:07 +00003555
wdenk2729af92004-05-03 20:45:30 +00003556go - start application at address 'addr'
3557run - run commands in an environment variable
3558bootm - boot application image from memory
3559bootp - boot image via network using BootP/TFTP protocol
3560tftpboot- boot image via network using TFTP protocol
3561 and env variables "ipaddr" and "serverip"
3562 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003563tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003564rarpboot- boot image via network using RARP/TFTP protocol
3565diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3566loads - load S-Record file over serial line
3567loadb - load binary file over serial line (kermit mode)
3568md - memory display
3569mm - memory modify (auto-incrementing)
3570nm - memory modify (constant address)
3571mw - memory write (fill)
3572cp - memory copy
3573cmp - memory compare
3574crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003575i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003576sspi - SPI utility commands
3577base - print or set address offset
3578printenv- print environment variables
3579setenv - set environment variables
3580saveenv - save environment variables to persistent storage
3581protect - enable or disable FLASH write protection
3582erase - erase FLASH memory
3583flinfo - print FLASH memory information
3584bdinfo - print Board Info structure
3585iminfo - print header information for application image
3586coninfo - print console devices and informations
3587ide - IDE sub-system
3588loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003589loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003590mtest - simple RAM test
3591icache - enable or disable instruction cache
3592dcache - enable or disable data cache
3593reset - Perform RESET of the CPU
3594echo - echo args to console
3595version - print monitor version
3596help - print online help
3597? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003598
wdenkc6097192002-11-03 00:24:07 +00003599
wdenk2729af92004-05-03 20:45:30 +00003600Monitor Commands - Detailed Description:
3601========================================
wdenkc6097192002-11-03 00:24:07 +00003602
wdenk2729af92004-05-03 20:45:30 +00003603TODO.
wdenkc6097192002-11-03 00:24:07 +00003604
wdenk2729af92004-05-03 20:45:30 +00003605For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003606
3607
wdenk2729af92004-05-03 20:45:30 +00003608Environment Variables:
3609======================
wdenkc6097192002-11-03 00:24:07 +00003610
wdenk2729af92004-05-03 20:45:30 +00003611U-Boot supports user configuration using Environment Variables which
3612can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003613
wdenk2729af92004-05-03 20:45:30 +00003614Environment Variables are set using "setenv", printed using
3615"printenv", and saved to Flash using "saveenv". Using "setenv"
3616without a value can be used to delete a variable from the
3617environment. As long as you don't save the environment you are
3618working with an in-memory copy. In case the Flash area containing the
3619environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003620
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003621Some configuration options can be set using Environment Variables.
3622
3623List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003624
wdenk2729af92004-05-03 20:45:30 +00003625 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003626
wdenk2729af92004-05-03 20:45:30 +00003627 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003628
wdenk2729af92004-05-03 20:45:30 +00003629 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003630
wdenk2729af92004-05-03 20:45:30 +00003631 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003632
wdenk2729af92004-05-03 20:45:30 +00003633 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003634
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003635 bootm_low - Memory range available for image processing in the bootm
3636 command can be restricted. This variable is given as
3637 a hexadecimal number and defines lowest address allowed
3638 for use by the bootm command. See also "bootm_size"
3639 environment variable. Address defined by "bootm_low" is
3640 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003641 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3642 bootm_mapsize.
3643
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003644 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003645 This variable is given as a hexadecimal number and it
3646 defines the size of the memory region starting at base
3647 address bootm_low that is accessible by the Linux kernel
3648 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3649 as the default value if it is defined, and bootm_size is
3650 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003651
3652 bootm_size - Memory range available for image processing in the bootm
3653 command can be restricted. This variable is given as
3654 a hexadecimal number and defines the size of the region
3655 allowed for use by the bootm command. See also "bootm_low"
3656 environment variable.
3657
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003658 updatefile - Location of the software update file on a TFTP server, used
3659 by the automatic software update feature. Please refer to
3660 documentation in doc/README.update for more details.
3661
wdenk2729af92004-05-03 20:45:30 +00003662 autoload - if set to "no" (any string beginning with 'n'),
3663 "bootp" will just load perform a lookup of the
3664 configuration from the BOOTP server, but not try to
3665 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667 autostart - if set to "yes", an image loaded using the "bootp",
3668 "rarpboot", "tftpboot" or "diskboot" commands will
3669 be automatically started (by internally calling
3670 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003671
wdenk2729af92004-05-03 20:45:30 +00003672 If set to "no", a standalone image passed to the
3673 "bootm" command will be copied to the load address
3674 (and eventually uncompressed), but NOT be started.
3675 This can be used to load and uncompress arbitrary
3676 data.
wdenkc6097192002-11-03 00:24:07 +00003677
David A. Longa28afca2011-07-09 16:40:19 -04003678 fdt_high - if set this restricts the maximum address that the
3679 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003680 For example, if you have a system with 1 GB memory
3681 at physical address 0x10000000, while Linux kernel
3682 only recognizes the first 704 MB as low memory, you
3683 may need to set fdt_high as 0x3C000000 to have the
3684 device tree blob be copied to the maximum address
3685 of the 704 MB low memory, so that Linux kernel can
3686 access it during the boot procedure.
3687
David A. Longa28afca2011-07-09 16:40:19 -04003688 If this is set to the special value 0xFFFFFFFF then
3689 the fdt will not be copied at all on boot. For this
3690 to work it must reside in writable memory, have
3691 sufficient padding on the end of it for u-boot to
3692 add the information it needs into it, and the memory
3693 must be accessible by the kernel.
3694
Simon Glasseea63e02011-10-24 19:15:34 +00003695 fdtcontroladdr- if set this is the address of the control flattened
3696 device tree used by U-Boot when CONFIG_OF_CONTROL is
3697 defined.
3698
wdenk17ea1172004-06-06 21:51:03 +00003699 i2cfast - (PPC405GP|PPC405EP only)
3700 if set to 'y' configures Linux I2C driver for fast
3701 mode (400kHZ). This environment variable is used in
3702 initialization code. So, for changes to be effective
3703 it must be saved and board must be reset.
3704
wdenk2729af92004-05-03 20:45:30 +00003705 initrd_high - restrict positioning of initrd images:
3706 If this variable is not set, initrd images will be
3707 copied to the highest possible address in RAM; this
3708 is usually what you want since it allows for
3709 maximum initrd size. If for some reason you want to
3710 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003711 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003712 variable to a value of "no" or "off" or "0".
3713 Alternatively, you can set it to a maximum upper
3714 address to use (U-Boot will still check that it
3715 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003716
wdenk2729af92004-05-03 20:45:30 +00003717 For instance, when you have a system with 16 MB
3718 RAM, and want to reserve 4 MB from use by Linux,
3719 you can do this by adding "mem=12M" to the value of
3720 the "bootargs" variable. However, now you must make
3721 sure that the initrd image is placed in the first
3722 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003723
wdenk2729af92004-05-03 20:45:30 +00003724 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003725
wdenk2729af92004-05-03 20:45:30 +00003726 If you set initrd_high to 0xFFFFFFFF, this is an
3727 indication to U-Boot that all addresses are legal
3728 for the Linux kernel, including addresses in flash
3729 memory. In this case U-Boot will NOT COPY the
3730 ramdisk at all. This may be useful to reduce the
3731 boot time on your system, but requires that this
3732 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003733
wdenk2729af92004-05-03 20:45:30 +00003734 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003735
wdenk2729af92004-05-03 20:45:30 +00003736 loadaddr - Default load address for commands like "bootp",
3737 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk2729af92004-05-03 20:45:30 +00003739 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003740
wdenk2729af92004-05-03 20:45:30 +00003741 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003742
wdenk2729af92004-05-03 20:45:30 +00003743 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003744
wdenk2729af92004-05-03 20:45:30 +00003745 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003746
wdenk2729af92004-05-03 20:45:30 +00003747 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003748
Mike Frysingere2a53452011-10-02 10:01:27 +00003749 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003750
Mike Frysingere2a53452011-10-02 10:01:27 +00003751 ethact - controls which interface is currently active.
3752 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003753
Heiko Schocher48690d82010-07-20 17:45:02 +02003754 => setenv ethact FEC
3755 => ping 192.168.0.1 # traffic sent on FEC
3756 => setenv ethact SCC
3757 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003758
Matthias Fuchse1692572008-01-17 07:45:05 +01003759 ethrotate - When set to "no" U-Boot does not go through all
3760 available network interfaces.
3761 It just stays at the currently selected interface.
3762
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003763 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003764 either succeed or fail without retrying.
3765 When set to "once" the network operation will
3766 fail when all the available network interfaces
3767 are tried once without success.
3768 Useful on scripts which control the retry operation
3769 themselves.
wdenkc6097192002-11-03 00:24:07 +00003770
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003771 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003772
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003773 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003774 UDP source port.
3775
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003776 tftpdstport - If this is set, the value is used for TFTP's UDP
3777 destination port instead of the Well Know Port 69.
3778
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003779 tftpblocksize - Block size to use for TFTP transfers; if not set,
3780 we use the TFTP server's default block size
3781
3782 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3783 seconds, minimum value is 1000 = 1 second). Defines
3784 when a packet is considered to be lost so it has to
3785 be retransmitted. The default is 5000 = 5 seconds.
3786 Lowering this value may make downloads succeed
3787 faster in networks with high packet loss rates or
3788 with unreliable TFTP servers.
3789
3790 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003791 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003792 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003793
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003794The following image location variables contain the location of images
3795used in booting. The "Image" column gives the role of the image and is
3796not an environment variable name. The other columns are environment
3797variable names. "File Name" gives the name of the file on a TFTP
3798server, "RAM Address" gives the location in RAM the image will be
3799loaded to, and "Flash Location" gives the image's address in NOR
3800flash or offset in NAND flash.
3801
3802*Note* - these variables don't have to be defined for all boards, some
3803boards currenlty use other variables for these purposes, and some
3804boards use these variables for other purposes.
3805
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003806Image File Name RAM Address Flash Location
3807----- --------- ----------- --------------
3808u-boot u-boot u-boot_addr_r u-boot_addr
3809Linux kernel bootfile kernel_addr_r kernel_addr
3810device tree blob fdtfile fdt_addr_r fdt_addr
3811ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003812
wdenk2729af92004-05-03 20:45:30 +00003813The following environment variables may be used and automatically
3814updated by the network boot commands ("bootp" and "rarpboot"),
3815depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003816
wdenk2729af92004-05-03 20:45:30 +00003817 bootfile - see above
3818 dnsip - IP address of your Domain Name Server
3819 dnsip2 - IP address of your secondary Domain Name Server
3820 gatewayip - IP address of the Gateway (Router) to use
3821 hostname - Target hostname
3822 ipaddr - see above
3823 netmask - Subnet Mask
3824 rootpath - Pathname of the root filesystem on the NFS server
3825 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003826
wdenka3d991b2004-04-15 21:48:45 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003829
wdenk2729af92004-05-03 20:45:30 +00003830 serial# - contains hardware identification information such
3831 as type string and/or serial number
3832 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003833
wdenk2729af92004-05-03 20:45:30 +00003834These variables can be set only once (usually during manufacturing of
3835the board). U-Boot refuses to delete or overwrite these variables
3836once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003837
3838
wdenk2729af92004-05-03 20:45:30 +00003839Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003840
wdenk2729af92004-05-03 20:45:30 +00003841 ver - Contains the U-Boot version string as printed
3842 with the "version" command. This variable is
3843 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003844
wdenkc6097192002-11-03 00:24:07 +00003845
wdenk2729af92004-05-03 20:45:30 +00003846Please note that changes to some configuration parameters may take
3847only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003848
stroesec1551ea2003-04-04 15:53:41 +00003849
wdenk2729af92004-05-03 20:45:30 +00003850Command Line Parsing:
3851=====================
stroesec1551ea2003-04-04 15:53:41 +00003852
wdenk2729af92004-05-03 20:45:30 +00003853There are two different command line parsers available with U-Boot:
3854the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003855
wdenk2729af92004-05-03 20:45:30 +00003856Old, simple command line parser:
3857--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003858
wdenk2729af92004-05-03 20:45:30 +00003859- supports environment variables (through setenv / saveenv commands)
3860- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003861- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003862- special characters ('$', ';') can be escaped by prefixing with '\',
3863 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003864 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003865- You can also escape text by enclosing in single apostrophes, for example:
3866 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003867
wdenk2729af92004-05-03 20:45:30 +00003868Hush shell:
3869-----------
wdenkf07771c2003-05-28 08:06:31 +00003870
wdenk2729af92004-05-03 20:45:30 +00003871- similar to Bourne shell, with control structures like
3872 if...then...else...fi, for...do...done; while...do...done,
3873 until...do...done, ...
3874- supports environment ("global") variables (through setenv / saveenv
3875 commands) and local shell variables (through standard shell syntax
3876 "name=value"); only environment variables can be used with "run"
3877 command
wdenkf07771c2003-05-28 08:06:31 +00003878
wdenk2729af92004-05-03 20:45:30 +00003879General rules:
3880--------------
wdenkf07771c2003-05-28 08:06:31 +00003881
wdenk2729af92004-05-03 20:45:30 +00003882(1) If a command line (or an environment variable executed by a "run"
3883 command) contains several commands separated by semicolon, and
3884 one of these commands fails, then the remaining commands will be
3885 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003886
wdenk2729af92004-05-03 20:45:30 +00003887(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003888 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003889 command will cause "run" to terminate, i. e. the remaining
3890 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003891
wdenk2729af92004-05-03 20:45:30 +00003892Note for Redundant Ethernet Interfaces:
3893=======================================
wdenkf07771c2003-05-28 08:06:31 +00003894
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003895Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003896such configurations and is capable of automatic selection of a
3897"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003898
wdenk2729af92004-05-03 20:45:30 +00003899Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3900MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3901"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003902
wdenk2729af92004-05-03 20:45:30 +00003903If the network interface stores some valid MAC address (for instance
3904in SROM), this is used as default address if there is NO correspon-
3905ding setting in the environment; if the corresponding environment
3906variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003907
wdenk2729af92004-05-03 20:45:30 +00003908o If the SROM has a valid MAC address, and there is no address in the
3909 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003910
wdenk2729af92004-05-03 20:45:30 +00003911o If there is no valid address in the SROM, and a definition in the
3912 environment exists, then the value from the environment variable is
3913 used.
wdenkc6097192002-11-03 00:24:07 +00003914
wdenk2729af92004-05-03 20:45:30 +00003915o If both the SROM and the environment contain a MAC address, and
3916 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003917
wdenk2729af92004-05-03 20:45:30 +00003918o If both the SROM and the environment contain a MAC address, and the
3919 addresses differ, the value from the environment is used and a
3920 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003921
wdenk2729af92004-05-03 20:45:30 +00003922o If neither SROM nor the environment contain a MAC address, an error
3923 is raised.
wdenkc6097192002-11-03 00:24:07 +00003924
Ben Warrenecee9322010-04-26 11:11:46 -07003925If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003926will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07003927may be skipped by setting the appropriate 'ethmacskip' environment variable.
3928The naming convention is as follows:
3929"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00003930
wdenk2729af92004-05-03 20:45:30 +00003931Image Formats:
3932==============
wdenkc6097192002-11-03 00:24:07 +00003933
Marian Balakowicz3310c542008-03-12 12:13:13 +01003934U-Boot is capable of booting (and performing other auxiliary operations on)
3935images in two formats:
3936
3937New uImage format (FIT)
3938-----------------------
3939
3940Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3941to Flattened Device Tree). It allows the use of images with multiple
3942components (several kernels, ramdisks, etc.), with contents protected by
3943SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3944
3945
3946Old uImage format
3947-----------------
3948
3949Old image format is based on binary files which can be basically anything,
3950preceded by a special header; see the definitions in include/image.h for
3951details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003952
wdenk2729af92004-05-03 20:45:30 +00003953* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3954 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003955 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3956 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3957 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003958* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00003959 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3960 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003961* Compression Type (uncompressed, gzip, bzip2)
3962* Load Address
3963* Entry Point
3964* Image Name
3965* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003966
wdenk2729af92004-05-03 20:45:30 +00003967The header is marked by a special Magic Number, and both the header
3968and the data portions of the image are secured against corruption by
3969CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003970
wdenkc6097192002-11-03 00:24:07 +00003971
wdenk2729af92004-05-03 20:45:30 +00003972Linux Support:
3973==============
wdenkc6097192002-11-03 00:24:07 +00003974
wdenk2729af92004-05-03 20:45:30 +00003975Although U-Boot should support any OS or standalone application
3976easily, the main focus has always been on Linux during the design of
3977U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003978
wdenk2729af92004-05-03 20:45:30 +00003979U-Boot includes many features that so far have been part of some
3980special "boot loader" code within the Linux kernel. Also, any
3981"initrd" images to be used are no longer part of one big Linux image;
3982instead, kernel and "initrd" are separate images. This implementation
3983serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003984
wdenk2729af92004-05-03 20:45:30 +00003985- the same features can be used for other OS or standalone
3986 applications (for instance: using compressed images to reduce the
3987 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003988
wdenk2729af92004-05-03 20:45:30 +00003989- it becomes much easier to port new Linux kernel versions because
3990 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992- the same Linux kernel image can now be used with different "initrd"
3993 images; of course this also means that different kernel images can
3994 be run with the same "initrd". This makes testing easier (you don't
3995 have to build a new "zImage.initrd" Linux image when you just
3996 change a file in your "initrd"). Also, a field-upgrade of the
3997 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003998
wdenkc6097192002-11-03 00:24:07 +00003999
wdenk2729af92004-05-03 20:45:30 +00004000Linux HOWTO:
4001============
wdenkc6097192002-11-03 00:24:07 +00004002
wdenk2729af92004-05-03 20:45:30 +00004003Porting Linux to U-Boot based systems:
4004---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004005
wdenk2729af92004-05-03 20:45:30 +00004006U-Boot cannot save you from doing all the necessary modifications to
4007configure the Linux device drivers for use with your target hardware
4008(no, we don't intend to provide a full virtual machine interface to
4009Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004010
Stefan Roesea47a12b2010-04-15 16:07:28 +02004011But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004012
wdenk2729af92004-05-03 20:45:30 +00004013Just make sure your machine specific header file (for instance
4014include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004015Information structure as we define in include/asm-<arch>/u-boot.h,
4016and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004017as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004018
wdenkc6097192002-11-03 00:24:07 +00004019
wdenk2729af92004-05-03 20:45:30 +00004020Configuring the Linux kernel:
4021-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004022
wdenk2729af92004-05-03 20:45:30 +00004023No specific requirements for U-Boot. Make sure you have some root
4024device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004025
wdenkc6097192002-11-03 00:24:07 +00004026
wdenk2729af92004-05-03 20:45:30 +00004027Building a Linux Image:
4028-----------------------
wdenkc6097192002-11-03 00:24:07 +00004029
wdenk2729af92004-05-03 20:45:30 +00004030With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4031not used. If you use recent kernel source, a new build target
4032"uImage" will exist which automatically builds an image usable by
4033U-Boot. Most older kernels also have support for a "pImage" target,
4034which was introduced for our predecessor project PPCBoot and uses a
4035100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004036
wdenk2729af92004-05-03 20:45:30 +00004037Example:
wdenkc6097192002-11-03 00:24:07 +00004038
wdenk2729af92004-05-03 20:45:30 +00004039 make TQM850L_config
4040 make oldconfig
4041 make dep
4042 make uImage
wdenkc6097192002-11-03 00:24:07 +00004043
wdenk2729af92004-05-03 20:45:30 +00004044The "uImage" build target uses a special tool (in 'tools/mkimage') to
4045encapsulate a compressed Linux kernel image with header information,
4046CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004047
wdenk2729af92004-05-03 20:45:30 +00004048* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004049
wdenk2729af92004-05-03 20:45:30 +00004050* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004051
wdenk2729af92004-05-03 20:45:30 +00004052 ${CROSS_COMPILE}-objcopy -O binary \
4053 -R .note -R .comment \
4054 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004055
wdenk2729af92004-05-03 20:45:30 +00004056* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004057
wdenk2729af92004-05-03 20:45:30 +00004058 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004059
wdenk2729af92004-05-03 20:45:30 +00004060* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004061
wdenk2729af92004-05-03 20:45:30 +00004062 mkimage -A ppc -O linux -T kernel -C gzip \
4063 -a 0 -e 0 -n "Linux Kernel Image" \
4064 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004065
wdenk24ee89b2002-11-03 17:56:27 +00004066
wdenk2729af92004-05-03 20:45:30 +00004067The "mkimage" tool can also be used to create ramdisk images for use
4068with U-Boot, either separated from the Linux kernel image, or
4069combined into one file. "mkimage" encapsulates the images with a 64
4070byte header containing information about target architecture,
4071operating system, image type, compression method, entry points, time
4072stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004073
wdenk2729af92004-05-03 20:45:30 +00004074"mkimage" can be called in two ways: to verify existing images and
4075print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004076
wdenk2729af92004-05-03 20:45:30 +00004077In the first form (with "-l" option) mkimage lists the information
4078contained in the header of an existing U-Boot image; this includes
4079checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081 tools/mkimage -l image
4082 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004083
wdenk2729af92004-05-03 20:45:30 +00004084The second form (with "-d" option) is used to build a U-Boot image
4085from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004086
wdenk2729af92004-05-03 20:45:30 +00004087 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4088 -n name -d data_file image
4089 -A ==> set architecture to 'arch'
4090 -O ==> set operating system to 'os'
4091 -T ==> set image type to 'type'
4092 -C ==> set compression type 'comp'
4093 -a ==> set load address to 'addr' (hex)
4094 -e ==> set entry point to 'ep' (hex)
4095 -n ==> set image name to 'name'
4096 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004097
wdenk69459792004-05-29 16:53:29 +00004098Right now, all Linux kernels for PowerPC systems use the same load
4099address (0x00000000), but the entry point address depends on the
4100kernel version:
wdenkc6097192002-11-03 00:24:07 +00004101
wdenk2729af92004-05-03 20:45:30 +00004102- 2.2.x kernels have the entry point at 0x0000000C,
4103- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004104
wdenk2729af92004-05-03 20:45:30 +00004105So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004106
wdenk2729af92004-05-03 20:45:30 +00004107 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4108 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004109 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004110 > examples/uImage.TQM850L
4111 Image Name: 2.4.4 kernel for TQM850L
4112 Created: Wed Jul 19 02:34:59 2000
4113 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4114 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4115 Load Address: 0x00000000
4116 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk2729af92004-05-03 20:45:30 +00004118To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004119
wdenk2729af92004-05-03 20:45:30 +00004120 -> tools/mkimage -l examples/uImage.TQM850L
4121 Image Name: 2.4.4 kernel for TQM850L
4122 Created: Wed Jul 19 02:34:59 2000
4123 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4124 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4125 Load Address: 0x00000000
4126 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004127
wdenk2729af92004-05-03 20:45:30 +00004128NOTE: for embedded systems where boot time is critical you can trade
4129speed for memory and install an UNCOMPRESSED image instead: this
4130needs more space in Flash, but boots much faster since it does not
4131need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004132
Stefan Roesea47a12b2010-04-15 16:07:28 +02004133 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004134 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4135 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004136 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004137 > examples/uImage.TQM850L-uncompressed
4138 Image Name: 2.4.4 kernel for TQM850L
4139 Created: Wed Jul 19 02:34:59 2000
4140 Image Type: PowerPC Linux Kernel Image (uncompressed)
4141 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4142 Load Address: 0x00000000
4143 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004144
wdenkc6097192002-11-03 00:24:07 +00004145
wdenk2729af92004-05-03 20:45:30 +00004146Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4147when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004148
wdenk2729af92004-05-03 20:45:30 +00004149 -> tools/mkimage -n 'Simple Ramdisk Image' \
4150 > -A ppc -O linux -T ramdisk -C gzip \
4151 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4152 Image Name: Simple Ramdisk Image
4153 Created: Wed Jan 12 14:01:50 2000
4154 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4155 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4156 Load Address: 0x00000000
4157 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004158
wdenkdb01a2e2004-04-15 23:14:49 +00004159
wdenk2729af92004-05-03 20:45:30 +00004160Installing a Linux Image:
4161-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004162
wdenk2729af92004-05-03 20:45:30 +00004163To downloading a U-Boot image over the serial (console) interface,
4164you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004167
wdenk2729af92004-05-03 20:45:30 +00004168The 'objcopy' does not understand the information in the U-Boot
4169image header, so the resulting S-Record file will be relative to
4170address 0x00000000. To load it to a given address, you need to
4171specify the target address as 'offset' parameter with the 'loads'
4172command.
wdenkc6097192002-11-03 00:24:07 +00004173
wdenk2729af92004-05-03 20:45:30 +00004174Example: install the image to address 0x40100000 (which on the
4175TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004176
wdenk2729af92004-05-03 20:45:30 +00004177 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179 .......... done
4180 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004181
wdenk2729af92004-05-03 20:45:30 +00004182 => loads 40100000
4183 ## Ready for S-Record download ...
4184 ~>examples/image.srec
4185 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4186 ...
4187 15989 15990 15991 15992
4188 [file transfer complete]
4189 [connected]
4190 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004191
4192
wdenk2729af92004-05-03 20:45:30 +00004193You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004194this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004195corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004198
wdenk2729af92004-05-03 20:45:30 +00004199 ## Checking Image at 40100000 ...
4200 Image Name: 2.2.13 for initrd on TQM850L
4201 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4202 Data Size: 335725 Bytes = 327 kB = 0 MB
4203 Load Address: 00000000
4204 Entry Point: 0000000c
4205 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004206
4207
wdenk2729af92004-05-03 20:45:30 +00004208Boot Linux:
4209-----------
wdenkc6097192002-11-03 00:24:07 +00004210
wdenk2729af92004-05-03 20:45:30 +00004211The "bootm" command is used to boot an application that is stored in
4212memory (RAM or Flash). In case of a Linux kernel image, the contents
4213of the "bootargs" environment variable is passed to the kernel as
4214parameters. You can check and modify this variable using the
4215"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004216
4217
wdenk2729af92004-05-03 20:45:30 +00004218 => printenv bootargs
4219 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004220
wdenk2729af92004-05-03 20:45:30 +00004221 => 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 +00004222
wdenk2729af92004-05-03 20:45:30 +00004223 => printenv bootargs
4224 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 +00004225
wdenk2729af92004-05-03 20:45:30 +00004226 => bootm 40020000
4227 ## Booting Linux kernel at 40020000 ...
4228 Image Name: 2.2.13 for NFS on TQM850L
4229 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4230 Data Size: 381681 Bytes = 372 kB = 0 MB
4231 Load Address: 00000000
4232 Entry Point: 0000000c
4233 Verifying Checksum ... OK
4234 Uncompressing Kernel Image ... OK
4235 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
4236 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4237 time_init: decrementer frequency = 187500000/60
4238 Calibrating delay loop... 49.77 BogoMIPS
4239 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4240 ...
wdenkc6097192002-11-03 00:24:07 +00004241
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004242If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004243the memory addresses of both the kernel and the initrd image (PPBCOOT
4244format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk2729af92004-05-03 20:45:30 +00004246 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004247
wdenk2729af92004-05-03 20:45:30 +00004248 ## Checking Image at 40100000 ...
4249 Image Name: 2.2.13 for initrd on TQM850L
4250 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4251 Data Size: 335725 Bytes = 327 kB = 0 MB
4252 Load Address: 00000000
4253 Entry Point: 0000000c
4254 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004255
wdenk2729af92004-05-03 20:45:30 +00004256 ## Checking Image at 40200000 ...
4257 Image Name: Simple Ramdisk Image
4258 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4259 Data Size: 566530 Bytes = 553 kB = 0 MB
4260 Load Address: 00000000
4261 Entry Point: 00000000
4262 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264 => bootm 40100000 40200000
4265 ## Booting Linux kernel at 40100000 ...
4266 Image Name: 2.2.13 for initrd on TQM850L
4267 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4268 Data Size: 335725 Bytes = 327 kB = 0 MB
4269 Load Address: 00000000
4270 Entry Point: 0000000c
4271 Verifying Checksum ... OK
4272 Uncompressing Kernel Image ... OK
4273 ## Loading RAMDisk Image at 40200000 ...
4274 Image Name: Simple Ramdisk Image
4275 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4276 Data Size: 566530 Bytes = 553 kB = 0 MB
4277 Load Address: 00000000
4278 Entry Point: 00000000
4279 Verifying Checksum ... OK
4280 Loading Ramdisk ... OK
4281 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
4282 Boot arguments: root=/dev/ram
4283 time_init: decrementer frequency = 187500000/60
4284 Calibrating delay loop... 49.77 BogoMIPS
4285 ...
4286 RAMDISK: Compressed image found at block 0
4287 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004288
wdenk2729af92004-05-03 20:45:30 +00004289 bash#
wdenkc6097192002-11-03 00:24:07 +00004290
Matthew McClintock02677682006-06-28 10:41:37 -05004291Boot Linux and pass a flat device tree:
4292-----------
4293
4294First, U-Boot must be compiled with the appropriate defines. See the section
4295titled "Linux Kernel Interface" above for a more in depth explanation. The
4296following is an example of how to start a kernel and pass an updated
4297flat device tree:
4298
4299=> print oftaddr
4300oftaddr=0x300000
4301=> print oft
4302oft=oftrees/mpc8540ads.dtb
4303=> tftp $oftaddr $oft
4304Speed: 1000, full duplex
4305Using TSEC0 device
4306TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4307Filename 'oftrees/mpc8540ads.dtb'.
4308Load address: 0x300000
4309Loading: #
4310done
4311Bytes transferred = 4106 (100a hex)
4312=> tftp $loadaddr $bootfile
4313Speed: 1000, full duplex
4314Using TSEC0 device
4315TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4316Filename 'uImage'.
4317Load address: 0x200000
4318Loading:############
4319done
4320Bytes transferred = 1029407 (fb51f hex)
4321=> print loadaddr
4322loadaddr=200000
4323=> print oftaddr
4324oftaddr=0x300000
4325=> bootm $loadaddr - $oftaddr
4326## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004327 Image Name: Linux-2.6.17-dirty
4328 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4329 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004330 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004331 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004332 Verifying Checksum ... OK
4333 Uncompressing Kernel Image ... OK
4334Booting using flat device tree at 0x300000
4335Using MPC85xx ADS machine description
4336Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4337[snip]
4338
4339
wdenk2729af92004-05-03 20:45:30 +00004340More About U-Boot Image Types:
4341------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004342
wdenk2729af92004-05-03 20:45:30 +00004343U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004344
wdenk2729af92004-05-03 20:45:30 +00004345 "Standalone Programs" are directly runnable in the environment
4346 provided by U-Boot; it is expected that (if they behave
4347 well) you can continue to work in U-Boot after return from
4348 the Standalone Program.
4349 "OS Kernel Images" are usually images of some Embedded OS which
4350 will take over control completely. Usually these programs
4351 will install their own set of exception handlers, device
4352 drivers, set up the MMU, etc. - this means, that you cannot
4353 expect to re-enter U-Boot except by resetting the CPU.
4354 "RAMDisk Images" are more or less just data blocks, and their
4355 parameters (address, size) are passed to an OS kernel that is
4356 being started.
4357 "Multi-File Images" contain several images, typically an OS
4358 (Linux) kernel image and one or more data images like
4359 RAMDisks. This construct is useful for instance when you want
4360 to boot over the network using BOOTP etc., where the boot
4361 server provides just a single image file, but you want to get
4362 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004363
wdenk2729af92004-05-03 20:45:30 +00004364 "Multi-File Images" start with a list of image sizes, each
4365 image size (in bytes) specified by an "uint32_t" in network
4366 byte order. This list is terminated by an "(uint32_t)0".
4367 Immediately after the terminating 0 follow the images, one by
4368 one, all aligned on "uint32_t" boundaries (size rounded up to
4369 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004370
wdenk2729af92004-05-03 20:45:30 +00004371 "Firmware Images" are binary images containing firmware (like
4372 U-Boot or FPGA images) which usually will be programmed to
4373 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004374
wdenk2729af92004-05-03 20:45:30 +00004375 "Script files" are command sequences that will be executed by
4376 U-Boot's command interpreter; this feature is especially
4377 useful when you configure U-Boot to use a real shell (hush)
4378 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004379
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk2729af92004-05-03 20:45:30 +00004381Standalone HOWTO:
4382=================
wdenkc6097192002-11-03 00:24:07 +00004383
wdenk2729af92004-05-03 20:45:30 +00004384One of the features of U-Boot is that you can dynamically load and
4385run "standalone" applications, which can use some resources of
4386U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004387
wdenk2729af92004-05-03 20:45:30 +00004388Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004389
wdenk2729af92004-05-03 20:45:30 +00004390"Hello World" Demo:
4391-------------------
wdenkc6097192002-11-03 00:24:07 +00004392
wdenk2729af92004-05-03 20:45:30 +00004393'examples/hello_world.c' contains a small "Hello World" Demo
4394application; it is automatically compiled when you build U-Boot.
4395It's configured to run at address 0x00040004, so you can play with it
4396like that:
wdenkc6097192002-11-03 00:24:07 +00004397
wdenk2729af92004-05-03 20:45:30 +00004398 => loads
4399 ## Ready for S-Record download ...
4400 ~>examples/hello_world.srec
4401 1 2 3 4 5 6 7 8 9 10 11 ...
4402 [file transfer complete]
4403 [connected]
4404 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406 => go 40004 Hello World! This is a test.
4407 ## Starting application at 0x00040004 ...
4408 Hello World
4409 argc = 7
4410 argv[0] = "40004"
4411 argv[1] = "Hello"
4412 argv[2] = "World!"
4413 argv[3] = "This"
4414 argv[4] = "is"
4415 argv[5] = "a"
4416 argv[6] = "test."
4417 argv[7] = "<NULL>"
4418 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004419
wdenk2729af92004-05-03 20:45:30 +00004420 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004421
wdenk2729af92004-05-03 20:45:30 +00004422Another example, which demonstrates how to register a CPM interrupt
4423handler with the U-Boot code, can be found in 'examples/timer.c'.
4424Here, a CPM timer is set up to generate an interrupt every second.
4425The interrupt service routine is trivial, just printing a '.'
4426character, but this is just a demo program. The application can be
4427controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004428
wdenk2729af92004-05-03 20:45:30 +00004429 ? - print current values og the CPM Timer registers
4430 b - enable interrupts and start timer
4431 e - stop timer and disable interrupts
4432 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004433
wdenk2729af92004-05-03 20:45:30 +00004434 => loads
4435 ## Ready for S-Record download ...
4436 ~>examples/timer.srec
4437 1 2 3 4 5 6 7 8 9 10 11 ...
4438 [file transfer complete]
4439 [connected]
4440 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk2729af92004-05-03 20:45:30 +00004442 => go 40004
4443 ## Starting application at 0x00040004 ...
4444 TIMERS=0xfff00980
4445 Using timer 1
4446 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004447
wdenk2729af92004-05-03 20:45:30 +00004448Hit 'b':
4449 [q, b, e, ?] Set interval 1000000 us
4450 Enabling timer
4451Hit '?':
4452 [q, b, e, ?] ........
4453 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4454Hit '?':
4455 [q, b, e, ?] .
4456 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4457Hit '?':
4458 [q, b, e, ?] .
4459 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4460Hit '?':
4461 [q, b, e, ?] .
4462 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4463Hit 'e':
4464 [q, b, e, ?] ...Stopping timer
4465Hit 'q':
4466 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004467
4468
wdenk2729af92004-05-03 20:45:30 +00004469Minicom warning:
4470================
wdenk85ec0bc2003-03-31 16:34:49 +00004471
wdenk2729af92004-05-03 20:45:30 +00004472Over time, many people have reported problems when trying to use the
4473"minicom" terminal emulation program for serial download. I (wd)
4474consider minicom to be broken, and recommend not to use it. Under
4475Unix, I recommend to use C-Kermit for general purpose use (and
4476especially for kermit binary protocol download ("loadb" command), and
4477use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004478
wdenk2729af92004-05-03 20:45:30 +00004479Nevertheless, if you absolutely want to use it try adding this
4480configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004481
wdenk2729af92004-05-03 20:45:30 +00004482 Name Program Name U/D FullScr IO-Red. Multi
4483 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4484 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004485
4486
wdenk2729af92004-05-03 20:45:30 +00004487NetBSD Notes:
4488=============
wdenkc6097192002-11-03 00:24:07 +00004489
wdenk2729af92004-05-03 20:45:30 +00004490Starting at version 0.9.2, U-Boot supports NetBSD both as host
4491(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004492
wdenk2729af92004-05-03 20:45:30 +00004493Building requires a cross environment; it is known to work on
4494NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4495need gmake since the Makefiles are not compatible with BSD make).
4496Note that the cross-powerpc package does not install include files;
4497attempting to build U-Boot will fail because <machine/ansi.h> is
4498missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004499
wdenk2729af92004-05-03 20:45:30 +00004500 # cd /usr/pkg/cross/powerpc-netbsd/include
4501 # mkdir powerpc
4502 # ln -s powerpc machine
4503 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4504 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004505
wdenk2729af92004-05-03 20:45:30 +00004506Native builds *don't* work due to incompatibilities between native
4507and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk2729af92004-05-03 20:45:30 +00004509Booting assumes that (the first part of) the image booted is a
4510stage-2 loader which in turn loads and then invokes the kernel
4511proper. Loader sources will eventually appear in the NetBSD source
4512tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004513meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004514
4515
wdenk2729af92004-05-03 20:45:30 +00004516Implementation Internals:
4517=========================
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk2729af92004-05-03 20:45:30 +00004519The following is not intended to be a complete description of every
4520implementation detail. However, it should help to understand the
4521inner workings of U-Boot and make it easier to port it to custom
4522hardware.
wdenkc6097192002-11-03 00:24:07 +00004523
4524
wdenk2729af92004-05-03 20:45:30 +00004525Initial Stack, Global Data:
4526---------------------------
wdenkc6097192002-11-03 00:24:07 +00004527
wdenk2729af92004-05-03 20:45:30 +00004528The implementation of U-Boot is complicated by the fact that U-Boot
4529starts running out of ROM (flash memory), usually without access to
4530system RAM (because the memory controller is not initialized yet).
4531This means that we don't have writable Data or BSS segments, and BSS
4532is not initialized as zero. To be able to get a C environment working
4533at all, we have to allocate at least a minimal stack. Implementation
4534options for this are defined and restricted by the CPU used: Some CPU
4535models provide on-chip memory (like the IMMR area on MPC8xx and
4536MPC826x processors), on others (parts of) the data cache can be
4537locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004538
Wolfgang Denk218ca722008-03-26 10:40:12 +01004539 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004540 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004541
wdenk2729af92004-05-03 20:45:30 +00004542 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4543 From: "Chris Hallinan" <clh@net1plus.com>
4544 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4545 ...
wdenk43d96162003-03-06 00:02:04 +00004546
wdenk2729af92004-05-03 20:45:30 +00004547 Correct me if I'm wrong, folks, but the way I understand it
4548 is this: Using DCACHE as initial RAM for Stack, etc, does not
4549 require any physical RAM backing up the cache. The cleverness
4550 is that the cache is being used as a temporary supply of
4551 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004552 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004553 can see how this works by studying the cache architecture and
4554 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004555
wdenk2729af92004-05-03 20:45:30 +00004556 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4557 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004558 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004559 option should work for you. Using CS 4 should be fine if your
4560 board designers haven't used it for something that would
4561 cause you grief during the initial boot! It is frequently not
4562 used.
wdenk43d96162003-03-06 00:02:04 +00004563
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004564 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004565 with your processor/board/system design. The default value
4566 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004567 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004568 than your SDRAM module. If you have a 64MB SDRAM module, set
4569 it above 400_0000. Just make sure your board has no resources
4570 that are supposed to respond to that address! That code in
4571 start.S has been around a while and should work as is when
4572 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004573
wdenk2729af92004-05-03 20:45:30 +00004574 -Chris Hallinan
4575 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004576
wdenk2729af92004-05-03 20:45:30 +00004577It is essential to remember this, since it has some impact on the C
4578code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk2729af92004-05-03 20:45:30 +00004580* Initialized global data (data segment) is read-only. Do not attempt
4581 to write it.
wdenkc6097192002-11-03 00:24:07 +00004582
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004583* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004584 as zero data - BSS segment) at all - this is undefined, initiali-
4585 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004586
wdenk2729af92004-05-03 20:45:30 +00004587* Stack space is very limited. Avoid big data buffers or things like
4588 that.
wdenkc6097192002-11-03 00:24:07 +00004589
wdenk2729af92004-05-03 20:45:30 +00004590Having only the stack as writable memory limits means we cannot use
4591normal global data to share information beween the code. But it
4592turned out that the implementation of U-Boot can be greatly
4593simplified by making a global data structure (gd_t) available to all
4594functions. We could pass a pointer to this data as argument to _all_
4595functions, but this would bloat the code. Instead we use a feature of
4596the GCC compiler (Global Register Variables) to share the data: we
4597place a pointer (gd) to the global data into a register which we
4598reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004599
wdenk2729af92004-05-03 20:45:30 +00004600When choosing a register for such a purpose we are restricted by the
4601relevant (E)ABI specifications for the current architecture, and by
4602GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004603
wdenk2729af92004-05-03 20:45:30 +00004604For PowerPC, the following registers have specific use:
4605 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004606 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004607 R3-R4: parameter passing and return values
4608 R5-R10: parameter passing
4609 R13: small data area pointer
4610 R30: GOT pointer
4611 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004612
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004613 (U-Boot also uses R12 as internal GOT pointer. r12
4614 is a volatile register so r12 needs to be reset when
4615 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004616
Wolfgang Denke7670f62008-02-14 22:43:22 +01004617 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004618
wdenk2729af92004-05-03 20:45:30 +00004619 Note: on PPC, we could use a static initializer (since the
4620 address of the global data structure is known at compile time),
4621 but it turned out that reserving a register results in somewhat
4622 smaller code - although the code savings are not that big (on
4623 average for all boards 752 bytes for the whole U-Boot image,
4624 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004625
Robin Getzc4db3352009-08-17 15:23:02 +00004626On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004627 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4628
Robin Getzc4db3352009-08-17 15:23:02 +00004629 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004630
wdenk2729af92004-05-03 20:45:30 +00004631On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk2729af92004-05-03 20:45:30 +00004633 R0: function argument word/integer result
4634 R1-R3: function argument word
4635 R9: GOT pointer
4636 R10: stack limit (used only if stack checking if enabled)
4637 R11: argument (frame) pointer
4638 R12: temporary workspace
4639 R13: stack pointer
4640 R14: link register
4641 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk2729af92004-05-03 20:45:30 +00004643 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004644
Thomas Chou0df01fd2010-05-21 11:08:03 +08004645On Nios II, the ABI is documented here:
4646 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4647
4648 ==> U-Boot will use gp to hold a pointer to the global data
4649
4650 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4651 to access small data sections, so gp is free.
4652
Macpaul Linafc1ce82011-10-19 20:41:11 +00004653On NDS32, the following registers are used:
4654
4655 R0-R1: argument/return
4656 R2-R5: argument
4657 R15: temporary register for assembler
4658 R16: trampoline register
4659 R28: frame pointer (FP)
4660 R29: global pointer (GP)
4661 R30: link register (LP)
4662 R31: stack pointer (SP)
4663 PC: program counter (PC)
4664
4665 ==> U-Boot will use R10 to hold a pointer to the global data
4666
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004667NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4668or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004669
wdenk2729af92004-05-03 20:45:30 +00004670Memory Management:
4671------------------
wdenkc6097192002-11-03 00:24:07 +00004672
wdenk2729af92004-05-03 20:45:30 +00004673U-Boot runs in system state and uses physical addresses, i.e. the
4674MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004675
wdenk2729af92004-05-03 20:45:30 +00004676The available memory is mapped to fixed addresses using the memory
4677controller. In this process, a contiguous block is formed for each
4678memory type (Flash, SDRAM, SRAM), even when it consists of several
4679physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004680
wdenk2729af92004-05-03 20:45:30 +00004681U-Boot is installed in the first 128 kB of the first Flash bank (on
4682TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4683booting and sizing and initializing DRAM, the code relocates itself
4684to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004685memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004686configuration setting]. Below that, a structure with global Board
4687Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004688
wdenk2729af92004-05-03 20:45:30 +00004689Additionally, some exception handler code is copied to the low 8 kB
4690of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004691
wdenk2729af92004-05-03 20:45:30 +00004692So a typical memory configuration with 16 MB of DRAM could look like
4693this:
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk2729af92004-05-03 20:45:30 +00004695 0x0000 0000 Exception Vector code
4696 :
4697 0x0000 1FFF
4698 0x0000 2000 Free for Application Use
4699 :
4700 :
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk2729af92004-05-03 20:45:30 +00004702 :
4703 :
4704 0x00FB FF20 Monitor Stack (Growing downward)
4705 0x00FB FFAC Board Info Data and permanent copy of global data
4706 0x00FC 0000 Malloc Arena
4707 :
4708 0x00FD FFFF
4709 0x00FE 0000 RAM Copy of Monitor Code
4710 ... eventually: LCD or video framebuffer
4711 ... eventually: pRAM (Protected RAM - unchanged by reset)
4712 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004713
4714
wdenk2729af92004-05-03 20:45:30 +00004715System Initialization:
4716----------------------
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk2729af92004-05-03 20:45:30 +00004718In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004719(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004720configuration for CS0# this is a mirror of the onboard Flash memory.
4721To be able to re-map memory U-Boot then jumps to its link address.
4722To be able to implement the initialization code in C, a (small!)
4723initial stack is set up in the internal Dual Ported RAM (in case CPUs
4724which provide such a feature like MPC8xx or MPC8260), or in a locked
4725part of the data cache. After that, U-Boot initializes the CPU core,
4726the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004727
wdenk2729af92004-05-03 20:45:30 +00004728Next, all (potentially) available memory banks are mapped using a
4729preliminary mapping. For example, we put them on 512 MB boundaries
4730(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4731on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4732programmed for SDRAM access. Using the temporary configuration, a
4733simple memory test is run that determines the size of the SDRAM
4734banks.
wdenkc6097192002-11-03 00:24:07 +00004735
wdenk2729af92004-05-03 20:45:30 +00004736When there is more than one SDRAM bank, and the banks are of
4737different size, the largest is mapped first. For equal size, the first
4738bank (CS2#) is mapped first. The first mapping is always for address
47390x00000000, with any additional banks following immediately to create
4740contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004741
wdenk2729af92004-05-03 20:45:30 +00004742Then, the monitor installs itself at the upper end of the SDRAM area
4743and allocates memory for use by malloc() and for the global Board
4744Info data; also, the exception vector code is copied to the low RAM
4745pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk2729af92004-05-03 20:45:30 +00004747Only after this relocation will you have a "normal" C environment;
4748until that you are restricted in several ways, mostly because you are
4749running from ROM, and because the code will have to be relocated to a
4750new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004751
4752
wdenk2729af92004-05-03 20:45:30 +00004753U-Boot Porting Guide:
4754----------------------
wdenkc6097192002-11-03 00:24:07 +00004755
wdenk2729af92004-05-03 20:45:30 +00004756[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4757list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004758
4759
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004760int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004761{
4762 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004763
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004764 signal(SIGALRM, no_more_time);
4765 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk2729af92004-05-03 20:45:30 +00004767 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004768 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004769 return 0;
4770 }
4771
wdenk2729af92004-05-03 20:45:30 +00004772 Download latest U-Boot source;
4773
Wolfgang Denk06682362008-12-30 22:56:11 +01004774 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004775
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004776 if (clueless)
4777 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk2729af92004-05-03 20:45:30 +00004779 while (learning) {
4780 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004781 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4782 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004783 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004784 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004785 }
wdenkc6097192002-11-03 00:24:07 +00004786
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004787 if (available_money > toLocalCurrency ($2500))
4788 Buy a BDI3000;
4789 else
wdenk2729af92004-05-03 20:45:30 +00004790 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004791
4792 if (a similar board exists) { /* hopefully... */
4793 cp -a board/<similar> board/<myboard>
4794 cp include/configs/<similar>.h include/configs/<myboard>.h
4795 } else {
4796 Create your own board support subdirectory;
4797 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004798 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004799 Edit new board/<myboard> files
4800 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004801
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004802 while (!accepted) {
4803 while (!running) {
4804 do {
4805 Add / modify source code;
4806 } until (compiles);
4807 Debug;
4808 if (clueless)
4809 email("Hi, I am having problems...");
4810 }
4811 Send patch file to the U-Boot email list;
4812 if (reasonable critiques)
4813 Incorporate improvements from email list code review;
4814 else
4815 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004816 }
wdenkc6097192002-11-03 00:24:07 +00004817
wdenk2729af92004-05-03 20:45:30 +00004818 return 0;
4819}
4820
4821void no_more_time (int sig)
4822{
4823 hire_a_guru();
4824}
wdenkc6097192002-11-03 00:24:07 +00004825
4826
wdenk2729af92004-05-03 20:45:30 +00004827Coding Standards:
4828-----------------
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk2729af92004-05-03 20:45:30 +00004830All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004831coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004832"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004833
Detlev Zundel2c051652006-09-01 15:39:02 +02004834Source files originating from a different project (for example the
4835MTD subsystem) are generally exempt from these guidelines and are not
4836reformated to ease subsequent migration to newer versions of those
4837sources.
4838
4839Please note that U-Boot is implemented in C (and to some small parts in
4840Assembler); no C++ is used, so please do not use C++ style comments (//)
4841in your code.
wdenk2729af92004-05-03 20:45:30 +00004842
4843Please also stick to the following formatting rules:
4844- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004845- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004846- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004847- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004848- do not add trailing empty lines to source files
4849
4850Submissions which do not conform to the standards may be returned
4851with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004852
4853
wdenk2729af92004-05-03 20:45:30 +00004854Submitting Patches:
4855-------------------
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk2729af92004-05-03 20:45:30 +00004857Since the number of patches for U-Boot is growing, we need to
4858establish some rules. Submissions which do not conform to these rules
4859may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004860
Magnus Lilja0d28f342008-08-06 19:32:33 +02004861Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004862
Wolfgang Denk06682362008-12-30 22:56:11 +01004863Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4864see http://lists.denx.de/mailman/listinfo/u-boot
4865
wdenk2729af92004-05-03 20:45:30 +00004866When you send a patch, please include the following information with
4867it:
wdenkc6097192002-11-03 00:24:07 +00004868
wdenk2729af92004-05-03 20:45:30 +00004869* For bug fixes: a description of the bug and how your patch fixes
4870 this bug. Please try to include a way of demonstrating that the
4871 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004872
wdenk2729af92004-05-03 20:45:30 +00004873* For new features: a description of the feature and your
4874 implementation.
wdenkc6097192002-11-03 00:24:07 +00004875
wdenk2729af92004-05-03 20:45:30 +00004876* A CHANGELOG entry as plaintext (separate from the patch)
4877
4878* For major contributions, your entry to the CREDITS file
4879
4880* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004881 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004882
4883* If your patch adds new configuration options, don't forget to
4884 document these in the README file.
4885
Wolfgang Denk218ca722008-03-26 10:40:12 +01004886* The patch itself. If you are using git (which is *strongly*
4887 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004888 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01004889 the U-Boot mailing list, you will avoid most of the common problems
4890 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004891
Wolfgang Denk218ca722008-03-26 10:40:12 +01004892 If you cannot use git, use "diff -purN OLD NEW". If your version of
4893 diff does not support these options, then get the latest version of
4894 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004895
Wolfgang Denk218ca722008-03-26 10:40:12 +01004896 The current directory when running this command shall be the parent
4897 directory of the U-Boot source tree (i. e. please make sure that
4898 your patch includes sufficient directory information for the
4899 affected files).
4900
4901 We prefer patches as plain text. MIME attachments are discouraged,
4902 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004903
4904* If one logical set of modifications affects or creates several
4905 files, all these changes shall be submitted in a SINGLE patch file.
4906
4907* Changesets that contain different, unrelated modifications shall be
4908 submitted as SEPARATE patches, one patch per changeset.
4909
4910
4911Notes:
4912
4913* Before sending the patch, run the MAKEALL script on your patched
4914 source tree and make sure that no errors or warnings are reported
4915 for any of the boards.
4916
4917* Keep your modifications to the necessary minimum: A patch
4918 containing several unrelated changes or arbitrary reformats will be
4919 returned with a request to re-formatting / split it.
4920
4921* If you modify existing code, make sure that your new code does not
4922 add to the memory footprint of the code ;-) Small is beautiful!
4923 When adding new features, these should compile conditionally only
4924 (using #ifdef), and the resulting code with the new feature
4925 disabled must not need more memory than the old code without your
4926 modification.
wdenk90dc6702005-05-03 14:12:25 +00004927
Wolfgang Denk06682362008-12-30 22:56:11 +01004928* Remember that there is a size limit of 100 kB per message on the
4929 u-boot mailing list. Bigger patches will be moderated. If they are
4930 reasonable and not too big, they will be acknowledged. But patches
4931 bigger than the size limit should be avoided.